eHealth Infrastructure (v2020.7)
An Appointment is a booking of a healthcare event among ehealth patients, practitioners, related persons, and locations. This may be either a physical or virtual meeting. Even though a meeting may span a number of participants, only one physical Appointment resource must be created. Participant status (approved, declined etc.) is handled using the AppointmentResponse resource, which in turn updates the status of the participant on the appointment resource.
The most important fields of the ehealth-appointment are described below:
description: The “subject” of the appointment (textual description).
comment: Free text description of the appointment to take place.
participants: A list of participants invited to the meeting. These may be of type Patient, Practitioner, RelatedPerson, and Location. At least two participants are required. Each participant has a status, which may only be updated by creating an AppointmentResponse. In that case, the status on the Appointment will be updated with the participantStatus sent in the response.
start/end: the start and end time of when the appointment is to take place.
ehealth-responsible (extension): the responsible individual, care team and/or organization for the meeting.
appointmentType: the type of appointment booked (checkup, emergency, followup etc).
If other resources need to be referenced as part of the appointment, it is possible to reference Condition and Procedure resources as the reason for the meeting, or using “supportingInformation” to reference other resource types. The “group-id” extension can be used for logically grouping different appointments.
In the eHealth Infrastructure the Appointment resource is used in conjunction with the following resources:
The following rules apply to ehealth-appointment resources, given the appointment contains a participant of type Patient, who allows reception of NemSMS (has telecom with value ‘NemSMS’):
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment
This profile models an ehealth appointment. It is only necessary to create one appointment even though it spans more than one participant. Allowed appointment participants are patients, practitioners, relatedpersons, and locations
This profile builds on Appointment.
This profile was published on Tue Oct 27 14:11:48 UTC 2020 as a draft by ehealth.sundhed.dk.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Path | Conformance | ValueSet |
| Appointment.language | extensible | Common Languages Max Binding: All Languages |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceCategory | example | ServiceCategory |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | preferred | Practice Setting Code Value Set |
| Appointment.appointmentType | extensible | AppointmentTypeCodes |
| Appointment.reason | required | AppointmentReason |
| Appointment.reason.coding | required | AppointmentReason |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.required | required | ParticipantRequired |
| Appointment.participant.status | required | ParticipationStatus |
| Id | Path | Details | Requirements |
| dom-2 | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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-3 | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| app-3 | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')) | |
| app-2 | Appointment | Either start and end are specified, or neither : start.empty() xor end.exists() | |
| responsible-1 | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
| single-patient-appointment | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 | |
| ele-1 | Appointment.extension:responsible | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:responsible | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:groupId | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:groupId | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:legalBasis | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:legalBasis | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| governance-1 | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
| responsible-2 | Appointment.extension:legalBasis | Both performer and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
| ele-1 | Appointment.extension:releasableResource | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:releasableResource | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:responsible-organization | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:responsible-organization | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:performing-organization | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:performing-organization | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.participant | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| app-1 | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| ele-1 | Appointment.participant.extension:careteam | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.participant.extension:careteam | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
extension
appointmentType
indication
