schedules

Create Schedule

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

A container for slots of time 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*stringScheduleThis is a Schedule resource
identifierarray(Identifier)External Ids for this item.
activebooleanWhether this schedule record is in active use, or should not be used (such as was entered in error).
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*array(Reference)The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
planningHorizonPeriodThe period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
commentstringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

Patch Schedule

patch
/organizations/{organizationId}/fhir/3/Schedule/{resourceId}

A container for slots of time 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*stringScheduleThis is a Schedule resource
identifierarray(Identifier)External Ids for this item.
activebooleanWhether this schedule record is in active use, or should not be used (such as was entered in error).
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*array(Reference)The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
planningHorizonPeriodThe period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
commentstringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

Read Schedule

get
/organizations/{organizationId}/fhir/3/Schedule/{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 Schedule

get
/organizations/{organizationId}/fhir/3/Schedule/{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 Schedule

get
/organizations/{organizationId}/fhir/3/Schedule/{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 Schedule

delete
/organizations/{organizationId}/fhir/3/Schedule/{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 Schedule

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

Request

Headers

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

Query params

_idstring
_languagestring
activestring
actorstring
datestring
identifierstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Schedule

get
/organizations/{organizationId}/fhir/3/Schedule/_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 Schedule

post
/organizations/{organizationId}/fhir/3/Schedule/_search

A container for slots of time 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
activestring
actorstring
datestring
identifierstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringScheduleThis is a Schedule resource
identifierarray(Identifier)External Ids for this item.
activebooleanWhether this schedule record is in active use, or should not be used (such as was entered in error).
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*array(Reference)The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
planningHorizonPeriodThe period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
commentstringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

Update Schedule

put
/organizations/{organizationId}/fhir/3/Schedule/{resourceId}

A container for slots of time 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*stringScheduleThis is a Schedule resource
identifierarray(Identifier)External Ids for this item.
activebooleanWhether this schedule record is in active use, or should not be used (such as was entered in error).
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*array(Reference)The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
planningHorizonPeriodThe period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
commentstringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response