Slot
Overview
The Slot resource returns time slots from a schedule which are available for booking an appointment. Slots contain no information about actual appointments; only availability and type.
When integrating your application with a client’s production environment you will work with the client to determine the Practitioner and Location ids (Millennium personnel and location codes, respectively) which they want to make available to third-party applications for enabling scheduling functionality.
We understand this is a bit cumbersome, but we are always evaluating community feedback and look to improve the API in the future.
The following fields are returned if valued:
Terminology Bindings
Slot.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 /Slot?:parameters
Implementation Notes
- Valid ids for the
schedule.actor
and-location
search parameters will be determined by the client and provided when integrating your application with the client’s production environment. See overview for details.
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
Yes or slot-type
|
token |
The logical resource id associated with the resource. |
slot-type |
Yes or _id
|
token |
A single or comma separated list of appointment types that can be booked into the slot. Example: http://snomed.info/sct|394581000
|
schedule.actor |
No | reference |
A single or comma separated list of Practitioner references. Example: Practitioner/1234
|
-location |
No | reference |
A single or comma separated list of Location references. Example: 5678
|
start |
Yes when using slot-type
|
date |
The Slot date-time. Example: 2016
|
_count |
No | number |
The maximum number of results to be returned per page. |
_include |
No | string |
Other resource entries to be returned as part of the bundle. Example: _include=Slot:schedule
|
Notes:
-
The
slot-type
,schedule.actor
, and-location
parameters may be included only once. For example,-location=123,456
is supported but-location=123&-location=456
is not. -
slot-type
is a required search parameter when_id
is not provided. -
When
slot-type
is provided,start
must be provided. For example,start=2018&slot-type=http://snomed.info/sct|394581000,http://snomed.info/sct|394602003
- The
slot-type
parameter may contain standard codes or proprietary codes. If multipleslot-type
parameters are used they must be either all standard codes or all proprietary codes.- When using standard codes, choose codes bound to Slot.type as noted in the Terminology Bindings table above.
- When using proprietary codes, the system should be
https://fhir.cerner.com/<your EHR source id>/codeSet/<code set>
(where code set is a Millennium code set) and the code should be a Millennium code value. Example:https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|24477854
- The
start
parameter may be provided:- Once without a prefix or time component to imply a date range. (e.g.
&start=2016
,&start=2016-07
,&start=2016-07-04
) - Twice with the prefixes
ge
andlt
to indicate a specific range. The date and prefix pairs must define an upper and lower bound. (e.g.&start=ge2014&start=lt2016
,&start=ge2016-07&start=lt2017-07
)
- Once without a prefix or time component to imply a date range. (e.g.
-
The retrieved slots are sorted first by
start
date-time ascending (earliest first), followed byslot-type
andScheduling Location
display. -
The search operation will only return free slots which are available to be booked. However, booked slots may still be retrieved when using the
_id
parameter. -
The
_include
parameter may be provided once with the valueSlot:schedule
. Example:_include=Slot:schedule
-
The
_include
parameter may be provided with the_id
parameter. Example:_id=21265426-633867-3121665-0&_include=Slot:schedule
- When
_include
is provided in a request to the closed endpoint, the OAuth2 token must include either theuser/Schedule.read
or thepatient/Schedule.read
scope in addition to a Slot scope.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?schedule.actor=Practitioner/593923&start=2019&slot-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|24477854
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "a8e48b88-1c7f-4dc3-bb3a-fa2ebd4b5b75",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?slot-type=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F14249%7C24477854&schedule.actor=Practitioner%2F593923&start=2020&_count=50"
},
{
"relation": "next",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?-pageContext=25cc775c-1268-4953-b5a5-61fb77512b39&-pageDirection=NEXT"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/24477854-21304876-62852027-0",
"resource": {
"resourceType": "Slot",
"id": "24477854-21304876-62852027-0",
"meta": {
"versionId": "0",
"lastUpdated": "2018-12-03T08:10:42.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Slot</b></p><p><b>Type</b>: Established Patient</p><p><b>Start</b>: Jan 1, 2020 2:00 P.M. UTC</p><p><b>End</b>: Jan 1, 2020 2:15 P.M. UTC</p><p><b>ScheduleReference</b>: 24477854-21304876-62852027-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
}
],
"text": "Established Patient"
},
"schedule": {
"reference": "Schedule/24477854-21304876-62852027-0"
},
"freeBusyType": "free",
"start": "2020-01-01T14:00:00.000Z",
"end": "2020-01-01T14:15:00.000Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/24477854-21304876-62852027-15",
"resource": {
"resourceType": "Slot",
"id": "24477854-21304876-62852027-15",
"meta": {
"versionId": "0",
"lastUpdated": "2018-12-03T08:10:42.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Slot</b></p><p><b>Type</b>: Established Patient</p><p><b>Start</b>: Jan 1, 2020 2:15 P.M. UTC</p><p><b>End</b>: Jan 1, 2020 2:30 P.M. UTC</p><p><b>ScheduleReference</b>: 24477854-21304876-62852027-15</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
}
],
"text": "Established Patient"
},
"schedule": {
"reference": "Schedule/24477854-21304876-62852027-15"
},
"freeBusyType": "free",
"start": "2020-01-01T14:15:00.000Z",
"end": "2020-01-01T14:30:00.000Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/24477854-21304876-62852027-30",
"resource": {
"resourceType": "Slot",
"id": "24477854-21304876-62852027-30",
"meta": {
"versionId": "0",
"lastUpdated": "2018-12-03T08:10:42.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Slot</b></p><p><b>Type</b>: Established Patient</p><p><b>Start</b>: Jan 1, 2020 2:30 P.M. UTC</p><p><b>End</b>: Jan 1, 2020 2:45 P.M. UTC</p><p><b>ScheduleReference</b>: 24477854-21304876-62852027-30</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
}
],
"text": "Established Patient"
},
"schedule": {
"reference": "Schedule/24477854-21304876-62852027-30"
},
"freeBusyType": "free",
"start": "2020-01-01T14:30:00.000Z",
"end": "2020-01-01T14:45:00.000Z"
},
"search": {
"mode": "match"
}
}
]
}
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.
Example with Include
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?schedule.actor=Practitioner/593923&start=2019&slot-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|24477854&_include=Slot:schedule
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "e2b19242-1e3a-40e7-9d62-0ae26f9810b3",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?slot-type=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F14249%7C24477854&schedule.actor=Practitioner%2F593923&start=2020&_include=Slot%3Aschedule&_count=50"
},
{
"relation": "next",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?_include=Slot%3Aschedule&-pageContext=b82b118b-d7e3-4a41-84d5-8d0d39faa806&-pageDirection=NEXT"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/24477854-21304876-62852027-0",
"resource": {
"resourceType": "Slot",
"id": "24477854-21304876-62852027-0",
"meta": {
"versionId": "0",
"lastUpdated": "2018-12-03T08:10:42.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Slot</b></p><p><b>Type</b>: Established Patient</p><p><b>Start</b>: Jan 1, 2020 2:00 P.M. UTC</p><p><b>End</b>: Jan 1, 2020 2:15 P.M. UTC</p><p><b>ScheduleReference</b>: 24477854-21304876-62852027-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
}
],
"text": "Established Patient"
},
"schedule": {
"reference": "Schedule/24477854-21304876-62852027-0"
},
"freeBusyType": "free",
"start": "2020-01-01T14:00:00.000Z",
"end": "2020-01-01T14:15:00.000Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/24477854-21304876-62852027-15",
"resource": {
"resourceType": "Slot",
"id": "24477854-21304876-62852027-15",
"meta": {
"versionId": "0",
"lastUpdated": "2018-12-03T08:10:42.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Slot</b></p><p><b>Type</b>: Established Patient</p><p><b>Start</b>: Jan 1, 2020 2:15 P.M. UTC</p><p><b>End</b>: Jan 1, 2020 2:30 P.M. UTC</p><p><b>ScheduleReference</b>: 24477854-21304876-62852027-15</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
}
],
"text": "Established Patient"
},
"schedule": {
"reference": "Schedule/24477854-21304876-62852027-15"
},
"freeBusyType": "free",
"start": "2020-01-01T14:15:00.000Z",
"end": "2020-01-01T14:30:00.000Z"
},
"search": {
"mode": "match"
}
},
{
"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"
}
},
"search": {
"mode": "include"
}
},
{
"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"
}
},
"search": {
"mode": "include"
}
}
]
}
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 /Slot/: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/Slot/21265426-633867-3121665-0
Response
Status: 200 OK
{
"resourceType": "Slot",
"id": "24477854-21304876-62852027-0",
"meta": {
"versionId": "0",
"lastUpdated": "2018-12-03T08:10:42.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Slot</b></p><p><b>Type</b>: Established Patient</p><p><b>Start</b>: Jan 1, 2020 2:00 P.M. UTC</p><p><b>End</b>: Jan 1, 2020 2:15 P.M. UTC</p><p><b>ScheduleReference</b>: 24477854-21304876-62852027-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
"valueReference": {
"reference": "Location/21304876"
}
}
],
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
}
],
"text": "Established Patient"
},
"schedule": {
"reference": "Schedule/24477854-21304876-62852027-0"
},
"freeBusyType": "free",
"start": "2020-01-01T14:00:00.000Z",
"end": "2020-01-01T14:15:00.000Z"
}
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.