Guide d'implémentation Fr Core
2.1.0 - trial-use France flag

This page is part of the Guide d'implémentation Fr Core (v2.1.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

Resource Profile: FR Core Slot Profile

Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot Version: 2.1.0
Active as of 2024-09-04 Computable Name: FRCoreSlotProfile

Profil of the Slot resource for France.

Profil de la ressource Slot pour la France

Usage:

Formal Views of Profile Content

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

This structure is derived from Slot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot Slot
... meta
.... 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-slot
... identifier
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... serviceCategory 0..1 CodeableConcept A broad categorization of the service that is to be performed during this appointment
... schedule 1..1 Reference(FR Core Schedule Profile) The schedule resource that this slot defines an interval of status information
... status 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Slot.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Slot.specialtyrequiredFRCoreValueSetPractitionerSpecialty
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty
from this IG
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... serviceCategory Σ 0..1 CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... schedule Σ 1..1 Reference(FR Core Schedule Profile) The schedule resource that this slot defines an interval of status information
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required)
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Slot.specialtyrequiredFRCoreValueSetPractitionerSpecialty
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty
from this IG
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf 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-4errorSlotIf 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-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule 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-slot
.... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... serviceCategory Σ 0..1 CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: FR Core ValueSet Practitioner specialty (required)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... schedule Σ 1..1 Reference(FR Core Schedule Profile) The schedule resource that this slot defines an interval of status information
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required)
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude
... overbooked 0..1 boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment 0..1 string Comments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Slot.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Slot.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Slot.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Slot.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Slot.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Slot.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Slot.specialtyrequiredFRCoreValueSetPractitionerSpecialty
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty
from this IG
Slot.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf 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-4errorSlotIf 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-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Slot

Summary

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Slot.meta.profile

Differential View

This structure is derived from Slot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot Slot
... meta
.... 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-slot
... identifier
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... serviceCategory 0..1 CodeableConcept A broad categorization of the service that is to be performed during this appointment
... schedule 1..1 Reference(FR Core Schedule Profile) The schedule resource that this slot defines an interval of status information
... status 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Slot.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Slot.specialtyrequiredFRCoreValueSetPractitionerSpecialty
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty
from this IG
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... serviceCategory Σ 0..1 CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... schedule Σ 1..1 Reference(FR Core Schedule Profile) The schedule resource that this slot defines an interval of status information
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required)
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Slot.specialtyrequiredFRCoreValueSetPractitionerSpecialty
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty
from this IG
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf 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-4errorSlotIf 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-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule 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-slot
.... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... serviceCategory Σ 0..1 CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: FR Core ValueSet Practitioner specialty (required)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... schedule Σ 1..1 Reference(FR Core Schedule Profile) The schedule resource that this slot defines an interval of status information
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required)
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude
... overbooked 0..1 boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment 0..1 string Comments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Slot.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Slot.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Slot.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Slot.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Slot.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Slot.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Slot.specialtyrequiredFRCoreValueSetPractitionerSpecialty
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty
from this IG
Slot.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf 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-4errorSlotIf 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-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Slot

Summary

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Slot.meta.profile

 

Other representations of profile: CSV, Excel, Schematron