Skip to main content

Slot

Trial Use 3 Workflow

A slot of time on a schedule that may be available for booking appointments.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Slot
InteractionMethodPath
ReadGET/fhir/R4/Slot/[id]
VreadGET/fhir/R4/Slot/[id]/_history/[vid]
UpdatePUT/fhir/R4/Slot/[id]
PatchPATCH/fhir/R4/Slot/[id]
DeleteDELETE/fhir/R4/Slot/[id]
CreatePOST/fhir/R4/Slot
SearchGET/fhir/R4/Slot
HistoryGET/fhir/R4/Slot/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*External Ids for this item
serviceCategoryCodeableConcept0..*A broad categorization of the service that is to be performed during this appointment
serviceTypeCodeableConcept0..*The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
specialtyCodeableConcept0..*The specialty of a practitioner that would be required to perform the service requested in this appointment
appointmentTypeCodeableConcept0..1The style of appointment or patient that may be booked in the slot (not service type)
scheduleReference1..1The schedule resource that this slot defines an interval of status information
statuscode1..1busy | free | busy-unavailable | busy-tentative | entered-in-error
startinstant1..1Date/Time that the slot is to begin
endinstant1..1Date/Time that the slot is to conclude
overbookedboolean0..1This slot has already been overbooked, appointments are unlikely to be accepted for this time
commentstring0..1Comments on the slot to describe any extended information. Such as custom constraints on the slot

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
appointment-typestringhttp://hl7.org/fhir/SearchParameter/Slot-appointment-type
endstringhttps://medplum.com/fhir/SearchParameter/Slot-end
identifierstringhttp://hl7.org/fhir/SearchParameter/Slot-identifier
schedulestringhttp://hl7.org/fhir/SearchParameter/Slot-schedule
service-categorystringhttp://hl7.org/fhir/SearchParameter/Slot-service-category
service-typestringhttp://hl7.org/fhir/SearchParameter/Slot-service-type
specialtystringhttp://hl7.org/fhir/SearchParameter/Slot-specialty
startstringhttp://hl7.org/fhir/SearchParameter/Slot-start
statusstringhttp://hl7.org/fhir/SearchParameter/Slot-status

Reference​

  • Official FHIR R4 spec: Slot
  • Maturity: Trial Use 3 (FMM 3).