eHealth Infrastructure
3.1.0 - release

eHealth Infrastructure - Local Development build (v3.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ehealth-videoappointment

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-videoappointment Version: 3.1.0
Active as of 2024-05-27 Computable Name: ehealth-videoappointment

Introduction

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.

Scope and Usage

In the eHealth Infrastructure the Appointment resource is used in conjunction with the following resources:

  • Patient
    • If the appointment contains a participant of type Patient
  • Practitioner
    • If the appointment contains a participant of type Practitioner
  • RelatedPerson
    • If the appointment contains a participant of type RelatedPerson
  • Location
    • If the appointment contains a participant of type Location

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentA 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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endMeetingOnEndTime 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... maxParticipants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... vmrUri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... guestPinCode 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... hostPinCode 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... groupId 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... legalBasis C0..1CodeableConceptLegal 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..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... responsibleOrganization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... performingOrganization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... Slices for identifier 0..*IdentifierExternal Ids for this item
Slice: Unordered, Open by value:system
.... identifier:vdxMeetingId 0..1IdentifierExternal Ids for this item
..... system 1..1uriThe namespace for the identifier value
Fixed Value: http://vdx.medcom.dk/meeting
... Slices for serviceType 1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
.... serviceType:appointmentType 1..1CodeableConceptThe specific service that is to be performed during this appointment
..... coding 0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: video
... appointmentType 1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode 0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... supportingInformation 0..1Reference(ehealth-episodeofcare | ehealth-careplan) {r}Additional information to support the appointment
... start 1..1instantWhen appointment is to take place
... end 1..1instantWhen appointment is to conclude
... participant
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... actor 0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c}Person, Location/HealthcareService or Device

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType (a valid code from Appointment Service Types)
http://ehealth.sundhed.dk/vs/appointment-servicetype
from this IG
Appointment.appointmentTyperequiredAppointmentTypeCodes (a valid code from Appointment Type Codes)
http://ehealth.sundhed.dk/vs/appointmenttype-codes
from this IG
Appointment.reasonCoderequiredAppointmentReason (a valid code from Appointment Reason)
http://ehealth.sundhed.dk/vs/appointment-reason
from this IG

Constraints

IdGradePath(s)DetailsRequirements
governance-1errorAppointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-1errorAppointmentEnsuring 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-2errorAppointment.extension:legalBasisBoth 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-appointmenterrorAppointmentOnly a single patient is allowed pr. appointment
: participant.actor.where(reference.contains('/Patient')).count() < 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentA 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..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endMeetingOnEndTime 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... meetingUrl 0..1uriMeeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... vmrUri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... guestPinCode 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... hostPinCode 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... groupId 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... legalBasis C0..1CodeableConceptLegal 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..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... responsibleOrganization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... performingOrganization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this item
Slice: Unordered, Open by value:system
.... identifier:vdxMeetingId Σ0..1IdentifierExternal Ids for this item
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://vdx.medcom.dk/meeting
... status ?!Σ1..1codeproposed | 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..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
Binding: ServiceType (example)
.... serviceType:appointmentType Σ1..1CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
..... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: video
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode Σ0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... supportingInformation 0..1Reference(ehealth-episodeofcare | ehealth-careplan) {r}Additional information to support the appointment
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... participant C1..*BackboneElementParticipants involved in appointment
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor Σ0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c}Person, Location/HealthcareService or Device
.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.identifier:vdxMeetingId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType (a valid code from Appointment Service Types)
http://ehealth.sundhed.dk/vs/appointment-servicetype
from this IG
Appointment.appointmentTyperequiredAppointmentTypeCodes (a valid code from Appointment Type Codes)
http://ehealth.sundhed.dk/vs/appointmenttype-codes
from this IG
Appointment.reasonCoderequiredAppointmentReason (a valid code from Appointment Reason)
http://ehealth.sundhed.dk/vs/appointment-reason
from this IG
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
governance-1errorAppointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-1errorAppointmentEnsuring 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-2errorAppointment.extension:legalBasisBoth 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-appointmenterrorAppointmentOnly a single patient is allowed pr. appointment
: participant.actor.where(reference.contains('/Patient')).count() < 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentA 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endMeetingOnEndTime 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... maxParticipants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... meetingUrl 0..1uriMeeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... vmrUri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... guestPinCode 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... hostPinCode 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... groupId 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... legalBasis C0..1CodeableConceptLegal 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..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... responsibleOrganization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... performingOrganization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this item
Slice: Unordered, Open by value:system
.... identifier:vdxMeetingId Σ0..1IdentifierExternal Ids for this item
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: http://vdx.medcom.dk/meeting
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... Slices for serviceType Σ1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
Binding: ServiceType (example)
.... serviceType:appointmentType Σ1..1CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: video
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode Σ0..1CodeableConceptCoded 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..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1Reference(ehealth-episodeofcare | ehealth-careplan) {r}Additional information to support the appointment
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction 0..1stringDetailed information and instructions for the patient
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant C1..*BackboneElementParticipants involved in appointment
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor Σ0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c}Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Appointment.identifier:vdxMeetingId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.identifier:vdxMeetingId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
from the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType (a valid code from Appointment Service Types)
http://ehealth.sundhed.dk/vs/appointment-servicetype
from this IG
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
Appointment.appointmentTyperequiredAppointmentTypeCodes (a valid code from Appointment Type Codes)
http://ehealth.sundhed.dk/vs/appointmenttype-codes
from this IG
Appointment.reasonCoderequiredAppointmentReason (a valid code from Appointment Reason)
http://ehealth.sundhed.dk/vs/appointment-reason
from this IG
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Appointment.participant.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
from the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
governance-1errorAppointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-1errorAppointmentEnsuring 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-2errorAppointment.extension:legalBasisBoth 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-appointmenterrorAppointmentOnly a single patient is allowed pr. appointment
: participant.actor.where(reference.contains('/Patient')).count() < 2

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:

  • The element Appointment.identifier is sliced based on the value of value:system
  • The element Appointment.serviceType is sliced based on the value of value:coding.code

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentA 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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endMeetingOnEndTime 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... maxParticipants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... vmrUri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... guestPinCode 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... hostPinCode 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... groupId 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... legalBasis C0..1CodeableConceptLegal 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..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... responsibleOrganization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... performingOrganization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... Slices for identifier 0..*IdentifierExternal Ids for this item
Slice: Unordered, Open by value:system
.... identifier:vdxMeetingId 0..1IdentifierExternal Ids for this item
..... system 1..1uriThe namespace for the identifier value
Fixed Value: http://vdx.medcom.dk/meeting
... Slices for serviceType 1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
.... serviceType:appointmentType 1..1CodeableConceptThe specific service that is to be performed during this appointment
..... coding 0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: video
... appointmentType 1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode 0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... supportingInformation 0..1Reference(ehealth-episodeofcare | ehealth-careplan) {r}Additional information to support the appointment
... start 1..1instantWhen appointment is to take place
... end 1..1instantWhen appointment is to conclude
... participant
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... actor 0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c}Person, Location/HealthcareService or Device

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType (a valid code from Appointment Service Types)
http://ehealth.sundhed.dk/vs/appointment-servicetype
from this IG
Appointment.appointmentTyperequiredAppointmentTypeCodes (a valid code from Appointment Type Codes)
http://ehealth.sundhed.dk/vs/appointmenttype-codes
from this IG
Appointment.reasonCoderequiredAppointmentReason (a valid code from Appointment Reason)
http://ehealth.sundhed.dk/vs/appointment-reason
from this IG

Constraints

IdGradePath(s)DetailsRequirements
governance-1errorAppointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-1errorAppointmentEnsuring 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-2errorAppointment.extension:legalBasisBoth 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-appointmenterrorAppointmentOnly a single patient is allowed pr. appointment
: participant.actor.where(reference.contains('/Patient')).count() < 2

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentA 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..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endMeetingOnEndTime 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... meetingUrl 0..1uriMeeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... vmrUri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... guestPinCode 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... hostPinCode 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... groupId 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... legalBasis C0..1CodeableConceptLegal 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..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... responsibleOrganization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... performingOrganization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this item
Slice: Unordered, Open by value:system
.... identifier:vdxMeetingId Σ0..1IdentifierExternal Ids for this item
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://vdx.medcom.dk/meeting
... status ?!Σ1..1codeproposed | 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..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
Binding: ServiceType (example)
.... serviceType:appointmentType Σ1..1CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
..... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: video
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode Σ0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... supportingInformation 0..1Reference(ehealth-episodeofcare | ehealth-careplan) {r}Additional information to support the appointment
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... participant C1..*BackboneElementParticipants involved in appointment
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor Σ0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c}Person, Location/HealthcareService or Device
.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.identifier:vdxMeetingId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType (a valid code from Appointment Service Types)
http://ehealth.sundhed.dk/vs/appointment-servicetype
from this IG
Appointment.appointmentTyperequiredAppointmentTypeCodes (a valid code from Appointment Type Codes)
http://ehealth.sundhed.dk/vs/appointmenttype-codes
from this IG
Appointment.reasonCoderequiredAppointmentReason (a valid code from Appointment Reason)
http://ehealth.sundhed.dk/vs/appointment-reason
from this IG
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
governance-1errorAppointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-1errorAppointmentEnsuring 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-2errorAppointment.extension:legalBasisBoth 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-appointmenterrorAppointmentOnly a single patient is allowed pr. appointment
: participant.actor.where(reference.contains('/Patient')).count() < 2

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentA 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endMeetingOnEndTime 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... maxParticipants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... meetingUrl 0..1uriMeeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... vmrUri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... guestPinCode 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... hostPinCode 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... groupId 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... legalBasis C0..1CodeableConceptLegal 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..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... responsibleOrganization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... performingOrganization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this item
Slice: Unordered, Open by value:system
.... identifier:vdxMeetingId Σ0..1IdentifierExternal Ids for this item
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: http://vdx.medcom.dk/meeting
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... Slices for serviceType Σ1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
Binding: ServiceType (example)
.... serviceType:appointmentType Σ1..1CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: video
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode Σ0..1CodeableConceptCoded 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..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1Reference(ehealth-episodeofcare | ehealth-careplan) {r}Additional information to support the appointment
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction 0..1stringDetailed information and instructions for the patient
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant C1..*BackboneElementParticipants involved in appointment
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor Σ0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, r, c}Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Appointment.identifier:vdxMeetingId.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.identifier:vdxMeetingId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
from the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType (a valid code from Appointment Service Types)
http://ehealth.sundhed.dk/vs/appointment-servicetype
from this IG
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
Appointment.appointmentTyperequiredAppointmentTypeCodes (a valid code from Appointment Type Codes)
http://ehealth.sundhed.dk/vs/appointmenttype-codes
from this IG
Appointment.reasonCoderequiredAppointmentReason (a valid code from Appointment Reason)
http://ehealth.sundhed.dk/vs/appointment-reason
from this IG
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Appointment.participant.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
from the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
governance-1errorAppointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-1errorAppointmentEnsuring 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-2errorAppointment.extension:legalBasisBoth 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-appointmenterrorAppointmentOnly a single patient is allowed pr. appointment
: participant.actor.where(reference.contains('/Patient')).count() < 2

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:

  • The element Appointment.identifier is sliced based on the value of value:system
  • The element Appointment.serviceType is sliced based on the value of value:coding.code

 

Other representations of profile: CSV, Excel, Schematron