Get Slot Status

Type: Resource
Verb: GET
Default URL Path for Single-Source System: <base-url>/Slot/{sourceSlotId}
Default URL Path for Multi-Source System: <base-url>/Slot/{sourceSystem}/{sourceSlotId}

Where:

sourceSystem identifies the source system.
sourceSlotId is the ID of a time slot in the SourceSystem returned from the Find Available Slots operation.

Your Base URL is configured in Setup > Appointment Scheduling.

All communications with the external system use the FHIR R4 standard.

Response Codes

200: Success
401: Unauthorized
404: Slot not found
5xx: Server error

Response Body

To map slots, resourceType, id, status, start, and end are required in the FHIR response.

1{
2        "resourceType" : "Slot",
3        "id" : "<string>"
4        "identifier" : [{ Identifier }],
5        "serviceCategory" : [{ CodeableConcept }],
6        "serviceType" : [{ CodeableConcept }],
7        "specialty" : [{ CodeableConcept }],
8        "appointmentType" : { CodeableConcept },
9        "schedule" : { Reference(Schedule) },//As we are passing _include=Slot:schedule in query, it should include the "Schedule" resource as one of the item in "entry" field.
10        "status" : "<code>",
11        "start" : "<instant>",
12        "end" : "<instant>",
13        "overbooked" : <boolean>,
14        "comment" : "<string>"
15 }

The valid values for slotStatus are:

busy
free
busy-unavailable
busy-tentative
entered-in-error

See Also

FHIR Resource: Slot