ExampleIG, published by Example Publisher. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/trifork/fhir-ig-sample/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Example Schedule

Example base profile for Schedules.

Usages:

• Examples for this Profile: Schedule/exampleSchedule

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Schedule		0..*	Schedule	A container for slots of time that may be available for booking appointments
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:name		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this schedule is in active use
actor	Σ	1..*	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Resource(s) that availability information is being provided for
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Schedule	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Schedule	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Schedule	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Schedule

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Schedule		0..*	Schedule	A container for slots of time that may be available for booking appointments
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:name		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Schedule		0..*	Schedule	A container for slots of time that may be available for booking appointments
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:name		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
active	?!Σ	0..1	boolean	Whether this schedule is in active use
serviceCategory	Σ	0..*	CodeableConcept	High-level category Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableConcept	Specific service Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	Type of specialty needed Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
actor	Σ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Schedule.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Schedule.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category|4.0.1 From the FHIR Standard
Schedule.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type|4.0.1 From the FHIR Standard
Schedule.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Schedule	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Schedule	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Schedule	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Schedule

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Schedule		0..*	Schedule	A container for slots of time that may be available for booking appointments
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:name		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this schedule is in active use
actor	Σ	1..*	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Resource(s) that availability information is being provided for
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Schedule	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Schedule	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Schedule	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Schedule

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Schedule		0..*	Schedule	A container for slots of time that may be available for booking appointments
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:name		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Schedule		0..*	Schedule	A container for slots of time that may be available for booking appointments
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:name		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
active	?!Σ	0..1	boolean	Whether this schedule is in active use
serviceCategory	Σ	0..*	CodeableConcept	High-level category Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableConcept	Specific service Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	Type of specialty needed Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
actor	Σ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Schedule.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Schedule.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category|4.0.1 From the FHIR Standard
Schedule.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type|4.0.1 From the FHIR Standard
Schedule.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Schedule	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Schedule	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Schedule	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Schedule	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Schedule

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name

Other representations of profile: CSV, Excel, Schematron