Xt-EHR
0.1.0 - ci-build

Xt-EHR, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions

Logical Model: Appointment (model)

Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAppointment Version: 0.1.0
Draft as of 2024-09-18 Computable Name: EHDSAppointment

C.20 - EHDS refined base model for Appointment

Usage:

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSAppointment 0..* Base Appointment (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 0..* Identifier C.20.1 - Identifier
... status 1..1 CodeableConcept C.20.2 - Status
Binding Description (No ValueSet): (preferred): HL7 Appointment status

... class 0..* CodeableConcept C.20.3 - Class
Binding Description (No ValueSet): (preferred): HL7 Encounter class


... specialty 0..* CodeableConcept C.20.5 - Specialty
Binding Description (No ValueSet): (preferred): SNOMED CT


... type 0..1 CodeableConcept C.20.6 - Type
Binding Description (No ValueSet): (preferred): TBD

... reason 0..* CodeableReference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.7 - Reason
Binding Description (No ValueSet): (preferred): SNOMED CT


... priority 0..1 CodeableConcept C.20.8 - Priority
Binding Description (No ValueSet): (preferred): HL7 Act priority

... description 0..1 Narrative C.20.9 - Description
... supportingInformation 0..* Reference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.10 - Supporting information
... start 0..1 dateTime C.20.11 - Start
... end 0..1 dateTime C.20.12 - End
... requestedPeriod 0..* Period C.20.13 - Requested period
... slot 0..* Reference(Slot (model)) C.20.14 - Slot
... patientInstruction 0..* Narrative C.20.15 - Patient instruction
... note 0..* Narrative C.20.16 - Note
... subject 0..1 Reference(Patient (model) | Group (model)) C.20.17 - Subject
... participant 0..* BackboneElement C.20.18 - Participant
.... type 0..* CodeableConcept C.20.18.1 - Type
Binding Description (No ValueSet): (preferred): HL7 Participant Type


.... actor 0..1 Reference(Patient (model) | Group (model) | Health professional (model) | Health professional role (model) | Organization (model) | Related person (model) | Device (model)) C.20.18.2 - Actor
.... required 0..1 boolean C.20.18.3 - Required

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSAppointment.statuspreferred
EHDSAppointment.classpreferred
EHDSAppointment.serviceTypepreferred
EHDSAppointment.specialtypreferred
EHDSAppointment.typepreferred
EHDSAppointment.reasonpreferred
EHDSAppointment.prioritypreferred
EHDSAppointment.participant.typepreferred
NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSAppointment 0..* Base Appointment (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 0..* Identifier C.20.1 - Identifier
... status 1..1 CodeableConcept C.20.2 - Status
Binding Description (No ValueSet): (preferred): HL7 Appointment status

... class 0..* CodeableConcept C.20.3 - Class
Binding Description (No ValueSet): (preferred): HL7 Encounter class


... specialty 0..* CodeableConcept C.20.5 - Specialty
Binding Description (No ValueSet): (preferred): SNOMED CT


... type 0..1 CodeableConcept C.20.6 - Type
Binding Description (No ValueSet): (preferred): TBD

... reason 0..* CodeableReference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.7 - Reason
Binding Description (No ValueSet): (preferred): SNOMED CT


... priority 0..1 CodeableConcept C.20.8 - Priority
Binding Description (No ValueSet): (preferred): HL7 Act priority

... description 0..1 Narrative C.20.9 - Description
... supportingInformation 0..* Reference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.10 - Supporting information
... start 0..1 dateTime C.20.11 - Start
... end 0..1 dateTime C.20.12 - End
... requestedPeriod 0..* Period C.20.13 - Requested period
... slot 0..* Reference(Slot (model)) C.20.14 - Slot
... patientInstruction 0..* Narrative C.20.15 - Patient instruction
... note 0..* Narrative C.20.16 - Note
... subject 0..1 Reference(Patient (model) | Group (model)) C.20.17 - Subject
... participant 0..* BackboneElement C.20.18 - Participant
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..* CodeableConcept C.20.18.1 - Type
Binding Description (No ValueSet): (preferred): HL7 Participant Type


.... actor 0..1 Reference(Patient (model) | Group (model) | Health professional (model) | Health professional role (model) | Organization (model) | Related person (model) | Device (model)) C.20.18.2 - Actor
.... required 0..1 boolean C.20.18.3 - Required

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSAppointment.statuspreferred
EHDSAppointment.classpreferred
EHDSAppointment.serviceTypepreferred
EHDSAppointment.specialtypreferred
EHDSAppointment.typepreferred
EHDSAppointment.reasonpreferred
EHDSAppointment.prioritypreferred
EHDSAppointment.participant.typepreferred

Constraints

IdGradePath(s)DetailsRequirements
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
.. EHDSAppointment 0..* Base Appointment (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 0..* Identifier C.20.1 - Identifier
... status 1..1 CodeableConcept C.20.2 - Status
Binding Description (No ValueSet): (preferred): HL7 Appointment status

... class 0..* CodeableConcept C.20.3 - Class
Binding Description (No ValueSet): (preferred): HL7 Encounter class


... specialty 0..* CodeableConcept C.20.5 - Specialty
Binding Description (No ValueSet): (preferred): SNOMED CT


... type 0..1 CodeableConcept C.20.6 - Type
Binding Description (No ValueSet): (preferred): TBD

... reason 0..* CodeableReference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.7 - Reason
Binding Description (No ValueSet): (preferred): SNOMED CT


... priority 0..1 CodeableConcept C.20.8 - Priority
Binding Description (No ValueSet): (preferred): HL7 Act priority

... description 0..1 Narrative C.20.9 - Description
... supportingInformation 0..* Reference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.10 - Supporting information
... start 0..1 dateTime C.20.11 - Start
... end 0..1 dateTime C.20.12 - End
... requestedPeriod 0..* Period C.20.13 - Requested period
... slot 0..* Reference(Slot (model)) C.20.14 - Slot
... patientInstruction 0..* Narrative C.20.15 - Patient instruction
... note 0..* Narrative C.20.16 - Note
... subject 0..1 Reference(Patient (model) | Group (model)) C.20.17 - Subject
... participant 0..* BackboneElement C.20.18 - Participant
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..* CodeableConcept C.20.18.1 - Type
Binding Description (No ValueSet): (preferred): HL7 Participant Type


.... actor 0..1 Reference(Patient (model) | Group (model) | Health professional (model) | Health professional role (model) | Organization (model) | Related person (model) | Device (model)) C.20.18.2 - Actor
.... required 0..1 boolean C.20.18.3 - Required

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSAppointment.statuspreferred
EHDSAppointment.classpreferred
EHDSAppointment.serviceTypepreferred
EHDSAppointment.specialtypreferred
EHDSAppointment.typepreferred
EHDSAppointment.reasonpreferred
EHDSAppointment.prioritypreferred
EHDSAppointment.participant.typepreferred

Constraints

IdGradePath(s)DetailsRequirements
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()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSAppointment 0..* Base Appointment (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 0..* Identifier C.20.1 - Identifier
... status 1..1 CodeableConcept C.20.2 - Status
Binding Description (No ValueSet): (preferred): HL7 Appointment status

... class 0..* CodeableConcept C.20.3 - Class
Binding Description (No ValueSet): (preferred): HL7 Encounter class


... specialty 0..* CodeableConcept C.20.5 - Specialty
Binding Description (No ValueSet): (preferred): SNOMED CT


... type 0..1 CodeableConcept C.20.6 - Type
Binding Description (No ValueSet): (preferred): TBD

... reason 0..* CodeableReference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.7 - Reason
Binding Description (No ValueSet): (preferred): SNOMED CT


... priority 0..1 CodeableConcept C.20.8 - Priority
Binding Description (No ValueSet): (preferred): HL7 Act priority

... description 0..1 Narrative C.20.9 - Description
... supportingInformation 0..* Reference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.10 - Supporting information
... start 0..1 dateTime C.20.11 - Start
... end 0..1 dateTime C.20.12 - End
... requestedPeriod 0..* Period C.20.13 - Requested period
... slot 0..* Reference(Slot (model)) C.20.14 - Slot
... patientInstruction 0..* Narrative C.20.15 - Patient instruction
... note 0..* Narrative C.20.16 - Note
... subject 0..1 Reference(Patient (model) | Group (model)) C.20.17 - Subject
... participant 0..* BackboneElement C.20.18 - Participant
.... type 0..* CodeableConcept C.20.18.1 - Type
Binding Description (No ValueSet): (preferred): HL7 Participant Type


.... actor 0..1 Reference(Patient (model) | Group (model) | Health professional (model) | Health professional role (model) | Organization (model) | Related person (model) | Device (model)) C.20.18.2 - Actor
.... required 0..1 boolean C.20.18.3 - Required

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSAppointment.statuspreferred
EHDSAppointment.classpreferred
EHDSAppointment.serviceTypepreferred
EHDSAppointment.specialtypreferred
EHDSAppointment.typepreferred
EHDSAppointment.reasonpreferred
EHDSAppointment.prioritypreferred
EHDSAppointment.participant.typepreferred

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSAppointment 0..* Base Appointment (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 0..* Identifier C.20.1 - Identifier
... status 1..1 CodeableConcept C.20.2 - Status
Binding Description (No ValueSet): (preferred): HL7 Appointment status

... class 0..* CodeableConcept C.20.3 - Class
Binding Description (No ValueSet): (preferred): HL7 Encounter class


... specialty 0..* CodeableConcept C.20.5 - Specialty
Binding Description (No ValueSet): (preferred): SNOMED CT


... type 0..1 CodeableConcept C.20.6 - Type
Binding Description (No ValueSet): (preferred): TBD

... reason 0..* CodeableReference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.7 - Reason
Binding Description (No ValueSet): (preferred): SNOMED CT


... priority 0..1 CodeableConcept C.20.8 - Priority
Binding Description (No ValueSet): (preferred): HL7 Act priority

... description 0..1 Narrative C.20.9 - Description
... supportingInformation 0..* Reference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.10 - Supporting information
... start 0..1 dateTime C.20.11 - Start
... end 0..1 dateTime C.20.12 - End
... requestedPeriod 0..* Period C.20.13 - Requested period
... slot 0..* Reference(Slot (model)) C.20.14 - Slot
... patientInstruction 0..* Narrative C.20.15 - Patient instruction
... note 0..* Narrative C.20.16 - Note
... subject 0..1 Reference(Patient (model) | Group (model)) C.20.17 - Subject
... participant 0..* BackboneElement C.20.18 - Participant
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..* CodeableConcept C.20.18.1 - Type
Binding Description (No ValueSet): (preferred): HL7 Participant Type


.... actor 0..1 Reference(Patient (model) | Group (model) | Health professional (model) | Health professional role (model) | Organization (model) | Related person (model) | Device (model)) C.20.18.2 - Actor
.... required 0..1 boolean C.20.18.3 - Required

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSAppointment.statuspreferred
EHDSAppointment.classpreferred
EHDSAppointment.serviceTypepreferred
EHDSAppointment.specialtypreferred
EHDSAppointment.typepreferred
EHDSAppointment.reasonpreferred
EHDSAppointment.prioritypreferred
EHDSAppointment.participant.typepreferred

Constraints

IdGradePath(s)DetailsRequirements
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
.. EHDSAppointment 0..* Base Appointment (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 0..* Identifier C.20.1 - Identifier
... status 1..1 CodeableConcept C.20.2 - Status
Binding Description (No ValueSet): (preferred): HL7 Appointment status

... class 0..* CodeableConcept C.20.3 - Class
Binding Description (No ValueSet): (preferred): HL7 Encounter class


... specialty 0..* CodeableConcept C.20.5 - Specialty
Binding Description (No ValueSet): (preferred): SNOMED CT


... type 0..1 CodeableConcept C.20.6 - Type
Binding Description (No ValueSet): (preferred): TBD

... reason 0..* CodeableReference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.7 - Reason
Binding Description (No ValueSet): (preferred): SNOMED CT


... priority 0..1 CodeableConcept C.20.8 - Priority
Binding Description (No ValueSet): (preferred): HL7 Act priority

... description 0..1 Narrative C.20.9 - Description
... supportingInformation 0..* Reference(Condition (model) | Procedure (model) | Observation (model) | Laboratory observation (model)) C.20.10 - Supporting information
... start 0..1 dateTime C.20.11 - Start
... end 0..1 dateTime C.20.12 - End
... requestedPeriod 0..* Period C.20.13 - Requested period
... slot 0..* Reference(Slot (model)) C.20.14 - Slot
... patientInstruction 0..* Narrative C.20.15 - Patient instruction
... note 0..* Narrative C.20.16 - Note
... subject 0..1 Reference(Patient (model) | Group (model)) C.20.17 - Subject
... participant 0..* BackboneElement C.20.18 - Participant
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..* CodeableConcept C.20.18.1 - Type
Binding Description (No ValueSet): (preferred): HL7 Participant Type


.... actor 0..1 Reference(Patient (model) | Group (model) | Health professional (model) | Health professional role (model) | Organization (model) | Related person (model) | Device (model)) C.20.18.2 - Actor
.... required 0..1 boolean C.20.18.3 - Required

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSAppointment.statuspreferred
EHDSAppointment.classpreferred
EHDSAppointment.serviceTypepreferred
EHDSAppointment.specialtypreferred
EHDSAppointment.typepreferred
EHDSAppointment.reasonpreferred
EHDSAppointment.prioritypreferred
EHDSAppointment.participant.typepreferred

Constraints

IdGradePath(s)DetailsRequirements
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()

 

Other representations of profile: CSV, Excel