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 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 Fri May 22 12:11:22 UTC 2020 as a draft by ehealth.sundhed.dk.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Appointment
Summary
Mandatory: 5 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 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). videoresponsible-2: Ensuring that responsible entity is a participating party single-patient-videoappointment: Only a single patient is allowed pr. video appointment |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time | |
ehealth-max-participants | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants | |
ehealth-meeting-url | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
ehealth-vmr-uri | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
ehealth-guest-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
ehealth-host-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
ehealth-responsible | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
value[x]:valueReference | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Value of extension | |
ehealth-group-id | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis governance-2: When extension is used a Episode of Care MUST be referenced responsible-3: Both performer and responsible organization must be populated when legal basis is used |
valueCodeableConcept:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Jurisdiction (required) | |
ehealth-releasableResource | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
ehealth-performer | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
valueReference:valueReference | 0..1 | Reference(eHealth Organization) {r} | Value of extension | |
ehealth-responsible-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
identifier | 0..* | (Slice Definition) | External Ids for this item Slice: Unordered, Open by value:system | |
identifier:vdxMeetingId | 0..1 | Identifier | Identifies the FHIR id of the booked VDX meeting resource | |
system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://vdx.medcom.dk/meeting | |
appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) | |
reason | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) | |
coding | 0..* | Coding | Code defined by a terminology system Binding: Appointment Reason (required) | |
indication | 0..* | Reference(Condition | Procedure) {r} | Reason the appointment is to takes place (resource) | |
description | 1..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | 1..1 | instant | When appointment is to take place | |
end | 1..1 | instant | When appointment is to conclude | |
slot | 0..* | Reference(Slot) {r} | The slots that this appointment is filling | |
incomingReferral | 0..* | Reference(ReferralRequest) {r} | The ReferralRequest provided as information to allocate to the Encounter | |
participant | 2..* | BackboneElement | Participants involved in appointment | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | 0..1 | Reference() | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
actor | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device | |
Documentation for this format |
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 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). videoresponsible-2: Ensuring that responsible entity is a participating party single-patient-videoappointment: Only a single patient is allowed pr. video appointment |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | I | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time |
ehealth-max-participants | I | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants |
ehealth-meeting-url | I | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url |
ehealth-vmr-uri | I | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri |
ehealth-guest-pin-code | I | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code |
ehealth-host-pin-code | I | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code |
ehealth-responsible | I | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible" | |
value[x]:valueReference | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Value of extension | |
ehealth-group-id | I | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis governance-2: When extension is used a Episode of Care MUST be referenced responsible-3: Both performer and responsible organization must be populated when legal basis is used |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis" | |
value[x] | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Jurisdiction (required) | |
ehealth-releasableResource | I | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource |
ehealth-performer | I | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer" | |
value[x]:valueReference | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueReference | 0..1 | Reference(eHealth Organization) {r} | Value of extension | |
ehealth-responsible-organization | I | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | (Slice Definition) | External Ids for this item Slice: Unordered, Open by value:system |
identifier:vdxMeetingId | Σ | 0..1 | Identifier | Identifies the FHIR id of the booked VDX meeting resource |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://vdx.medcom.dk/meeting |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error Binding: AppointmentStatus (required) |
serviceCategory | Σ | 0..1 | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Practice Setting Code Value Set (preferred) |
appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) |
reason | Σ | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Reason (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
indication | 0..* | Reference(Condition | Procedure) {r} | Reason the appointment is to takes place (resource) | |
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |
description | 1..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | Σ | 1..1 | instant | When appointment is to take place |
end | Σ | 1..1 | instant | When appointment is to conclude |
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
slot | 0..* | Reference(Slot) {r} | The slots that this appointment is filling | |
created | 0..1 | dateTime | The date that this appointment was initially created | |
comment | 0..1 | string | Additional comments | |
incomingReferral | 0..* | Reference(ReferralRequest) {r} | The ReferralRequest provided as information to allocate to the Encounter | |
participant | I | 2..* | BackboneElement | Participants involved in appointment |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | I | 0..1 | Reference() | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible) |
actor | Σ | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device |
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required) |
status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) | |
requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
Documentation for this format |
This structure is derived from Appointment
Summary
Mandatory: 5 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 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). videoresponsible-2: Ensuring that responsible entity is a participating party single-patient-videoappointment: Only a single patient is allowed pr. video appointment |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time | |
ehealth-max-participants | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants | |
ehealth-meeting-url | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
ehealth-vmr-uri | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
ehealth-guest-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
ehealth-host-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
ehealth-responsible | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
value[x]:valueReference | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Value of extension | |
ehealth-group-id | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis governance-2: When extension is used a Episode of Care MUST be referenced responsible-3: Both performer and responsible organization must be populated when legal basis is used |
valueCodeableConcept:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Jurisdiction (required) | |
ehealth-releasableResource | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
ehealth-performer | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
valueReference:valueReference | 0..1 | Reference(eHealth Organization) {r} | Value of extension | |
ehealth-responsible-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
identifier | 0..* | (Slice Definition) | External Ids for this item Slice: Unordered, Open by value:system | |
identifier:vdxMeetingId | 0..1 | Identifier | Identifies the FHIR id of the booked VDX meeting resource | |
system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://vdx.medcom.dk/meeting | |
appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) | |
reason | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) | |
coding | 0..* | Coding | Code defined by a terminology system Binding: Appointment Reason (required) | |
indication | 0..* | Reference(Condition | Procedure) {r} | Reason the appointment is to takes place (resource) | |
description | 1..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | 1..1 | instant | When appointment is to take place | |
end | 1..1 | instant | When appointment is to conclude | |
slot | 0..* | Reference(Slot) {r} | The slots that this appointment is filling | |
incomingReferral | 0..* | Reference(ReferralRequest) {r} | The ReferralRequest provided as information to allocate to the Encounter | |
participant | 2..* | BackboneElement | Participants involved in appointment | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | 0..1 | Reference() | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
actor | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 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). videoresponsible-2: Ensuring that responsible entity is a participating party single-patient-videoappointment: Only a single patient is allowed pr. video appointment |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | I | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time |
ehealth-max-participants | I | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants |
ehealth-meeting-url | I | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url |
ehealth-vmr-uri | I | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri |
ehealth-guest-pin-code | I | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code |
ehealth-host-pin-code | I | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code |
ehealth-responsible | I | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible" | |
value[x]:valueReference | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Value of extension | |
ehealth-group-id | I | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis governance-2: When extension is used a Episode of Care MUST be referenced responsible-3: Both performer and responsible organization must be populated when legal basis is used |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis" | |
value[x] | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Jurisdiction (required) | |
ehealth-releasableResource | I | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource |
ehealth-performer | I | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer" | |
value[x]:valueReference | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueReference | 0..1 | Reference(eHealth Organization) {r} | Value of extension | |
ehealth-responsible-organization | I | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | (Slice Definition) | External Ids for this item Slice: Unordered, Open by value:system |
identifier:vdxMeetingId | Σ | 0..1 | Identifier | Identifies the FHIR id of the booked VDX meeting resource |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://vdx.medcom.dk/meeting |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error Binding: AppointmentStatus (required) |
serviceCategory | Σ | 0..1 | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Practice Setting Code Value Set (preferred) |
appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) |
reason | Σ | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Reason (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
indication | 0..* | Reference(Condition | Procedure) {r} | Reason the appointment is to takes place (resource) | |
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |
description | 1..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | Σ | 1..1 | instant | When appointment is to take place |
end | Σ | 1..1 | instant | When appointment is to conclude |
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
slot | 0..* | Reference(Slot) {r} | The slots that this appointment is filling | |
created | 0..1 | dateTime | The date that this appointment was initially created | |
comment | 0..1 | string | Additional comments | |
incomingReferral | 0..* | Reference(ReferralRequest) {r} | The ReferralRequest provided as information to allocate to the Encounter | |
participant | I | 2..* | BackboneElement | Participants involved in appointment |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | I | 0..1 | Reference() | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible) |
actor | Σ | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device |
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required) |
status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) | |
requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
Documentation for this format |
Path | Conformance | ValueSet |
Appointment.language | extensible | Common Languages Max Binding: All Languages |
Appointment.extension:legalBasis.value[x]:valueCodeableConcept | required | Jurisdiction |
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() |