eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions
Defining URL: | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-videoappointment |
Version: | 2022.1 |
Name: | ehealth-videoappointment |
Status: | Active as of 1/18/22, 9:57 AM |
Publisher: | Systematic | Trifork |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-videoappointment
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Appointment.language | preferred | CommonLanguages Max Binding: AllLanguages |
Appointment.identifier:vdxMeetingId.use | required | IdentifierUse |
Appointment.identifier:vdxMeetingId.type | extensible | Identifier Type Codes |
Appointment.status | required | AppointmentStatus |
Appointment.cancelationReason | example | AppointmentCancellationReason |
Appointment.serviceCategory | example | ServiceCategory |
Appointment.serviceType | example | ServiceType |
Appointment.serviceType:appointmentType | example | ServiceType |
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType |
Appointment.specialty | preferred | PracticeSettingCodeValueSet |
Appointment.appointmentType | required | AppointmentTypeCodes |
Appointment.reasonCode | required | AppointmentReason |
Appointment.participant.type | extensible | ParticipantType |
Appointment.participant.required | required | ParticipantRequired |
Appointment.participant.status | required | ParticipationStatus |
Id | Grade | Path | Details | Requirements |
responsible-1 | error | 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 | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 | |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() |