This page is part of the Guide d'implémentation FHIR - Gestion d'Agendas Partagés (v3.0.0-ballot: Release) based on FHIR 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

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 FrSchedule

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FrSchedule	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..*	FrSchedule	A container for slots of time that may be available for booking appointments
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
serviceTypeDuration	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrServiceTypeDuration
availabilityTime	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrScheduleAvailabiltyTime
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
active	?!ΣN	0..1	boolean	Whether this schedule is in active use
serviceCategory	ΣN	0..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
actor	ΣCN	1..*	Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrLocation | FrPatient | FrPractitioner)	Resource(s) that availability information is being provided for
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Schedule.serviceCategory	example	ServiceCategory

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** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ref-1	error	Schedule.actor	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FrSchedule	A container for slots of time that may be available for booking appointments
id	Σ	0..1	id	Logical id of this artifact
meta	ΣN	0..1	Meta	Metadata about the resource
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
language	N	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	N	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
serviceTypeDuration	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrServiceTypeDuration
availabilityTime	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrScheduleAvailabiltyTime
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	ΣN	0..*	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣN	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣN	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	ΣN	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	ΣN	0..1	string	The value that is unique Example General: 123456
period	ΣCN	0..1	Period	Time period when id is/was valid for use
assigner	ΣCN	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!ΣN	0..1	boolean	Whether this schedule is in active use
serviceCategory	ΣN	0..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
specialty	ΣN	0..*	CodeableConcept	Type of specialty needed Binding: fr-practitioner-specialty (required): Additional details about where the content was created (e.g. clinical specialty).
actor	ΣCN	1..*	Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrLocation | FrPatient | FrPractitioner)	Resource(s) that availability information is being provided for
planningHorizon	ΣCN	0..1	Period	Period of time covered by schedule
comment	N	0..1	string	Comments on availability
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Schedule.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Schedule.identifier.use	required	IdentifierUse
Schedule.identifier.type	extensible	Identifier Type Codes
Schedule.serviceCategory	example	ServiceCategory
Schedule.specialty	required	fr-practitioner-specialty (a valid code from https://mos.esante.gouv.fr/NOS/TRE_R38-SpecialiteOrdinale/FHIR/TRE-R38-SpecialiteOrdinale)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Schedule.identifier.period, Schedule.planningHorizon	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Schedule.identifier.assigner, Schedule.actor	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from FrSchedule

Summary

Differential View

This structure is derived from FrSchedule

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FrSchedule	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..*	FrSchedule	A container for slots of time that may be available for booking appointments
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
serviceTypeDuration	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrServiceTypeDuration
availabilityTime	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrScheduleAvailabiltyTime
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
active	?!ΣN	0..1	boolean	Whether this schedule is in active use
serviceCategory	ΣN	0..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
actor	ΣCN	1..*	Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrLocation | FrPatient | FrPractitioner)	Resource(s) that availability information is being provided for
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Schedule.serviceCategory	example	ServiceCategory

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** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ref-1	error	Schedule.actor	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Schedule		0..*	FrSchedule	A container for slots of time that may be available for booking appointments
id	Σ	0..1	id	Logical id of this artifact
meta	ΣN	0..1	Meta	Metadata about the resource
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
language	N	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	N	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
serviceTypeDuration	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrServiceTypeDuration
availabilityTime	N	0..*	(Complex)	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrScheduleAvailabiltyTime
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	ΣN	0..*	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣN	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣN	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	ΣN	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	ΣN	0..1	string	The value that is unique Example General: 123456
period	ΣCN	0..1	Period	Time period when id is/was valid for use
assigner	ΣCN	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!ΣN	0..1	boolean	Whether this schedule is in active use
serviceCategory	ΣN	0..1	CodeableConcept	High-level category Binding: ServiceCategory (example)
specialty	ΣN	0..*	CodeableConcept	Type of specialty needed Binding: fr-practitioner-specialty (required): Additional details about where the content was created (e.g. clinical specialty).
actor	ΣCN	1..*	Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrLocation | FrPatient | FrPractitioner)	Resource(s) that availability information is being provided for
planningHorizon	ΣCN	0..1	Period	Period of time covered by schedule
comment	N	0..1	string	Comments on availability
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Schedule.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Schedule.identifier.use	required	IdentifierUse
Schedule.identifier.type	extensible	Identifier Type Codes
Schedule.serviceCategory	example	ServiceCategory
Schedule.specialty	required	fr-practitioner-specialty (a valid code from https://mos.esante.gouv.fr/NOS/TRE_R38-SpecialiteOrdinale/FHIR/TRE-R38-SpecialiteOrdinale)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Schedule.identifier.period, Schedule.planningHorizon	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Schedule.identifier.assigner, Schedule.actor	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from FrSchedule

Summary

Other representations of profile: CSV, Excel, Schematron