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
  • 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 /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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Schedule?_id=21265426-633867-3121665-0,21265426-633867-3121665-15

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "9ff44def-1f82-4184-8639-5e6b3ab03ed7",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Schedule?_id=21265426-633867-3121665-0%2C21265426-633867-3121665-15"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Schedule/21265426-633867-3121665-15",
      "resource": {
        "resourceType": "Schedule",
        "id": "21265426-633867-3121665-15",
        "text": {
          "status": "generated",
          "div": "<div><p><b>Schedule</b></p><p><b>Type</b>: Same Day</p><p><b>Practitioner</b>: Song, River</p><p><b>Location</b>: Baseline West</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867",
              "display": "Baseline West"
            }
          }
        ],
        "type": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "394581000",
                "display": "Community medicine"
              }
            ],
            "text": "Same Day"
          }
        ],
        "actor": {
          "reference": "Practitioner/2578010",
          "display": "Song, River"
        }
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Schedule/21265426-633867-3121665-0",
      "resource": {
        "resourceType": "Schedule",
        "id": "21265426-633867-3121665-0",
        "text": {
          "status": "generated",
          "div": "<div><p><b>Schedule</b></p><p><b>Type</b>: Same Day</p><p><b>Practitioner</b>: Song, River</p><p><b>Location</b>: Baseline West</p></div>"
        },
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference": {
              "reference": "Location/633867",
              "display": "Baseline West"
            }
          }
        ],
        "type": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "394581000",
                "display": "Community medicine"
              }
            ],
            "text": "Same Day"
          }
        ],
        "actor": {
          "reference": "Practitioner/2578010",
          "display": "Song, River"
        }
      }
    }
  ]
}

Errors

The common errors 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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Schedule/166627791-4048128-9331486-0

Response

Status: 200 OK
{
  "resourceType": "Schedule",
  "id": "21265426-633867-3121665-0",
  "text": {
    "status": "generated",
    "div": "<div><p><b>Schedule</b></p><p><b>Type</b>: Same Day</p><p><b>Practitioner</b>: Song, River</p><p><b>Location</b>: Baseline West</p></div>"
  },
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
      "valueReference": {
        "reference": "Location/633867",
        "display": "Baseline West"
      }
    }
  ],
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394581000",
          "display": "Community medicine"
        }
      ],
      "text": "Same Day"
    }
  ],
  "actor": {
    "reference": "Practitioner/2578010",
    "display": "Song, River"
  }
}

Errors

The common errors may be returned.