Gestion d'Agenda Partagé (GAP)
3.0.0-ballot - 3.0.0-ballot
Publication Build: This will be filled in by the publication tooling
| Official URL: https://interop.esante.gouv.fr/ig/fhir/gap/StructureDefinition/gap-fr-slot | Version: 3.0.0-ballot | |||
| Draft as of 2023-10-10 | Computable Name: GAP_FrSlot | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FrSlot
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | FrSlot | A slot of time on a schedule that may be available for booking appointments | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | FrSlot | A slot of time on a schedule that may be available for booking appointments | |
![]() ![]() | ?!ΣN | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() | ΣN | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
![]() ![]() | ΣCN | 1..1 | Reference(FrSchedule) | The schedule resource that this slot defines an interval of status information |
![]() ![]() | ΣN | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. |
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to begin |
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to conclude |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Slot.serviceCategory | example | ServiceCategory |
| Slot.status | required | SlotStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Slot | 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 | Slot | 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 | Slot | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Slot | 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 | Slot.schedule | 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | FrSlot | A slot of time on a schedule that may be available for booking appointments | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | ΣN | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | N | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() | ΣN | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | ?!ΣN | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() | Σ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. | ||||
![]() ![]() ![]() | ΣN | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() | ΣN | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() | ΣN | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() | ΣN | 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) | ||||
![]() ![]() | ΣN | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: fr-practitioner-specialty (required): Additional details about where the content was created (e.g. clinical specialty). | ||||
![]() ![]() | ΣN | 0..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
![]() ![]() | ΣCN | 1..1 | Reference(FrSchedule) | The schedule resource that this slot defines an interval of status information | ||||
![]() ![]() | ΣN | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. | ||||
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to begin | ||||
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to conclude | ||||
![]() ![]() | N | 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | ||||
![]() ![]() | N | 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Slot.language | preferred | CommonLanguages
| ||||
| Slot.identifier.use | required | IdentifierUse | ||||
| Slot.identifier.type | extensible | Identifier Type Codes | ||||
| Slot.serviceCategory | example | ServiceCategory | ||||
| Slot.serviceType | example | ServiceType | ||||
| Slot.specialty | required | fr-practitioner-specialty (a valid code from https://mos.esante.gouv.fr/NOS/TRE_R38-SpecialiteOrdinale/FHIR/TRE-R38-SpecialiteOrdinale) | ||||
| Slot.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Slot.status | required | SlotStatus |
| 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 | Slot.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | Slot.identifier.assigner, Slot.schedule | 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 FrSlot
Differential View
This structure is derived from FrSlot
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | FrSlot | A slot of time on a schedule that may be available for booking appointments | |
Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | FrSlot | A slot of time on a schedule that may be available for booking appointments | |
![]() ![]() | ?!ΣN | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() | ΣN | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
![]() ![]() | ΣCN | 1..1 | Reference(FrSchedule) | The schedule resource that this slot defines an interval of status information |
![]() ![]() | ΣN | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. |
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to begin |
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to conclude |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Slot.serviceCategory | example | ServiceCategory |
| Slot.status | required | SlotStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Slot | 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 | Slot | 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 | Slot | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Slot | 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 | Slot.schedule | 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | FrSlot | A slot of time on a schedule that may be available for booking appointments | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | ΣN | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | N | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() | ΣN | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | ?!ΣN | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() | Σ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. | ||||
![]() ![]() ![]() | ΣN | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() | ΣN | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() | ΣN | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() | ΣN | 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) | ||||
![]() ![]() | ΣN | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: fr-practitioner-specialty (required): Additional details about where the content was created (e.g. clinical specialty). | ||||
![]() ![]() | ΣN | 0..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
![]() ![]() | ΣCN | 1..1 | Reference(FrSchedule) | The schedule resource that this slot defines an interval of status information | ||||
![]() ![]() | ΣN | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. | ||||
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to begin | ||||
![]() ![]() | ΣN | 1..1 | instant | Date/Time that the slot is to conclude | ||||
![]() ![]() | N | 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | ||||
![]() ![]() | N | 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Slot.language | preferred | CommonLanguages
| ||||
| Slot.identifier.use | required | IdentifierUse | ||||
| Slot.identifier.type | extensible | Identifier Type Codes | ||||
| Slot.serviceCategory | example | ServiceCategory | ||||
| Slot.serviceType | example | ServiceType | ||||
| Slot.specialty | required | fr-practitioner-specialty (a valid code from https://mos.esante.gouv.fr/NOS/TRE_R38-SpecialiteOrdinale/FHIR/TRE-R38-SpecialiteOrdinale) | ||||
| Slot.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Slot.status | required | SlotStatus |
| 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 | Slot.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | Slot.identifier.assigner, Slot.schedule | 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 FrSlot
Other representations of profile: CSV, Excel, Schematron