Skip to main content

Schedule

PropertyValue
Publisher
NameSchedule
URLhttp://hl7.org/fhir/StructureDefinition/Schedule
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Schedule0..*ScheduleA container for slots of time that may be available for booking appointments.
Schedule.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Schedule.meta0..1MetaThe 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.implicitRules0..1uriA 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.language0..1codeThe base language in which the resource is written.
Schedule.text0..1NarrativeA 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.contained0..*ResourceThese 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.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.identifier0..*IdentifierExternal Ids for this item.
Schedule.active0..1booleanWhether this schedule record is in active use or should not be used (such as was entered in error).
Schedule.serviceCategory0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment.
Schedule.serviceType0..*CodeableConceptThe specific service that is to be performed during this appointment.
Schedule.specialty0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment.
Schedule.actor1..*ReferenceSlots that reference this schedule resource provide the availability details to these referenced resource(s).
Schedule.planningHorizon0..1PeriodThe 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.comment0..1stringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides 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
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed 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
activetokenIs the schedule in active useSchedule.active
actorreferenceThe individual(HealthcareService, Practitioner, Location, ...) to find a Schedule forSchedule.actor
datedateSearch for Schedule resources that have a period that contains this date specifiedSchedule.planningHorizon
identifiertokenA Schedule IdentifierSchedule.identifier
service-categorytokenHigh-level categorySchedule.serviceCategory
service-typetokenThe type of appointments that can be booked into associated slot(s)Schedule.serviceType
specialtytokenType of specialty neededSchedule.specialty