eHealth Infrastructure
2.9.0 - release
eHealth Infrastructure
2.9.0 - release
eHealth Infrastructure - Local Development build (v2.9.0). See the Directory of published versions
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-videoappointment | Version: 2.9.0 | |||
| Active as of 2023-08-23 | 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.
This structure is derived from Appointment
| Path | Conformance | ValueSet |
| Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types) |
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes) |
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason) |
| 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 |
| 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) 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 |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 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 | |
| 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 | |
| meetingUrl | 0..1 | uri | Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
| vmrUri | 0..1 | uri | Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
| guestPinCode | 0..1 | string | Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
| hostPinCode | 0..1 | string | Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
| responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
| 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 | |
| legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) 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 |
| releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
| responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
| performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
| 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 | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier | Σ | 0..* | Identifier | External Ids for this item Slice: Unordered, Open by value:system |
  identifier:vdxMeetingId | Σ | 0..1 | Identifier | External Ids for this item |
  use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 system | Σ | 1..1 | uri | The namespace for the identifier value 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. |
| 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) |
| serviceType:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
  coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) |
 code | Σ | 1..1 | code | Symbol in syntax defined by the system 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) |
| reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) |
 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 |
 participant | C | 1..* | BackboneElement | Participants involved in appointment |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c} | Person, Location/HealthcareService or Device |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.identifier:vdxMeetingId.use | required | IdentifierUse |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceType | example | ServiceType |
| Appointment.serviceType:appointmentType | example | ServiceType |
| Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types) |
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes) |
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason) |
| Appointment.participant.status | required | ParticipationStatus |
| 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 |
| 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) responsible-1: Ensuring that responsible entity is a participating party single-patient-appointment: Only a single patient is allowed pr. 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| 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 | |||||
| meetingUrl | 0..1 | uri | Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |||||
| vmrUri | 0..1 | uri | Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |||||
| guestPinCode | 0..1 | string | Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |||||
| hostPinCode | 0..1 | string | Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |||||
| responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |||||
| 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 | |||||
| legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) 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 | ||||
| releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |||||
| responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |||||
| performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |||||
| 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 | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | Identifier | External Ids for this item Slice: Unordered, Open by value:system | ||||
| identifier:vdxMeetingId | Σ | 0..1 | Identifier | External Ids for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..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 | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| 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) | ||||
| serviceType:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 Service Type (required) | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: video | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (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 (required) | ||||
| reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | ||||
| reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
| priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
| description | 0..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) | 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 | |||||
| patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| participant | C | 1..* | BackboneElement | Participants involved in appointment | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c} | Person, Location/HealthcareService or Device | ||||
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period | 0..1 | Period | Participation period of the actor | |||||
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| 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 (a valid code from Appointment Service Types) | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes) | ||||
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason) | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
| 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-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() |
This structure is derived from Appointment
Summary
Mandatory: 7 elements (2 nested mandatory elements)
Fixed Value: 2 elements
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
| Path | Conformance | ValueSet |
| Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types) |
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes) |
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason) |
| 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 |
Key Elements View
| 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) 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 |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| 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 | |
| meetingUrl | 0..1 | uri | Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
| vmrUri | 0..1 | uri | Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
| guestPinCode | 0..1 | string | Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
| hostPinCode | 0..1 | string | Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
| responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
| 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 | |
| legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) 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 |
| releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
| responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
| performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
| 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 | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | External Ids for this item Slice: Unordered, Open by value:system |
| identifier:vdxMeetingId | Σ | 0..1 | Identifier | External Ids for this item |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value 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. |
| 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) |
| serviceType:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system 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) |
| reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) |
| 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 |
| participant | C | 1..* | BackboneElement | Participants involved in appointment |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c} | Person, Location/HealthcareService or Device |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.identifier:vdxMeetingId.use | required | IdentifierUse |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceType | example | ServiceType |
| Appointment.serviceType:appointmentType | example | ServiceType |
| Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types) |
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes) |
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason) |
| Appointment.participant.status | required | ParticipationStatus |
| 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 |
Snapshot View
| 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) responsible-1: Ensuring that responsible entity is a participating party single-patient-appointment: Only a single patient is allowed pr. 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| 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 | |||||
| meetingUrl | 0..1 | uri | Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |||||
| vmrUri | 0..1 | uri | Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |||||
| guestPinCode | 0..1 | string | Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |||||
| hostPinCode | 0..1 | string | Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |||||
| responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |||||
| 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 | |||||
| legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) 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 | ||||
| releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |||||
| responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |||||
| performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |||||
| 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 | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | Identifier | External Ids for this item Slice: Unordered, Open by value:system | ||||
| identifier:vdxMeetingId | Σ | 0..1 | Identifier | External Ids for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..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 | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| 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) | ||||
| serviceType:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 Service Type (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: video | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (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 (required) | ||||
| reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | ||||
| reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
| priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
| description | 0..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) | 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 | |||||
| patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| participant | C | 1..* | BackboneElement | Participants involved in appointment | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c} | Person, Location/HealthcareService or Device | ||||
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period | 0..1 | Period | Participation period of the actor | |||||
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| 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 (a valid code from Appointment Service Types) | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes) | ||||
| Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason) | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
| 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-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() |
This structure is derived from Appointment
Summary
Mandatory: 7 elements (2 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Systematic | Trifork. Package dk.ehealth.sundhed.fhir.ig.core#2.9.0 based on FHIR 4.0.1. Generated 2023-08-23
