This page is part of the Guide d'implémentation FHIR - Gestion d'Agendas Partagés (v3.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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

Resource Profile: GAP-FrSchedule

Profil décrivant un agenda médical

Usage:

• Examples for this Resource Profile: Schedule/example

Formal Views of Profile Content

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

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

This structure is derived from FRCoreScheduleProfile

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FRCoreScheduleProfile	A container for slots of time that may be available for booking appointments
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FRCoreScheduleProfile	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
serviceTypeDuration		0..*	(Complex)	FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration
availabilityTime		0..*	(Complex)	FR Core Schedule availability time Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule-availability-time
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this schedule is in active use
serviceCategory	Σ	0..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
actor	Σ	1..*	Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Location Profile | FR Core Patient Profile | FR Core Practitioner Profile)	Resource(s) that availability information is being provided for
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Schedule.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category 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()

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FRCoreScheduleProfile	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:fr-canonical	Σ	0..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
serviceTypeDuration		0..*	(Complex)	FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration
availabilityTime		0..*	(Complex)	FR Core Schedule availability time Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule-availability-time
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..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
specialty	Σ	0..*	CodeableConcept	Type of specialty needed Binding: FR Core ValueSet Practitioner specialty (required)
actor	Σ	1..*	Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Location Profile | FR Core Patient Profile | FR Core Practitioner Profile)	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.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Schedule.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Schedule.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Schedule.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Schedule.specialty	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty

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 FRCoreScheduleProfile

Summary

Differential View

This structure is derived from FRCoreScheduleProfile

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FRCoreScheduleProfile	A container for slots of time that may be available for booking appointments
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FRCoreScheduleProfile	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
serviceTypeDuration		0..*	(Complex)	FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration
availabilityTime		0..*	(Complex)	FR Core Schedule availability time Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule-availability-time
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this schedule is in active use
serviceCategory	Σ	0..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
actor	Σ	1..*	Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Location Profile | FR Core Patient Profile | FR Core Practitioner Profile)	Resource(s) that availability information is being provided for
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Schedule.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category 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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FRCoreScheduleProfile	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:fr-canonical	Σ	0..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
serviceTypeDuration		0..*	(Complex)	FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration
availabilityTime		0..*	(Complex)	FR Core Schedule availability time Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule-availability-time
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..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
specialty	Σ	0..*	CodeableConcept	Type of specialty needed Binding: FR Core ValueSet Practitioner specialty (required)
actor	Σ	1..*	Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Location Profile | FR Core Patient Profile | FR Core Practitioner Profile)	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.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Schedule.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Schedule.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Schedule.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Schedule.specialty	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty

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 FRCoreScheduleProfile

Summary

Other representations of profile: CSV, Excel, Schematron