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.
Appointment types for use in FHIR scheduling workflows must be resource list based. The ability to retrieve slots and book appointments that are order role based are not supported in FHIR workflows.
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.serviceType |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/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 Slots that meet supplied query parameters:
GET /Slot?:parameters
Implementation Notes
- Valid ids for the
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 service-type
|
token |
The logical resource id associated with the resource. |
service-type |
Yes or _id
|
token |
A single or comma separated list of appointment types that can be booked into the slot. Example: service-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|4047611
|
schedule.actor |
No | reference |
A single or comma separated list of Practitioner references. Example: schedule.actor=Practitioner/1234
|
-location |
No | reference |
A single or comma separated list of Location references. Example: -location='5678'
|
start |
See Notes | date |
The Slot date-time. Example: start=ge2016-08-24T12:00:00.000Z&start=lt2017-01-24T12:00:00.000Z
|
_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
service-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. -
service-type
is a required search parameter when_id
is not provided. - The
service-type
parameter may contain standard codes or proprietary codes. If multipleservice-type
parameters are used they must be either all standard codes or all proprietary codes.- When using standard codes, choose codes bound to Slot.serviceType 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 must be provided when
service-type
,-location
, orschedule.actor
is provided. - When the
start
parameter is provided:- both the prefixes
ge
andlt
must be used to indicate a specific range.The date and prefix pairs must define an upper and lower bound. (e.g. &start=ge2020-04-08T18:13:55Z&start=lt2020-06-08T18:13:55Z)
- both the prefixes
-
The retrieved slots are sorted first by
start
date-time ascending (earliest first), followed byservice-type
andScheduling Location
. -
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 one ofuser/Schedule.read
,patient/Schedule.read
, orsystem/Schedule.read
scopes in addition to the Slot scope.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|4047611&start=ge2016-01-23T22:05:47Z&start=lt2020-06-08T18:13:55Z&-location=Location/32216049
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "bf750997-bfdd-4ac3-bcc2-34776d05b46e",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F14249%7C4047611&-location=32216049&start=ge2016-01-23T22%3A05%3A47Z&start=lt2020-06-08T18%3A13%3A55Z&_count=50"
},
{
"relation": "next",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?-pageContext=5cafd537-be28-45ad-80ed-c5bc2a266678&-pageDirection=NEXT"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0",
"resource": {
"resourceType": "Slot",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423957v2380283",
"lastUpdated": "2020-05-08T18:13:55Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Surgery Rapid</p><p><b>Start</b>: Jan 23, 2017 6:00 A.M. UTC</p><p><b>End</b>: Jan 23, 2017 7:00 A.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/32216049"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-0"
},
"status": "free",
"start": "2017-01-23T06:00:00Z",
"end": "2017-01-23T07:00:00Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-5",
"resource": {
"resourceType": "Slot",
"id": "4047611-32216049-61518614-5",
"meta": {
"versionId": "3423v2289979283",
"lastUpdated": "2020-07-22T20:02:03Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Surgery Rapid</p><p><b>Start</b>: May 8, 2020 2:00 P.M. UTC</p><p><b>End</b>: May 8, 2020 3:00 P.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-5</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/39997807"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-5"
},
"status": "free",
"start": "2020-07-22T22:00:00Z",
"end": "2020-07-22T23:00:00Z"
},
"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.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|4047611&start=ge2016-01-23T22:05:47Z&start=lt2020-06-08T18:13:55Z&-location=Location/32216049
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "bf750997-bfdd-4ac3-bcc2-34776d05b46e",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F14249%7C4047611&-location=32216049&start=ge2016-01-23T22%3A05%3A47Z&start=lt2020-06-08T18%3A13%3A55Z&_count=50"
},
{
"relation": "next",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?-pageContext=5cafd537-be28-45ad-80ed-c5bc2a266678&-pageDirection=NEXT"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0",
"resource": {
"resourceType": "Slot",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423957v2380283",
"lastUpdated": "2020-05-08T18:13:55Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Patient Friendly Display - Surgery Rapid</p><p><b>Start</b>: Jan 23, 2017 6:00 A.M. UTC</p><p><b>End</b>: Jan 23, 2017 7:00 A.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/32216049"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Patient Friendly Display - Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Patient Friendly Display - Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-0"
},
"status": "free",
"start": "2017-01-23T06:00:00Z",
"end": "2017-01-23T07:00:00Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-5",
"resource": {
"resourceType": "Slot",
"id": "4047611-32216049-61518614-5",
"meta": {
"versionId": "3423v2289979283",
"lastUpdated": "2020-07-22T20:02:03Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Patient Friendly Display - Surgery Rapid</p><p><b>Start</b>: May 8, 2020 2:00 P.M. UTC</p><p><b>End</b>: May 8, 2020 3:00 P.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-5</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/39997807"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Patient Friendly Display - Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Patient Friendly Display - Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-5"
},
"status": "free",
"start": "2020-07-22T22:00:00Z",
"end": "2020-07-22T23:00:00Z"
},
"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/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|4047611&start=ge2016-01-23T22:05:47Z&start=lt2020-06-08T18:13:55Z&_include=Slot:schedule&_count=5
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "f8dd806e-62bb-4657-8912-9c2705864d40",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F14249%7C4047611&start=ge2016-01-23T22%3A05%3A47Z&start=lt2020-06-08T18%3A13%3A55Z&_include=Slot%3Aschedule&_count=50"
},
{
"relation": "next",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?_include=Slot%3Aschedule&-pageContext=2d46d307-9a4c-4dc7-a1c2-88f1282d5aec&-pageDirection=NEXT"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0",
"resource": {
"resourceType": "Slot",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423957v2380283",
"lastUpdated": "2020-05-08T18:13:55Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Surgery Rapid</p><p><b>Start</b>: Jan 23, 2017 6:00 A.M. UTC</p><p><b>End</b>: Jan 23, 2017 7:00 A.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/32216049"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-0"
},
"status": "free",
"start": "2017-01-23T06:00:00Z",
"end": "2017-01-23T07:00:00Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule/4047611-32216049-61518614-0",
"resource": {
"resourceType": "Schedule",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423v4vv168v283",
"lastUpdated": "2020-08-11T15:48:54Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Surgery Rapid</p><p><b>Start</b>: May 8, 2020 2:00 P.M. UTC</p><p><b>End</b>: May 8, 2020 3:00 P.M. UTC</p><p><b>Status</b>: Free</p></div>"
},
"active": true,
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Surgery Rapid"
}
],
"actor": [
{
"display": "OR Add-On 02"
}
]
},
"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.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249|4047611&start=ge2016-01-23T22:05:47Z&start=lt2020-06-08T18:13:55Z&_include=Slot:schedule&_count=5
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "f8dd806e-62bb-4657-8912-9c2705864d40",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?service-type=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F14249%7C4047611&start=ge2016-01-23T22%3A05%3A47Z&start=lt2020-06-08T18%3A13%3A55Z&_include=Slot%3Aschedule&_count=50"
},
{
"relation": "next",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot?_include=Slot%3Aschedule&-pageContext=2d46d307-9a4c-4dc7-a1c2-88f1282d5aec&-pageDirection=NEXT"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0",
"resource": {
"resourceType": "Slot",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423957v2380283",
"lastUpdated": "2020-05-08T18:13:55Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Patient Friendly Display - Surgery Rapid</p><p><b>Start</b>: Jan 23, 2017 6:00 A.M. UTC</p><p><b>End</b>: Jan 23, 2017 7:00 A.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/32216049"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Patient Friendly Display - Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Patient Friendly Display - Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-0"
},
"status": "free",
"start": "2017-01-23T06:00:00Z",
"end": "2017-01-23T07:00:00Z"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Schedule/4047611-32216049-61518614-0",
"resource": {
"resourceType": "Schedule",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423v4vv168v283",
"lastUpdated": "2020-08-11T15:48:54Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Patient Friendly Display - Surgery Rapid</p><p><b>Start</b>: May 8, 2020 2:00 P.M. UTC</p><p><b>End</b>: May 8, 2020 3:00 P.M. UTC</p><p><b>Status</b>: Free</p></div>"
},
"active": true,
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Patient Friendly Display - Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Patient Friendly Display - Surgery Rapid"
}
],
"actor": [
{
"display": "OR Add-On 02"
}
]
},
"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 Slot by its id:
GET /Slot/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0
Response
Status: 200 OK
{
"resourceType": "Slot",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423957v2380283",
"lastUpdated": "2020-05-08T18:13:55Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Surgery Rapid</p><p><b>Start</b>: Jan 23, 2017 6:00 A.M. UTC</p><p><b>End</b>: Jan 23, 2017 7:00 A.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/32216049"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident &amp; emergency (qualifier value)",
"userSelected": false
}
],
"text": "Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-0"
},
"status": "free",
"start": "2017-01-23T06:00:00Z",
"end": "2017-01-23T07:00:00Z"
}
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.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0
Response
Status: 200 OK
{
"resourceType": "Slot",
"id": "4047611-32216049-61518614-0",
"meta": {
"versionId": "3423957v2380283",
"lastUpdated": "2020-05-08T18:13:55Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Slot</b></p><p><b>Service Type</b>: Patient Friendly Display - Surgery Rapid</p><p><b>Start</b>: Jan 23, 2017 6:00 A.M. UTC</p><p><b>End</b>: Jan 23, 2017 7:00 A.M. UTC</p><p><b>Schedule Reference</b>: 4047611-32216049-61518614-0</p><p><b>Status</b>: Free</p></div>"
},
"extension": [
{
"valueReference": {
"reference": "Location/32216049"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/scheduling-location"
}
],
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Patient Friendly Display - Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident &amp; emergency (qualifier value)",
"userSelected": false
}
],
"text": "Patient Friendly Display - Surgery Rapid"
}
],
"schedule": {
"reference": "Schedule/4047611-32216049-61518614-0"
},
"status": "free",
"start": "2017-01-23T06:00:00Z",
"end": "2017-01-23T07:00:00Z"
}
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.
Patch
Patch an existing Slot.
PATCH /Slot/:id
Implementation Notes
- This implementation follows the JSON Patch spec.
- Only operations on the paths listed below are supported.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/json-patch+json
If-Match: W/"<Current version of the Slot resource>"
Patch Operations
Path | Operation | Value Type | |
---|---|---|---|
/status
|
replace |
code |
|
|
Example
Request
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0
Body
[
{
"op": "replace",
"path": "/status",
"value": "busy-tentative"
}
]
Response
Status: 200 OK
Cache-Control: no-cache Content-Length: 20 Content-Type: text/html Date: Tue, 06 Apr 2021 15:36:47 GMT Etag: W/"410v795030969834" Last-Modified: Tue, 06 Apr 2021 15:36:47 GMT Vary: Origin X-Request-Id: 6801a2c5-bf2d-414b-9f6a-7bcf39cc69d9
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.
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Errors
The common errors and OperationOutcomes may be returned.