slots

Create Slot

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

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

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringSlotThis is a Slot resource
identifierarray(Identifier)External Ids for this item.
serviceCategoryCodeableConceptA broad categorisation 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.
statusstringbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startstringDate/Time that the slot is to begin.
endstringDate/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/3/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*stringSlotThis is a Slot resource
identifierarray(Identifier)External Ids for this item.
serviceCategoryCodeableConceptA broad categorisation 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.
statusstringbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startstringDate/Time that the slot is to begin.
endstringDate/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/3/Slot/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Slot

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/Slot/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Slot

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Slot

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

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
schedulestring
slot-typestring
startstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Slot

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/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
identifierstring
schedulestring
slot-typestring
startstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSlotThis is a Slot resource
identifierarray(Identifier)External Ids for this item.
serviceCategoryCodeableConceptA broad categorisation 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.
statusstringbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startstringDate/Time that the slot is to begin.
endstringDate/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/3/Slot/{resourceId}

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSlotThis is a Slot resource
identifierarray(Identifier)External Ids for this item.
serviceCategoryCodeableConceptA broad categorisation 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.
statusstringbusy|free|busy-unavailable|busy-tentative|entered-in-errorbusy | free | busy-unavailable | busy-tentative | entered-in-error.
startstringDate/Time that the slot is to begin.
endstringDate/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