Schedule

Property	Value
Publisher
Name	Schedule
URL	http://hl7.org/fhir/StructureDefinition/Schedule
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
Schedule	0..*	Schedule	A container for slots of time that may be available for booking appointments.
Schedule.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Schedule.meta	0..1	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Schedule.implicitRules	0..1	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Schedule.language	0..1	code	The base language in which the resource is written.
Schedule.text	0..1	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Schedule.contained	0..*	Resource	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Schedule.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Schedule.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Schedule.identifier	0..*	Identifier	External Ids for this item.
Schedule.active	0..1	boolean	Whether this schedule record is in active use or should not be used (such as was entered in error).
Schedule.serviceCategory	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment.
Schedule.serviceType	0..*	CodeableConcept	The specific service that is to be performed during this appointment.
Schedule.specialty	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment.
Schedule.actor	1..*	Reference	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
Schedule.planningHorizon	0..1	Period	The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
Schedule.comment	0..1	string	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
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