eHealth Infrastructure (v2020.7)
A video appointment is a booking of a healthcare event among ehealth patients, practitioners, related persons, and locations. Even though a meeting may span a number of participants, only one physical video 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 video appointment resource.
Certain data on a video appointment will be provided by the service itself when the video appointment is created, such as the meeting PIN code and the URL at which the meeting takes place. This means that the client must consider the service response instead of just the create request itself, and that the client cannot itself decide the meeting URL or the PIN code, which is defined in the scheduling template.
The URL to the video appointment is accessible 15 minutes (currently fixed) before the meeting starts.
The most important fields of the ehealth-videoappointment are described below:
description: The “subject” of the video appointment (textual description).
comment: Free text description of the video 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 (both required for video appointments).
ehealth-responsible (extension): the responsible individual, care team and/or organization for the meeting.
appointmentType: the type of appointment booked (checkup, emergency, followup etc).
end-meeting-on-end-time (extension): Indicates if the meeting must be terminated at end time.
max-participants (extension): The maximum number of participants allowed in the video meeting.
meeting-url (extension): the URL used to attend the meeting (provided by the service, not the client).
vmr-uri (extension): the Virtual Meeting Room URI that can be used in eg. webRTC clients.
guest pinCode (extension): The guest pin code to be used when entering the meeting (is provided by the service itself based on the scheduling template used).
host pinCode (extension): The host pin code to be used when entering the meeting (is provided by the service itself based on the scheduling template used). If no host attends, the meeting is not started
If other resources need to be referenced as part of the video 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 official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-videoappointment
This profile models an ehealth video 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.identifier:vdxMeetingId.use | required | IdentifierUse |
| Appointment.identifier:vdxMeetingId.type | extensible | Identifier Type Codes |
| 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 | preferred | 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() | |
| videoresponsible-2 | 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-videoappointment | Appointment | Only a single patient is allowed pr. video appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 | |
| ele-1 | Appointment.extension:endMeetingOnEndTime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:endMeetingOnEndTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:maxParticipants | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:maxParticipants | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:meetingURL | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:meetingURL | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:vmrUri | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:vmrUri | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:guestPinCode | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:guestPinCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Appointment.extension:hostPinCode | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Appointment.extension:hostPinCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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-2 | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
| responsible-3 | 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: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.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.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
system
indication
