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
Draft as of 2024-11-13 |
Definitions for the EHDSAppointment logical model.
Guidance on how to interpret the contents of this table can be found here
0. EHDSAppointment | |
Definition | C.20 - EHDS refined base model for Appointment |
Short | Appointment (model) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSAppointment.identifier | |
Definition | Appointment identifier |
Short | C.20.1 - Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
4. EHDSAppointment.status | |
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. |
Short | C.20.2 - Status |
Control | 1..1 |
Binding | HL7 Appointment status |
Type | CodeableConcept |
6. EHDSAppointment.class | |
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. |
Short | C.20.3 - Class |
Control | 0..* |
Binding | HL7 Encounter class |
Type | CodeableConcept |
8. EHDSAppointment.serviceType | |
Definition | The specific service that is to be performed during this appointment |
Short | C.20.4 - Service type |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
10. EHDSAppointment.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment |
Short | C.20.5 - Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
12. EHDSAppointment.type | |
Definition | The type of appointment or patient that has been booked in the slot, e.g. Routine, check-up, walk-in, routine, emenrgency etc. |
Short | C.20.6 - Type |
Control | 0..1 |
Binding | TBD |
Type | CodeableConcept |
14. EHDSAppointment.reason | |
Definition | The reason that this appointment is being scheduled. |
Short | C.20.7 - Reason |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableReference(Condition (model), Procedure (model), Observation (model), Laboratory observation (model)) |
16. EHDSAppointment.priority | |
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. |
Short | C.20.8 - Priority |
Control | 0..1 |
Binding | HL7 Act priority |
Type | CodeableConcept |
18. EHDSAppointment.description | |
Definition | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. |
Short | C.20.9 - Description |
Control | 0..1 |
Type | Narrative |
20. EHDSAppointment.supportingInformation | |
Definition | Additional information to support the appointment provided when making the appointment. |
Short | C.20.10 - Supporting information |
Control | 0..* |
Type | Reference(Condition (model), Procedure (model), Observation (model), Laboratory observation (model), Resource) |
22. EHDSAppointment.start | |
Definition | Date/Time that the appointment is to take place. |
Short | C.20.11 - Start |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. EHDSAppointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Short | C.20.12 - End |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSAppointment.requestedPeriod | |
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. |
Short | C.20.13 - Requested period |
Control | 0..* |
Type | Period |
28. EHDSAppointment.slot | |
Definition | The slots from the participants' schedules that will be filled by the appointment. |
Short | C.20.14 - Slot |
Control | 0..* |
Type | Reference(Slot (model)) |
30. EHDSAppointment.patientInstruction | |
Definition | Patient facing information about the Appointment (e.g. fast from 8pm night before). |
Short | C.20.15 - Patient instruction |
Control | 0..* |
Type | Narrative |
32. EHDSAppointment.note | |
Definition | Additional notes/comments about the appointment. |
Short | C.20.16 - Note |
Control | 0..* |
Type | Narrative |
34. EHDSAppointment.subject | |
Definition | The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element. |
Short | C.20.17 - Subject |
Control | 0..1 |
Type | Reference(Patient (model), Group (model)) |
36. EHDSAppointment.participant | |
Definition | List of participants involved in the appointment. |
Short | C.20.18 - Participant |
Control | 0..* |
Type | Base |
38. EHDSAppointment.participant.type | |
Definition | List of participants involved in the appointment. |
Short | C.20.18.1 - Type |
Control | 0..* |
Binding | HL7 Participant Type |
Type | CodeableConcept |
40. EHDSAppointment.participant.actor | |
Definition | The individual, device, location, or service participating in the appointment. |
Short | C.20.18.2 - Actor |
Control | 0..1 |
Type | Reference(Patient (model), Group (model), Health professional, Health professional, Organization (model), Related person (model), Device (model)) |
42. EHDSAppointment.participant.required | |
Definition | Whether this participant is required to be present at the meeting. |
Short | C.20.18.3 - Required |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. EHDSAppointment | |
Definition | C.20 - EHDS refined base model for Appointment Base definition for all types defined in FHIR type system. |
Short | Appointment (model)Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSAppointment.identifier | |
Definition | Appointment identifier |
Short | C.20.1 - Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
4. EHDSAppointment.status | |
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. |
Short | C.20.2 - Status |
Control | 1..1 |
Binding | HL7 Appointment status |
Type | CodeableConcept |
6. EHDSAppointment.class | |
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. |
Short | C.20.3 - Class |
Control | 0..* |
Binding | HL7 Encounter class |
Type | CodeableConcept |
8. EHDSAppointment.serviceType | |
Definition | The specific service that is to be performed during this appointment |
Short | C.20.4 - Service type |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
10. EHDSAppointment.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment |
Short | C.20.5 - Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
12. EHDSAppointment.type | |
Definition | The type of appointment or patient that has been booked in the slot, e.g. Routine, check-up, walk-in, routine, emenrgency etc. |
Short | C.20.6 - Type |
Control | 0..1 |
Binding | TBD |
Type | CodeableConcept |
14. EHDSAppointment.reason | |
Definition | The reason that this appointment is being scheduled. |
Short | C.20.7 - Reason |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableReference(Condition (model), Procedure (model), Observation (model), Laboratory observation (model)) |
16. EHDSAppointment.priority | |
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. |
Short | C.20.8 - Priority |
Control | 0..1 |
Binding | HL7 Act priority |
Type | CodeableConcept |
18. EHDSAppointment.description | |
Definition | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. |
Short | C.20.9 - Description |
Control | 0..1 |
Type | Narrative |
20. EHDSAppointment.supportingInformation | |
Definition | Additional information to support the appointment provided when making the appointment. |
Short | C.20.10 - Supporting information |
Control | 0..* |
Type | Reference(Condition (model), Procedure (model), Observation (model), Laboratory observation (model), Resource) |
22. EHDSAppointment.start | |
Definition | Date/Time that the appointment is to take place. |
Short | C.20.11 - Start |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. EHDSAppointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Short | C.20.12 - End |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSAppointment.requestedPeriod | |
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. |
Short | C.20.13 - Requested period |
Control | 0..* |
Type | Period |
28. EHDSAppointment.slot | |
Definition | The slots from the participants' schedules that will be filled by the appointment. |
Short | C.20.14 - Slot |
Control | 0..* |
Type | Reference(Slot (model)) |
30. EHDSAppointment.patientInstruction | |
Definition | Patient facing information about the Appointment (e.g. fast from 8pm night before). |
Short | C.20.15 - Patient instruction |
Control | 0..* |
Type | Narrative |
32. EHDSAppointment.note | |
Definition | Additional notes/comments about the appointment. |
Short | C.20.16 - Note |
Control | 0..* |
Type | Narrative |
34. EHDSAppointment.subject | |
Definition | The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element. |
Short | C.20.17 - Subject |
Control | 0..1 |
Type | Reference(Patient (model), Group (model)) |
36. EHDSAppointment.participant | |
Definition | List of participants involved in the appointment. |
Short | C.20.18 - Participant |
Control | 0..* |
Type | Base |
38. EHDSAppointment.participant.type | |
Definition | List of participants involved in the appointment. |
Short | C.20.18.1 - Type |
Control | 0..* |
Binding | HL7 Participant Type |
Type | CodeableConcept |
40. EHDSAppointment.participant.actor | |
Definition | The individual, device, location, or service participating in the appointment. |
Short | C.20.18.2 - Actor |
Control | 0..1 |
Type | Reference(Patient (model), Group (model), Health professional, Health professional, Organization (model), Related person (model), Device (model)) |
42. EHDSAppointment.participant.required | |
Definition | Whether this participant is required to be present at the meeting. |
Short | C.20.18.3 - Required |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. EHDSAppointment | |
Definition | C.20 - EHDS refined base model for Appointment |
Short | Appointment (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSAppointment.identifier | |
Definition | Appointment identifier |
Short | C.20.1 - Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
4. EHDSAppointment.status | |
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. |
Short | C.20.2 - Status |
Control | 1..1 |
Binding | HL7 Appointment status |
Type | CodeableConcept |
6. EHDSAppointment.class | |
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. |
Short | C.20.3 - Class |
Control | 0..* |
Binding | HL7 Encounter class |
Type | CodeableConcept |
8. EHDSAppointment.serviceType | |
Definition | The specific service that is to be performed during this appointment |
Short | C.20.4 - Service type |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
10. EHDSAppointment.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment |
Short | C.20.5 - Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
12. EHDSAppointment.type | |
Definition | The type of appointment or patient that has been booked in the slot, e.g. Routine, check-up, walk-in, routine, emenrgency etc. |
Short | C.20.6 - Type |
Control | 0..1 |
Binding | TBD |
Type | CodeableConcept |
14. EHDSAppointment.reason | |
Definition | The reason that this appointment is being scheduled. |
Short | C.20.7 - Reason |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableReference(Condition (model), Procedure (model), Observation (model), Laboratory observation (model)) |
16. EHDSAppointment.priority | |
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. |
Short | C.20.8 - Priority |
Control | 0..1 |
Binding | HL7 Act priority |
Type | CodeableConcept |
18. EHDSAppointment.description | |
Definition | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. |
Short | C.20.9 - Description |
Control | 0..1 |
Type | Narrative |
20. EHDSAppointment.supportingInformation | |
Definition | Additional information to support the appointment provided when making the appointment. |
Short | C.20.10 - Supporting information |
Control | 0..* |
Type | Reference(Condition (model), Procedure (model), Observation (model), Laboratory observation (model), Resource) |
22. EHDSAppointment.start | |
Definition | Date/Time that the appointment is to take place. |
Short | C.20.11 - Start |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. EHDSAppointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Short | C.20.12 - End |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSAppointment.requestedPeriod | |
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. |
Short | C.20.13 - Requested period |
Control | 0..* |
Type | Period |
28. EHDSAppointment.slot | |
Definition | The slots from the participants' schedules that will be filled by the appointment. |
Short | C.20.14 - Slot |
Control | 0..* |
Type | Reference(Slot (model)) |
30. EHDSAppointment.patientInstruction | |
Definition | Patient facing information about the Appointment (e.g. fast from 8pm night before). |
Short | C.20.15 - Patient instruction |
Control | 0..* |
Type | Narrative |
32. EHDSAppointment.note | |
Definition | Additional notes/comments about the appointment. |
Short | C.20.16 - Note |
Control | 0..* |
Type | Narrative |
34. EHDSAppointment.subject | |
Definition | The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element. |
Short | C.20.17 - Subject |
Control | 0..1 |
Type | Reference(Patient (model), Group (model)) |
36. EHDSAppointment.participant | |
Definition | List of participants involved in the appointment. |
Short | C.20.18 - Participant |
Control | 0..* |
Type | Base |
38. EHDSAppointment.participant.type | |
Definition | List of participants involved in the appointment. |
Short | C.20.18.1 - Type |
Control | 0..* |
Binding | HL7 Participant Type |
Type | CodeableConcept |
40. EHDSAppointment.participant.actor | |
Definition | The individual, device, location, or service participating in the appointment. |
Short | C.20.18.2 - Actor |
Control | 0..1 |
Type | Reference(Patient (model), Group (model), Health professional, Health professional, Organization (model), Related person (model), Device (model)) |
42. EHDSAppointment.participant.required | |
Definition | Whether this participant is required to be present at the meeting. |
Short | C.20.18.3 - Required |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |