Slot

ResourceBase · WorkflowTrial useMaturity 3

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

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	External Ids for this item
serviceCategoryΣ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointmentBinding (example): service-category
serviceTypeΣ	0..*	CodeableConcept	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 resourceBinding (example): service-type
specialtyΣ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointmentBinding (preferred): c80-practice-codes
appointmentTypeΣ	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type)Binding (preferred): v2-0276
scheduleRequiredΣ	1..1	Reference(Schedule)	The schedule resource that this slot defines an interval of status information
statusRequiredΣ	1..1	code	busy \| free \| busy-unavailable \| busy-tentative \| entered-in-errorBinding (required): slotstatus
startRequiredΣ	1..1	instant	Date/Time that the slot is to begin
endRequiredΣ	1..1	instant	Date/Time that the slot is to conclude
overbooked	0..1	boolean	This slot has already been overbooked, appointments are unlikely to be accepted for this time
comment	0..1	string	Comments on the slot to describe any extended information. Such as custom constraints on the slot

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Query with GET [base]/Slot?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description
`appointment-type`	token	The style of appointment or patient that may be booked in the slot (not service type) `Slot.appointmentType`
`identifier`	token	A Slot Identifier `Slot.identifier`
`schedule`	reference	The Schedule Resource that we are seeking a slot within `Slot.schedule`
`service-category`	token	A broad categorization of the service that is to be performed during this appointment `Slot.serviceCategory`
`service-type`	token	The type of appointments that can be booked into the slot `Slot.serviceType`
`specialty`	token	The specialty of a practitioner that would be required to perform the service requested in this appointment `Slot.specialty`
`start`	date	Appointment date/time. `Slot.start`
`status`	token	The free/busy status of the appointment `Slot.status`

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

`_haste-health-author`	reference	The author of the resource
`_id`	token	Logical id of this artifact
`_lastUpdated`	date	When the resource version last changed
`_profile`	uri	Profiles this resource claims to conform to
`_security`	token	Security Labels applied to this resource
`_source`	uri	Identifies where the resource comes from
`_tag`	token	Tags applied to this resource
`_type`	token	Derived from the R4B Definition