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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Schedule | This is a Schedule resource |
| identifier | array(Identifier) | External Ids for this item. | |
| active | boolean | Whether this schedule record is in active use, or should not be used (such as was entered in error). | |
| serviceCategory | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment. | |
| serviceType | array(CodeableConcept) | The specific service that is to be performed during this appointment. | |
| specialty | array(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. | |
| planningHorizon | Period | The 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. | |
| comment | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. |
Response
keyboard_arrow_down
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* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Schedule | This is a Schedule resource |
| identifier | array(Identifier) | External Ids for this item. | |
| active | boolean | Whether this schedule record is in active use, or should not be used (such as was entered in error). | |
| serviceCategory | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment. | |
| serviceType | array(CodeableConcept) | The specific service that is to be performed during this appointment. | |
| specialty | array(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. | |
| planningHorizon | Period | The 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. | |
| comment | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. |
Response
keyboard_arrow_down
Read Schedule
get
/organizations/{organizationId}/fhir/3/Schedule/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Schedule
get
/organizations/{organizationId}/fhir/3/Schedule/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Schedule
get
/organizations/{organizationId}/fhir/3/Schedule/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Schedule
delete
/organizations/{organizationId}/fhir/3/Schedule/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Schedule
get
/organizations/{organizationId}/fhir/3/Schedule
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| actor | string | ||
| date | string | ||
| identifier | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Schedule
get
/organizations/{organizationId}/fhir/3/Schedule/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
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* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| actor | string | ||
| date | string | ||
| identifier | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Schedule | This is a Schedule resource |
| identifier | array(Identifier) | External Ids for this item. | |
| active | boolean | Whether this schedule record is in active use, or should not be used (such as was entered in error). | |
| serviceCategory | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment. | |
| serviceType | array(CodeableConcept) | The specific service that is to be performed during this appointment. | |
| specialty | array(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. | |
| planningHorizon | Period | The 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. | |
| comment | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. |
Response
keyboard_arrow_down
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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Schedule | This is a Schedule resource |
| identifier | array(Identifier) | External Ids for this item. | |
| active | boolean | Whether this schedule record is in active use, or should not be used (such as was entered in error). | |
| serviceCategory | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment. | |
| serviceType | array(CodeableConcept) | The specific service that is to be performed during this appointment. | |
| specialty | array(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. | |
| planningHorizon | Period | The 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. | |
| comment | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. |
Response
keyboard_arrow_down