1. FHIR DSTU 2 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Slot

Get a list of slots

get

/Slot/

Retrieves a list of schedules that meet supplied query parameters.

Note:

  • Valid IDs for the schedule.actor and -location search parameters are determined by the customer and provided when integrating your application with the customer's production environment. See the Slot resource information for details.
  • The retrieved slots are sorted first by start date and time in ascending order (earliest first), followed by slot-type and Scheduling Location display.
  • The search operation only returns free slots that are available to be booked. However, booked slots may still be retrieved when using the _id parameter.

Authorization Types

This operation supports the following authorization types:

  • Patient
  • Provider
  • System

Request

Query Parameters
  • Minimum Number of Items: 1

    Location references for the slot.

    Example: -location=5678

  • Minimum Value: 1

    The maximum number of results to return per page.

    Example: _count=15

  • Minimum Number of Items: 1

    The logical resource ID. This parameter is required if the slot-type parameter is not used.

    Example: _id=12345

  • Other resource entries to be returned as part of the bundle.

    • May be provided once with the Slot:schedule value. Example: _include=Slot:schedule
    • May be provided with the _id parameter. Example: _id=21265426-633867-3121665-0&_include=Slot:schedule
    • Must include the user/Schedule.read or the patient/Schedule.read scope in addition to a Slot scope.

    Example: _include=Slot:schedule

  • Minimum Number of Items: 1

    Appointment types that can be booked into the slot.

    Example: schedule.actor=Practitioner/1234

  • Minimum Number of Items: 1

    Appointment types that can be booked into the slot. This parameter is required if the _id parameter is not used.

    • May contain standard codes or proprietary codes. If multiple slot-type parameters are used, they must be all standard codes or all proprietary codes.
    • When using standard codes, select codes bound to Slot.type as noted in the Slot resource information.
    • When using proprietary codes, the system should be https://fhir.cerner.com/<EHR_source_id>/codeSet/, where the 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

    Example: http://snomed.info/sct|394581000

  • The datetime value of the slot. Required when slot-type is used.

    May be provided:

    • Once without a prefix or time component to imply a date range. Example: &start=2016, &start=2016-07, &start=2016-07-04.
    • Twice with the ge and lt prefixes to indicate a specific range. The date and prefix pairs must define an upper and lower bound. Example: &start=ge2014&start=lt2016, &start=ge2016-07&start=lt2017-07.

Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Headers
Body
Example Response (application/json+fhir)
{
    "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"
            }
        }
    ]
}

Default Response

An OperationOutcome describing any error that occurred.

Headers
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : issue
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : location
Type: array
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top