Schedule
Overview
The Schedule resource provides a time period (planning horizon) where time slots are defined for booking an appointment. Consumers can query by schedule id(s). The schedule ids can be obtained by querying for slots, which contain the references to associated schedules. A schedule belongs to only one service or resource (actor) and does not contain any information about actual appointments.
The following fields are returned if valued:
Terminology Bindings
Schedule.type |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/dstu2/StructureDefinition/{id}
ID | Value[x] Type | Description |
---|---|---|
scheduling-location |
Reference |
Reference to the location corresponding to this schedule, where the appointment can be booked. |
Search
Search for Schedules that meet supplied query parameters:
GET /Schedule?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
Y | token |
The logical resource id associated with the resource. |
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule?_id=24477854-21304876-62852027-0%2C24477854-21304876-62852027-15
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "b040a360-33e1-472f-8bd8-3f2ef372ec94",
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule?_id=24477854-21304876-62852027-0%2C24477854-21304876-62852027-15"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule/24477854-21304876-62852027-15",
"resource": {
"resourceType": "Schedule",
"id": "24477854-21304876-62852027-15",
"text": {
"status": "extensions",
"div": "<div><p><b>Schedule</b></p><p><b>Type</b>: Established Patient</p><p><b>Practitioner</b>: Cerner Test, Physician - Primary Care Cerner</p><p><b>Location</b>: MX Clinic 1</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876",
"display": "MX Clinic 1"
}
}
],
"type": [
{
"text": "Established Patient"
}
],
"actor": {
"reference": "Practitioner/593923",
"display": "Cerner Test, Physician - Primary Care Cerner"
}
}
},
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule/24477854-21304876-62852027-0",
"resource": {
"resourceType": "Schedule",
"id": "24477854-21304876-62852027-0",
"text": {
"status": "extensions",
"div": "<div><p><b>Schedule</b></p><p><b>Type</b>: Established Patient</p><p><b>Practitioner</b>: Cerner Test, Physician - Primary Care Cerner</p><p><b>Location</b>: MX Clinic 1</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876",
"display": "MX Clinic 1"
}
}
],
"type": [
{
"text": "Established Patient"
}
],
"actor": {
"reference": "Practitioner/593923",
"display": "Cerner Test, Physician - Primary Care Cerner"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual Schedule by its id:
GET /Schedule/:id
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule/24477854-21304876-62852027-0
Response
Status: 200 OK
{
"resourceType": "Schedule",
"id": "24477854-21304876-62852027-0",
"text": {
"status": "extensions",
"div": "<div><p><b>Schedule</b></p><p><b>Type</b>: Established Patient</p><p><b>Practitioner</b>: Cerner Test, Physician - Primary Care Cerner</p><p><b>Location</b>: MX Clinic 1</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876",
"display": "MX Clinic 1"
}
}
],
"type": [
{
"text": "Established Patient"
}
],
"actor": {
"reference": "Practitioner/593923",
"display": "Cerner Test, Physician - Primary Care Cerner"
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.