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
  • Description
    • Additional details about where the content was created (e.g. clinical specialty).
  • Details: Practice Setting Code Value Set
    System: http://snomed.info/sct

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 for Schedules that meet supplied query parameters:

GET /Slot?:parameters

Implementation Notes

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 The type of appointments that can be booked into this slot. Example: http://snomed.info/sct|394581000
schedule.actor Yes (or -location) when using slot-type reference A single or comma separated list of Practitioner references. Example: Practitioner/2578010
-location Yes (or schedule.actor) when using slot-type reference A single or comma separated list of Location references. Example: 633867
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.

Notes:

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot?schedule.actor=Practitioner/2578010&start=2016&slot-type=http://snomed.info/sct|394581000&_count=5

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "e5dd4ff4-116b-4bf8-90d1-c867bb21b0fb",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot?slot-type=http%3A%2F%2Fsnomed.info%2Fsct%7C394581000&schedule.actor=Practitioner%2F2578010&start=2016&_count=5"
    },
    {
      "relation": "next",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot?-pageContext=26d86acd-529c-4d12-8f6f-3a10209fcb2a&-pageDirection=NEXT"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot/21265426-633867-3121665-0",
      "resource": {
        "resourceType": "Slot",
        "id": "21265426-633867-3121665-0",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2015-06-10T10:40:33.000-05:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Slot</b></p><p><b>Type</b>: Same Day</p><p><b>Start</b>: 2016-01-01T08:00:00.000-06:00</p><p><b>End</b>: 2016-01-01T09:00:00.000-06:00</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867"
            }
          }
        ],
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394581000",
              "display": "Community medicine"
            }
          ],
          "text": "Same Day"
        },
        "schedule": {
          "reference": "Schedule/21265426-633867-3121665-0"
        },
        "freeBusyType": "free",
        "start": "2016-01-01T08:00:00.000-06:00",
        "end": "2016-01-01T09:00:00.000-06:00"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot/21265426-633867-3121665-5",
      "resource": {
        "resourceType": "Slot",
        "id": "21265426-633867-3121665-5",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2015-06-10T10:40:33.000-05:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Slot</b></p><p><b>Type</b>: Same Day</p><p><b>Start</b>: 2016-01-01T08:05:00.000-06:00</p><p><b>End</b>: 2016-01-01T09:05:00.000-06:00</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867"
            }
          }
        ],
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394581000",
              "display": "Community medicine"
            }
          ],
          "text": "Same Day"
        },
        "schedule": {
          "reference": "Schedule/21265426-633867-3121665-5"
        },
        "freeBusyType": "free",
        "start": "2016-01-01T08:05:00.000-06:00",
        "end": "2016-01-01T09:05:00.000-06:00"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot/21265426-633867-3121665-10",
      "resource": {
        "resourceType": "Slot",
        "id": "21265426-633867-3121665-10",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2015-06-10T10:40:33.000-05:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Slot</b></p><p><b>Type</b>: Same Day</p><p><b>Start</b>: 2016-01-01T08:10:00.000-06:00</p><p><b>End</b>: 2016-01-01T09:10:00.000-06:00</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867"
            }
          }
        ],
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394581000",
              "display": "Community medicine"
            }
          ],
          "text": "Same Day"
        },
        "schedule": {
          "reference": "Schedule/21265426-633867-3121665-10"
        },
        "freeBusyType": "free",
        "start": "2016-01-01T08:10:00.000-06:00",
        "end": "2016-01-01T09:10:00.000-06:00"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot/21265426-633867-3121665-15",
      "resource": {
        "resourceType": "Slot",
        "id": "21265426-633867-3121665-15",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2015-06-10T10:40:33.000-05:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Slot</b></p><p><b>Type</b>: Same Day</p><p><b>Start</b>: 2016-01-01T08:15:00.000-06:00</p><p><b>End</b>: 2016-01-01T09:15:00.000-06:00</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867"
            }
          }
        ],
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394581000",
              "display": "Community medicine"
            }
          ],
          "text": "Same Day"
        },
        "schedule": {
          "reference": "Schedule/21265426-633867-3121665-15"
        },
        "freeBusyType": "free",
        "start": "2016-01-01T08:15:00.000-06:00",
        "end": "2016-01-01T09:15:00.000-06:00"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot/21265426-633867-3121665-20",
      "resource": {
        "resourceType": "Slot",
        "id": "21265426-633867-3121665-20",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2015-06-10T10:40:33.000-05:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Slot</b></p><p><b>Type</b>: Same Day</p><p><b>Start</b>: 2016-01-01T08:20:00.000-06:00</p><p><b>End</b>: 2016-01-01T09:20:00.000-06:00</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867"
            }
          }
        ],
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394581000",
              "display": "Community medicine"
            }
          ],
          "text": "Same Day"
        },
        "schedule": {
          "reference": "Schedule/21265426-633867-3121665-20"
        },
        "freeBusyType": "free",
        "start": "2016-01-01T08:20:00.000-06:00",
        "end": "2016-01-01T09:20:00.000-06:00"
      }
    }
  ]
}

Errors

The common errors 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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Slot/21265426-633867-3121665-0

Response

Status: 200 OK
{
  "resourceType": "Slot",
  "id": "21265426-633867-3121665-0",
  "meta": {
    "versionId": "0",
    "lastUpdated": "2015-06-10T10:40:33.000-05:00"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Slot</b></p><p><b>Type</b>: Same Day</p><p><b>Start</b>: 2016-01-01T08:00:00.000-06:00</p><p><b>End</b>: 2016-01-01T09:00:00.000-06:00</p></div>"
  },
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
      "valueReference": {
        "reference": "Location/633867"
      }
    }
  ],
  "type": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "394581000",
        "display": "Community medicine"
      }
    ],
    "text": "Same Day"
  },
  "schedule": {
    "reference": "Schedule/21265426-633867-3121665-0"
  },
  "freeBusyType": "busy",
  "start": "2016-01-01T08:00:00.000-06:00",
  "end": "2016-01-01T09:00:00.000-06:00"
}

Errors

The common errors may be returned.