{
"description": "C.20 - EHDS refined base model for Appointment",
"_filename": "StructureDefinition-EHDSAppointment.json",
"package_name": "hl7.fhir.eu.imaging-r5",
"date": "2025-03-21T08:17:12+00:00",
"derivation": "specialization",
"publisher": "HL7 Europe",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "150",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "Europe"
} ]
} ],
"name": "EHDSAppointment",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"copyright": "Used by permission of HL7 Europe, all rights reserved Creative Commons License",
"type": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAppointment",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Appointment model",
"package_version": "0.1.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
} ],
"snapshot": {
"element": [ {
"path": "EHDSAppointment",
"min": 0,
"definition": "C.20 - EHDS refined base model for Appointment",
"isModifier": false,
"short": "Appointment model",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "*",
"id": "EHDSAppointment",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"id": "EHDSAppointment.identifier",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.identifier"
},
"path": "EHDSAppointment.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "C.20.1 - Identifier",
"definition": "Appointment identifier"
}, {
"path": "EHDSAppointment.status",
"min": 1,
"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",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "HL7 Appointment status"
},
"max": "1",
"id": "EHDSAppointment.status",
"base": {
"max": "1",
"min": 1,
"path": "EHDSAppointment.status"
}
}, {
"path": "EHDSAppointment.class",
"min": 0,
"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",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "HL7 Encounter class"
},
"max": "*",
"id": "EHDSAppointment.class",
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.class"
}
}, {
"path": "EHDSAppointment.serviceType",
"min": 0,
"definition": "The specific service that is to be performed during this appointment",
"short": "C.20.4 - Service type",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "SNOMED CT"
},
"max": "*",
"id": "EHDSAppointment.serviceType",
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.serviceType"
}
}, {
"path": "EHDSAppointment.specialty",
"min": 0,
"definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"short": "C.20.5 - Specialty",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "SNOMED CT"
},
"max": "*",
"id": "EHDSAppointment.specialty",
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.specialty"
}
}, {
"path": "EHDSAppointment.type",
"min": 0,
"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",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "TBD"
},
"max": "1",
"id": "EHDSAppointment.type",
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.type"
}
}, {
"path": "EHDSAppointment.reason",
"min": 0,
"definition": "The reason that this appointment is being scheduled.",
"short": "C.20.7 - Reason",
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSCondition", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSProcedure", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSObservation", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation" ]
} ],
"binding": {
"strength": "preferred",
"description": "SNOMED CT"
},
"max": "*",
"id": "EHDSAppointment.reason",
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.reason"
}
}, {
"path": "EHDSAppointment.priority",
"min": 0,
"definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments.",
"short": "C.20.8 - Priority",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "HL7 Act priority"
},
"max": "1",
"id": "EHDSAppointment.priority",
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.priority"
}
}, {
"id": "EHDSAppointment.description",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.description"
},
"path": "EHDSAppointment.description",
"type": [ {
"code": "Narrative"
} ],
"short": "C.20.9 - Description",
"definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list."
}, {
"id": "EHDSAppointment.supportingInformation",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.supportingInformation"
},
"path": "EHDSAppointment.supportingInformation",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSCondition", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSProcedure", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSObservation", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation", "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "C.20.10 - Supporting information",
"definition": "Additional information to support the appointment provided when making the appointment."
}, {
"id": "EHDSAppointment.start",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.start"
},
"path": "EHDSAppointment.start",
"type": [ {
"code": "dateTime"
} ],
"short": "C.20.11 - Start",
"definition": "Date/Time that the appointment is to take place."
}, {
"id": "EHDSAppointment.end",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.end"
},
"path": "EHDSAppointment.end",
"type": [ {
"code": "dateTime"
} ],
"short": "C.20.12 - End",
"definition": "Date/Time that the appointment is to conclude."
}, {
"id": "EHDSAppointment.requestedPeriod",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.requestedPeriod"
},
"path": "EHDSAppointment.requestedPeriod",
"type": [ {
"code": "Period"
} ],
"short": "C.20.13 - Requested period",
"definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within."
}, {
"id": "EHDSAppointment.slot",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.slot"
},
"path": "EHDSAppointment.slot",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSSlot" ]
} ],
"short": "C.20.14 - Slot",
"definition": "The slots from the participants' schedules that will be filled by the appointment."
}, {
"id": "EHDSAppointment.patientInstruction",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.patientInstruction"
},
"path": "EHDSAppointment.patientInstruction",
"type": [ {
"code": "Narrative"
} ],
"short": "C.20.15 - Patient instruction",
"definition": "Patient facing information about the Appointment (e.g. fast from 8pm night before)."
}, {
"id": "EHDSAppointment.note",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.note"
},
"path": "EHDSAppointment.note",
"type": [ {
"code": "Narrative"
} ],
"short": "C.20.16 - Note",
"definition": "Additional notes/comments about the appointment."
}, {
"id": "EHDSAppointment.subject",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.subject"
},
"path": "EHDSAppointment.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSGroup" ]
} ],
"short": "C.20.17 - 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."
}, {
"id": "EHDSAppointment.participant",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.participant"
},
"path": "EHDSAppointment.participant",
"type": [ {
"code": "Base"
} ],
"short": "C.20.18 - Participant",
"definition": "List of participants involved in the appointment."
}, {
"path": "EHDSAppointment.participant.type",
"min": 0,
"definition": "List of participants involved in the appointment.",
"short": "C.20.18.1 - Type",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "HL7 Participant Type"
},
"max": "*",
"id": "EHDSAppointment.participant.type",
"base": {
"max": "*",
"min": 0,
"path": "EHDSAppointment.participant.type"
}
}, {
"id": "EHDSAppointment.participant.actor",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.participant.actor"
},
"path": "EHDSAppointment.participant.actor",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSGroup", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSRelatedPerson", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice" ]
} ],
"short": "C.20.18.2 - Actor",
"definition": "The individual, device, location, or service participating in the appointment."
}, {
"id": "EHDSAppointment.participant.required",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSAppointment.participant.required"
},
"path": "EHDSAppointment.participant.required",
"type": [ {
"code": "boolean"
} ],
"short": "C.20.18.3 - Required",
"definition": "Whether this participant is required to be present at the meeting."
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
} ]
},
"status": "draft",
"id": "456982c9-5657-42cf-846e-451ada8b77a3",
"kind": "logical",
"url": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAppointment",
"version": "0.1.0",
"differential": {
"element": [ {
"id": "EHDSAppointment",
"path": "EHDSAppointment",
"short": "Appointment model",
"definition": "C.20 - EHDS refined base model for Appointment"
}, {
"id": "EHDSAppointment.identifier",
"max": "*",
"min": 0,
"path": "EHDSAppointment.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "C.20.1 - Identifier",
"definition": "Appointment identifier"
}, {
"id": "EHDSAppointment.status",
"max": "1",
"min": 1,
"path": "EHDSAppointment.status",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.2 - Status",
"binding": {
"strength": "preferred",
"description": "HL7 Appointment 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."
}, {
"id": "EHDSAppointment.class",
"max": "*",
"min": 0,
"path": "EHDSAppointment.class",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.3 - Class",
"binding": {
"strength": "preferred",
"description": "HL7 Encounter class"
},
"definition": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations."
}, {
"id": "EHDSAppointment.serviceType",
"max": "*",
"min": 0,
"path": "EHDSAppointment.serviceType",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.4 - Service type",
"binding": {
"strength": "preferred",
"description": "SNOMED CT"
},
"definition": "The specific service that is to be performed during this appointment"
}, {
"id": "EHDSAppointment.specialty",
"max": "*",
"min": 0,
"path": "EHDSAppointment.specialty",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.5 - Specialty",
"binding": {
"strength": "preferred",
"description": "SNOMED CT"
},
"definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment"
}, {
"id": "EHDSAppointment.type",
"max": "1",
"min": 0,
"path": "EHDSAppointment.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.6 - Type",
"binding": {
"strength": "preferred",
"description": "TBD"
},
"definition": "The type of appointment or patient that has been booked in the slot, e.g. Routine, check-up, walk-in, routine, emenrgency etc."
}, {
"id": "EHDSAppointment.reason",
"max": "*",
"min": 0,
"path": "EHDSAppointment.reason",
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSCondition", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSProcedure", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSObservation", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation" ]
} ],
"short": "C.20.7 - Reason",
"binding": {
"strength": "preferred",
"description": "SNOMED CT"
},
"definition": "The reason that this appointment is being scheduled."
}, {
"id": "EHDSAppointment.priority",
"max": "1",
"min": 0,
"path": "EHDSAppointment.priority",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.8 - Priority",
"binding": {
"strength": "preferred",
"description": "HL7 Act priority"
},
"definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. "
}, {
"id": "EHDSAppointment.description",
"max": "1",
"min": 0,
"path": "EHDSAppointment.description",
"type": [ {
"code": "Narrative"
} ],
"short": "C.20.9 - Description",
"definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list."
}, {
"id": "EHDSAppointment.supportingInformation",
"max": "*",
"min": 0,
"path": "EHDSAppointment.supportingInformation",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSCondition", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSProcedure", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSObservation", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation", "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "C.20.10 - Supporting information",
"definition": "Additional information to support the appointment provided when making the appointment."
}, {
"id": "EHDSAppointment.start",
"max": "1",
"min": 0,
"path": "EHDSAppointment.start",
"type": [ {
"code": "dateTime"
} ],
"short": "C.20.11 - Start",
"definition": "Date/Time that the appointment is to take place."
}, {
"id": "EHDSAppointment.end",
"max": "1",
"min": 0,
"path": "EHDSAppointment.end",
"type": [ {
"code": "dateTime"
} ],
"short": "C.20.12 - End",
"definition": "Date/Time that the appointment is to conclude."
}, {
"id": "EHDSAppointment.requestedPeriod",
"max": "*",
"min": 0,
"path": "EHDSAppointment.requestedPeriod",
"type": [ {
"code": "Period"
} ],
"short": "C.20.13 - Requested period",
"definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within."
}, {
"id": "EHDSAppointment.slot",
"max": "*",
"min": 0,
"path": "EHDSAppointment.slot",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSSlot" ]
} ],
"short": "C.20.14 - Slot",
"definition": "The slots from the participants' schedules that will be filled by the appointment."
}, {
"id": "EHDSAppointment.patientInstruction",
"max": "*",
"min": 0,
"path": "EHDSAppointment.patientInstruction",
"type": [ {
"code": "Narrative"
} ],
"short": "C.20.15 - Patient instruction",
"definition": "Patient facing information about the Appointment (e.g. fast from 8pm night before)."
}, {
"id": "EHDSAppointment.note",
"max": "*",
"min": 0,
"path": "EHDSAppointment.note",
"type": [ {
"code": "Narrative"
} ],
"short": "C.20.16 - Note",
"definition": "Additional notes/comments about the appointment."
}, {
"id": "EHDSAppointment.subject",
"max": "1",
"min": 0,
"path": "EHDSAppointment.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSGroup" ]
} ],
"short": "C.20.17 - 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."
}, {
"id": "EHDSAppointment.participant",
"max": "*",
"min": 0,
"path": "EHDSAppointment.participant",
"type": [ {
"code": "Base"
} ],
"short": "C.20.18 - Participant",
"definition": "List of participants involved in the appointment."
}, {
"id": "EHDSAppointment.participant.type",
"max": "*",
"min": 0,
"path": "EHDSAppointment.participant.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "C.20.18.1 - Type",
"binding": {
"strength": "preferred",
"description": "HL7 Participant Type"
},
"definition": "List of participants involved in the appointment."
}, {
"id": "EHDSAppointment.participant.actor",
"max": "1",
"min": 0,
"path": "EHDSAppointment.participant.actor",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSGroup", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSRelatedPerson", "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice" ]
} ],
"short": "C.20.18.2 - Actor",
"definition": "The individual, device, location, or service participating in the appointment."
}, {
"id": "EHDSAppointment.participant.required",
"max": "1",
"min": 0,
"path": "EHDSAppointment.participant.required",
"type": [ {
"code": "boolean"
} ],
"short": "C.20.18.3 - Required",
"definition": "Whether this participant is required to be present at the meeting."
} ]
},
"contact": [ {
"name": "Xt-EHR",
"telecom": [ {
"value": "http://Xt-EHR.eu",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}