Guide d'implémentation FR Core
2.2.0-ballot - ballot

Guide d'implémentation FR Core, publié par Interop'Santé. Ce guide nest pas une publication autorisée ; cest la version en intégration continue pour la version 2.2.0-ballot construite par le CI Build FHIR (HL7® FHIR® Standard). Cette version est basée sur le contenu actuel de https://github.com/Interop-Sante/hl7.fhir.fr.core/ et change régulièrement. Voir le répertoire des versions publiées

## Resource Profile: FR Core Appointment Profile

Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment | Version: 2.2.0-ballot
Active as of 2025-12-29 | Computable Name: FRCoreAppointmentProfile

Profile of the Appointment resource for France. This profile adds the operator who created/updated/canceled the appointment. It also allows to possibly reference an appointment canceled and a document associated with the appointment.

Profil de la ressource Appointment pour la France. Ce profil ajoute l’opérateur qui a créé/modifié/annulé le RDV. Il permet également de référencer éventuellement un RDV annulé et/ou un document lié au RDV.

Utilisations:

- Référer à ce Profil: FR Core Encounter Profile
- Exemples pour ce Profil: Appointment/FRCoreAppointmentExample

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

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment(4.0.1) | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices pour extension |  | 0..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:appointmentOperator |  | 0..1 | Reference(FR Core Organization Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | RelatedPerson) | FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FRCoreValueSetPractitionerSpecialty (2.2.0-ballot) (required)
slot |  | 0..* | Reference(FR Core Slot Profile(2.2.0-ballot)) | The slots that this appointment is filling
participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
actor | Σ | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile(2.2.0-ballot) | FR Core Healthcare Service Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | FR Core Location Profile(2.2.0-ballot)) | Person, Location/HealthcareService or Device
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | Std. FHIR
Appointment.specialty | Base | required | FR Core ValueSet Practitioner specialty | 📍2.2.0-ballot | cet IG
Appointment.participant.​status | Base | required | ParticipationStatus | 📍4.0.1 | Std. FHIR

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified | `type.exists() or actor.exists()`
app-2 | error | Appointment | Either start and end are specified, or neither | `start.exists() = end.exists()`
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates | `(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show | `Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')`
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | bonne pratique | Appointment | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Appointment.implicitRules, Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.status, Appointment.specialty, Appointment.slot, Appointment.participant, Appointment.participant.modifierExtension, Appointment.participant.actor, Appointment.participant.status | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Appointment

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Appointment |  | 0..* | Appointment(4.0.1) | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
meta |  |  |  |
Slices pour profile |  | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Non ordonné, Ouvert par value:$this
profile:fr-canonical |  | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Motif requis: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment|2.2.0-ballot
Slices pour extension |  | 0..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url
extension:appointmentOperator |  | 0..1 | Reference(FR Core Organization Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | RelatedPerson) | FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
specialty |  | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FRCoreValueSetPractitionerSpecialty (2.2.0-ballot) (required)
slot |  | 0..* | Reference(FR Core Slot Profile(2.2.0-ballot)) | The slots that this appointment is filling
participant |  |  |  |
actor |  | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile(2.2.0-ballot) | FR Core Healthcare Service Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | FR Core Location Profile(2.2.0-ballot)) | Person, Location/HealthcareService or Device
Documentation pour ce format

#### Bindings terminologiques (différentiel)

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Appointment.specialty | Base | required | FR Core ValueSet Practitioner specialty | 📍2.2.0-ballot | cet IG

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment(4.0.1) | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
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: Non ordonné, Ouvert par value:url Constraints: ext-1
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 pour profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Non ordonné, Ouvert par value:$this
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Motif requis: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment|2.2.0-ballot
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.
Bindings Additionnels | But
AllLanguages | Binding Max
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 pour extension |  | 0..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:appointmentOperator |  | 0..1 | Reference(FR Core Organization Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | RelatedPerson) | FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier | Σ | 0..* | Identifier | External Ids for this item
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FRCoreValueSetPractitionerSpecialty (2.2.0-ballot) (required)
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Hl7VSAppointmentReasonCodes (2.0.0) (preferred)
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference |  | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource)
priority |  | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize
description |  | 0..1 | string | Shown on a subject line in a meeting request, or appointment list
supportingInformation |  | 0..* | Reference(Resource) | Additional information to support the appointment
start | Σ | 0..1 | instant | When appointment is to take place
end | Σ | 0..1 | instant | When appointment is to conclude
minutesDuration |  | 0..1 | positiveInt | Can be less than start/end (e.g. estimate)
slot |  | 0..* | Reference(FR Core Slot Profile(2.2.0-ballot)) | The slots that this appointment is filling
created |  | 0..1 | dateTime | The date that this appointment was initially created
comment |  | 0..1 | string | Additional comments
patientInstruction |  | 0..1 | string | Detailed information and instructions for the patient
basedOn |  | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess
participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor | Σ | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile(2.2.0-ballot) | FR Core Healthcare Service Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | FR Core Location Profile(2.2.0-ballot)) | Person, Location/HealthcareService or Device
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period |  | 0..1 | Period | Participation period of the actor
requestedPeriod |  | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Appointment.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | Std. FHIR
Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | Std. FHIR
Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | Std. FHIR
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | Std. FHIR
Appointment.cancelationReason | Base | example | Appointment cancellation reason | 📍4.0.1 | Std. FHIR
Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | Std. FHIR
Appointment.serviceType | Base | example | Service type | 📍4.0.1 | Std. FHIR
Appointment.specialty | Base | required | FR Core ValueSet Practitioner specialty | 📍2.2.0-ballot | cet IG
Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📍2.0.0 | THO v7.0
Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | Std. FHIR
Appointment.participant.​type | Base | extensible | Participant type | 📍4.0.1 | Std. FHIR
Appointment.participant.​required | Base | required | ParticipantRequired | 📍4.0.1 | Std. FHIR
Appointment.participant.​status | Base | required | ParticipationStatus | 📍4.0.1 | Std. FHIR

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified | `type.exists() or actor.exists()`
app-2 | error | Appointment | Either start and end are specified, or neither | `start.exists() = end.exists()`
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates | `(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show | `Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')`
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | bonne pratique | Appointment | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Appointment.meta, Appointment.meta.extension, Appointment.meta.versionId, Appointment.meta.lastUpdated, Appointment.meta.source, Appointment.meta.profile, Appointment.meta.profile:fr-canonical, Appointment.meta.security, Appointment.meta.tag, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.identifier, Appointment.status, Appointment.cancelationReason, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.reasonReference, Appointment.priority, Appointment.description, Appointment.supportingInformation, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.slot, Appointment.created, Appointment.comment, Appointment.patientInstruction, Appointment.basedOn, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, Appointment.participant.actor, Appointment.participant.required, Appointment.participant.status, Appointment.participant.period, Appointment.requestedPeriod | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Appointment.meta.extension, Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.participant.extension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Appointment

Résumé

Structures

Cette structure fait référence à ces autres structures:

- FR Core Slot Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot|2.2.0-ballot)
- Device (http://hl7.org/fhir/StructureDefinition/Device|4.0.1)
- PractitionerRole (http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1)
- FR Core Related Person Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person|2.2.0-ballot)
- FR Core Healthcare Service Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service|2.2.0-ballot)
- FR Core Practitioner Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-practitioner|2.2.0-ballot)
- FR Core Patient Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient|2.2.0-ballot)
- FR Core Location Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location|2.2.0-ballot)

Extensions

Cette structure fait référence à ces extensions:

- https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator|2.2.0-ballot

Slices

Cette structure définit les slices suivantes:

- The element 1 is sliced based on the value of Appointment.meta.profile

Key Elements View

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment(4.0.1) | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices pour extension |  | 0..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:appointmentOperator |  | 0..1 | Reference(FR Core Organization Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | RelatedPerson) | FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FRCoreValueSetPractitionerSpecialty (2.2.0-ballot) (required)
slot |  | 0..* | Reference(FR Core Slot Profile(2.2.0-ballot)) | The slots that this appointment is filling
participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
actor | Σ | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile(2.2.0-ballot) | FR Core Healthcare Service Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | FR Core Location Profile(2.2.0-ballot)) | Person, Location/HealthcareService or Device
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | Std. FHIR
Appointment.specialty | Base | required | FR Core ValueSet Practitioner specialty | 📍2.2.0-ballot | cet IG
Appointment.participant.​status | Base | required | ParticipationStatus | 📍4.0.1 | Std. FHIR

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified | `type.exists() or actor.exists()`
app-2 | error | Appointment | Either start and end are specified, or neither | `start.exists() = end.exists()`
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates | `(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show | `Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')`
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | bonne pratique | Appointment | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Appointment.implicitRules, Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.status, Appointment.specialty, Appointment.slot, Appointment.participant, Appointment.participant.modifierExtension, Appointment.participant.actor, Appointment.participant.status | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from Appointment

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Appointment |  | 0..* | Appointment(4.0.1) | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
meta |  |  |  |
Slices pour profile |  | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Non ordonné, Ouvert par value:$this
profile:fr-canonical |  | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Motif requis: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment|2.2.0-ballot
Slices pour extension |  | 0..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url
extension:appointmentOperator |  | 0..1 | Reference(FR Core Organization Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | RelatedPerson) | FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
specialty |  | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FRCoreValueSetPractitionerSpecialty (2.2.0-ballot) (required)
slot |  | 0..* | Reference(FR Core Slot Profile(2.2.0-ballot)) | The slots that this appointment is filling
participant |  |  |  |
actor |  | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile(2.2.0-ballot) | FR Core Healthcare Service Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | FR Core Location Profile(2.2.0-ballot)) | Person, Location/HealthcareService or Device
Documentation pour ce format

#### Bindings terminologiques (différentiel)

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Appointment.specialty | Base | required | FR Core ValueSet Practitioner specialty | 📍2.2.0-ballot | cet IG

Snapshot View

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment(4.0.1) | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
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: Non ordonné, Ouvert par value:url Constraints: ext-1
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 pour profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Non ordonné, Ouvert par value:$this
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Motif requis: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment|2.2.0-ballot
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.
Bindings Additionnels | But
AllLanguages | Binding Max
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 pour extension |  | 0..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:appointmentOperator |  | 0..1 | Reference(FR Core Organization Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | RelatedPerson) | FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier | Σ | 0..* | Identifier | External Ids for this item
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FRCoreValueSetPractitionerSpecialty (2.2.0-ballot) (required)
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Hl7VSAppointmentReasonCodes (2.0.0) (preferred)
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference |  | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource)
priority |  | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize
description |  | 0..1 | string | Shown on a subject line in a meeting request, or appointment list
supportingInformation |  | 0..* | Reference(Resource) | Additional information to support the appointment
start | Σ | 0..1 | instant | When appointment is to take place
end | Σ | 0..1 | instant | When appointment is to conclude
minutesDuration |  | 0..1 | positiveInt | Can be less than start/end (e.g. estimate)
slot |  | 0..* | Reference(FR Core Slot Profile(2.2.0-ballot)) | The slots that this appointment is filling
created |  | 0..1 | dateTime | The date that this appointment was initially created
comment |  | 0..1 | string | Additional comments
patientInstruction |  | 0..1 | string | Detailed information and instructions for the patient
basedOn |  | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess
participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor | Σ | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile(2.2.0-ballot) | FR Core Healthcare Service Profile(2.2.0-ballot) | FR Core Practitioner Profile(2.2.0-ballot) | FR Core Patient Profile(2.2.0-ballot) | FR Core Location Profile(2.2.0-ballot)) | Person, Location/HealthcareService or Device
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period |  | 0..1 | Period | Participation period of the actor
requestedPeriod |  | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Appointment.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | Std. FHIR
Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | Std. FHIR
Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | Std. FHIR
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | Std. FHIR
Appointment.cancelationReason | Base | example | Appointment cancellation reason | 📍4.0.1 | Std. FHIR
Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | Std. FHIR
Appointment.serviceType | Base | example | Service type | 📍4.0.1 | Std. FHIR
Appointment.specialty | Base | required | FR Core ValueSet Practitioner specialty | 📍2.2.0-ballot | cet IG
Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📍2.0.0 | THO v7.0
Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | Std. FHIR
Appointment.participant.​type | Base | extensible | Participant type | 📍4.0.1 | Std. FHIR
Appointment.participant.​required | Base | required | ParticipantRequired | 📍4.0.1 | Std. FHIR
Appointment.participant.​status | Base | required | ParticipationStatus | 📍4.0.1 | Std. FHIR

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified | `type.exists() or actor.exists()`
app-2 | error | Appointment | Either start and end are specified, or neither | `start.exists() = end.exists()`
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates | `(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show | `Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')`
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | bonne pratique | Appointment | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Appointment.meta, Appointment.meta.extension, Appointment.meta.versionId, Appointment.meta.lastUpdated, Appointment.meta.source, Appointment.meta.profile, Appointment.meta.profile:fr-canonical, Appointment.meta.security, Appointment.meta.tag, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.identifier, Appointment.status, Appointment.cancelationReason, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.reasonReference, Appointment.priority, Appointment.description, Appointment.supportingInformation, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.slot, Appointment.created, Appointment.comment, Appointment.patientInstruction, Appointment.basedOn, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, Appointment.participant.actor, Appointment.participant.required, Appointment.participant.status, Appointment.participant.period, Appointment.requestedPeriod | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Appointment.meta.extension, Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.participant.extension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Appointment

Résumé

Structures

Cette structure fait référence à ces autres structures:

- FR Core Slot Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot|2.2.0-ballot)
- Device (http://hl7.org/fhir/StructureDefinition/Device|4.0.1)
- PractitionerRole (http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1)
- FR Core Related Person Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person|2.2.0-ballot)
- FR Core Healthcare Service Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service|2.2.0-ballot)
- FR Core Practitioner Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-practitioner|2.2.0-ballot)
- FR Core Patient Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient|2.2.0-ballot)
- FR Core Location Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location|2.2.0-ballot)

Extensions

Cette structure fait référence à ces extensions:

- https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator|2.2.0-ballot

Slices

Cette structure définit les slices suivantes:

- The element 1 is sliced based on the value of Appointment.meta.profile

Other representations of profile: CSV, Excel, Schematron