slots

Create Slot

post
/organizations/{organizationId}/fhir/4/Slot

A slot of time on a schedule that may be available for booking appointments.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Slot resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)External Ids for this item.
serviceCategoryarray(CodeableConcept)A broad categorization of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that may be booked in the slot (not service type).
schedule*ReferenceThe schedule resource that this slot defines an interval of status information.
statusbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startinstantDate/Time that the slot is to begin.
endinstantDate/Time that the slot is to conclude.
overbookedbooleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
commentstringComments on the slot to describe any extended information. Such as custom constraints on the slot.

Response

Patch Slot

patch
/organizations/{organizationId}/fhir/4/Slot/{resourceId}

A slot of time on a schedule that may be available for booking appointments.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Slot resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)External Ids for this item.
serviceCategoryarray(CodeableConcept)A broad categorization of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that may be booked in the slot (not service type).
schedule*ReferenceThe schedule resource that this slot defines an interval of status information.
statusbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startinstantDate/Time that the slot is to begin.
endinstantDate/Time that the slot is to conclude.
overbookedbooleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
commentstringComments on the slot to describe any extended information. Such as custom constraints on the slot.

Response

Read Slot

get
/organizations/{organizationId}/fhir/4/Slot/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Slot

get
/organizations/{organizationId}/fhir/4/Slot/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Slot

get
/organizations/{organizationId}/fhir/4/Slot/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Slot

delete
/organizations/{organizationId}/fhir/4/Slot/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Slot

get
/organizations/{organizationId}/fhir/4/Slot

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
appointment-typestring
identifierstring
schedulestring
service-categorystring
slot-typestring
specialtystring
startstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Slot

get
/organizations/{organizationId}/fhir/4/Slot/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Slot

post
/organizations/{organizationId}/fhir/4/Slot/_search

A slot of time on a schedule that may be available for booking appointments.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
appointment-typestring
identifierstring
schedulestring
service-categorystring
slot-typestring
specialtystring
startstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Slot resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)External Ids for this item.
serviceCategoryarray(CodeableConcept)A broad categorization of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that may be booked in the slot (not service type).
schedule*ReferenceThe schedule resource that this slot defines an interval of status information.
statusbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startinstantDate/Time that the slot is to begin.
endinstantDate/Time that the slot is to conclude.
overbookedbooleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
commentstringComments on the slot to describe any extended information. Such as custom constraints on the slot.

Response

Update Slot

put
/organizations/{organizationId}/fhir/4/Slot/{resourceId}

A slot of time on a schedule that may be available for booking appointments.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Slot resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)External Ids for this item.
serviceCategoryarray(CodeableConcept)A broad categorization of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that may be booked in the slot (not service type).
schedule*ReferenceThe schedule resource that this slot defines an interval of status information.
statusbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startinstantDate/Time that the slot is to begin.
endinstantDate/Time that the slot is to conclude.
overbookedbooleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
commentstringComments on the slot to describe any extended information. Such as custom constraints on the slot.

Response