Schedule

ResourceBase · WorkflowTrial useMaturity 3

A container for slots of time that may be available for booking appointments.

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	External Ids for this item
active?!Σ	0..1	boolean	Whether this schedule is in active use
serviceCategoryΣ	0..*	CodeableConcept	High-level categoryBinding (example): service-category
serviceTypeΣ	0..*	CodeableConcept	Specific serviceBinding (example): service-type
specialtyΣ	0..*	CodeableConcept	Type of specialty neededBinding (preferred): c80-practice-codes
actorRequiredΣ	1..*	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)	Resource(s) that availability information is being provided for
planningHorizonΣ	0..1	Period	Period of time covered by schedule
comment	0..1	string	Comments on availability

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

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

Parameter	Type	Description
`active`	token	Is the schedule in active use `Schedule.active`
`actor`	reference	The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for `Schedule.actor`
`date`	date	Search for Schedule resources that have a period that contains this date specified `Schedule.planningHorizon`
`identifier`	token	A Schedule Identifier `Schedule.identifier`
`service-category`	token	High-level category `Schedule.serviceCategory`
`service-type`	token	The type of appointments that can be booked into associated slot(s) `Schedule.serviceType`
`specialty`	token	Type of specialty needed `Schedule.specialty`

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