eHealth Infrastructure
3.4.1 - release
eHealth Infrastructure
3.4.1 - release
eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.4.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-videoappointment | Version: 3.4.1 | |||
| Active as of 2025-03-14 | Computable Name: 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:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management responsible-1: Ensuring that responsible entity is a participating party single-patient-appointment: Only a single patient is allowed pr. appointment |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:endMeetingOnEndTime |
0..1 | boolean | Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:maxParticipants |
0..1 | integer | The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:meetingUrl |
0..1 | uri | Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:vmrUri |
0..1 | uri | Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:guestPinCode |
0..1 | string | Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:hostPinCode |
0..1 | string | Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:responsible |
1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:groupId |
0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:legalBasis |
C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used |
| extension:releasableResource |
0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:responsibleOrganization |
0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:performer |
0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 extension:performingOrganization |
0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 Slices for identifier |
Σ | 0..* | Identifier | External Ids for this item Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
 identifier:vdxMeetingId |
Σ | 0..1 | Identifier | External Ids for this item ele-1: All FHIR elements must have a @value or children |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
 system |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://vdx.medcom.dk/meeting |
| status |
?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
| Slices for serviceType |
Σ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children |
| serviceType:appointmentType |
Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children |
  coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) ele-1: All FHIR elements must have a @value or children |
 code |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: video |
| appointmentType |
Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) ele-1: All FHIR elements must have a @value or children |
| reasonCode |
Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) ele-1: All FHIR elements must have a @value or children |
 supportingInformation |
0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment ele-1: All FHIR elements must have a @value or children | |
| start |
Σ | 1..1 | instant | When appointment is to take place ele-1: All FHIR elements must have a @value or children |
| end |
Σ | 1..1 | instant | When appointment is to conclude ele-1: All FHIR elements must have a @value or children |
 participant |
C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:careteam |
0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| actor |
Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c} | Person, Location/HealthcareService or Device ele-1: All FHIR elements must have a @value or children |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.identifier:vdxMeetingId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.serviceType:appointmentType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetypefrom this IG | |
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codesfrom this IG | |
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reasonfrom this IG | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
| 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) | |
| 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() | |
| single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.4.1 based on FHIR 4.0.1. Generated 2025-03-14
