eHealth Infrastructure
3.3.0 - ci-build Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions

Resource Profile: ehealth-group-videoappointment

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-videoappointment Version: 3.3.0
Active as of 2024-11-20 Computable Name: ehealth-group-videoappointment

Extra Validation Constraints

  • When a dateTime value is present in the ehealth-registration-deadline extension, then a WARNING validation issue will be raised if a participant is added to the appointment after this point in time
    • This constraint is implemented directly on the server due to technical limitations, which means it is not listed with other Implementation Guide constraints
  • The ehealth-creator extension value is managed by the server and holds a reference to the CareTeam that created the group appointment
    • When creating a new group appointment, the server automatically fills out this value based on the JWT CareTeam context of the user
    • Trying to assign a value different from the CareTeam in context when creating a group appointment, or changing this value in an update or patch operation, generates a http 422 error
    • The value is used by the security system of the server to allow the original creator of the group appointment to modify the appointment after creation, even when the creator is not the ehealth-responsible party

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 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
max-participants: Too many intended participants
min-participants: Too few intended participants
... 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
.... creator 0..1 Reference(ehealth-careteam) {r} Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... registrationDeadline 0..1 dateTime Registration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
.... 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
... Slices for serviceType 1..* CodeableConcept The specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
.... serviceType:appointmentServiceType 1..1 CodeableConcept The specific service that is to be performed during this appointment
..... 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: group-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)
... description 1..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1 Reference(ehealth-episodeofcare | ehealth-careplan) {r} Additional information to support the appointment
... start 1..1 instant When appointment is to take place
... end 1..1 instant When appointment is to conclude
... participant
.... 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
..... assigningCareteam 0..1 Reference() Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... actor 0..1 Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c} Person, Location/HealthcareService or Device

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Appointment.serviceType:appointmentServiceType.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/')
max-participantswarningAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantswarningAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
app-2: Either start and end are specified, or neither
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... 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
.... creator 0..1 Reference(ehealth-careteam) {r} Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... registrationDeadline 0..1 dateTime Registration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
.... 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 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:appointmentServiceType Σ 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: group-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)
... description 1..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1 Reference(ehealth-episodeofcare | ehealth-careplan) {r} Additional information to support the appointment
... start Σ 1..1 instant When appointment is to take place
... end Σ 1..1 instant When appointment is to conclude
... participant C 1..* BackboneElement Participants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... 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
..... assigningCareteam 0..1 Reference() Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 0..1 Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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:appointmentServiceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentServiceType.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/')
max-participantswarningAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantswarningAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
app-2: Either start and end are specified, or neither
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
.... creator 0..1 Reference(ehealth-careteam) {r} Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... registrationDeadline 0..1 dateTime Registration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
.... 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
... identifier Σ 0..* Identifier External Ids for this item
... 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:appointmentServiceType Σ 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: group-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 1..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1 Reference(ehealth-episodeofcare | ehealth-careplan) {r} Additional information to support the appointment
... start Σ 1..1 instant When appointment is to take place
... end Σ 1..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) 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
app-1: Either the type or actor on the participant SHALL be specified
.... 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
..... assigningCareteam 0..1 Reference() Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-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, 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

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.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:appointmentServiceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentServiceType.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/')
max-participantswarningAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantswarningAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
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()

This structure is derived from Appointment

Summary

Mandatory: 8 elements(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Appointment.serviceType

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
max-participants: Too many intended participants
min-participants: Too few intended participants
... 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
.... creator 0..1 Reference(ehealth-careteam) {r} Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... registrationDeadline 0..1 dateTime Registration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
.... 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
... Slices for serviceType 1..* CodeableConcept The specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
.... serviceType:appointmentServiceType 1..1 CodeableConcept The specific service that is to be performed during this appointment
..... 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: group-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)
... description 1..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1 Reference(ehealth-episodeofcare | ehealth-careplan) {r} Additional information to support the appointment
... start 1..1 instant When appointment is to take place
... end 1..1 instant When appointment is to conclude
... participant
.... 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
..... assigningCareteam 0..1 Reference() Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... actor 0..1 Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c} Person, Location/HealthcareService or Device

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Appointment.serviceType:appointmentServiceType.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/')
max-participantswarningAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantswarningAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
app-2: Either start and end are specified, or neither
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... 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
.... creator 0..1 Reference(ehealth-careteam) {r} Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... registrationDeadline 0..1 dateTime Registration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
.... 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 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:appointmentServiceType Σ 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: group-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)
... description 1..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1 Reference(ehealth-episodeofcare | ehealth-careplan) {r} Additional information to support the appointment
... start Σ 1..1 instant When appointment is to take place
... end Σ 1..1 instant When appointment is to conclude
... participant C 1..* BackboneElement Participants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... 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
..... assigningCareteam 0..1 Reference() Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 0..1 Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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:appointmentServiceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentServiceType.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/')
max-participantswarningAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantswarningAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
app-2: Either start and end are specified, or neither
app-3: Only proposed or cancelled appointments can be missing start/end dates
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
.... creator 0..1 Reference(ehealth-careteam) {r} Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... registrationDeadline 0..1 dateTime Registration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
.... 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
... identifier Σ 0..* Identifier External Ids for this item
... 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:appointmentServiceType Σ 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: group-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 1..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1 Reference(ehealth-episodeofcare | ehealth-careplan) {r} Additional information to support the appointment
... start Σ 1..1 instant When appointment is to take place
... end Σ 1..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) 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
app-1: Either the type or actor on the participant SHALL be specified
.... 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
..... assigningCareteam 0..1 Reference() Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-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, 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

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.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:appointmentServiceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.serviceType:appointmentServiceType.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/')
max-participantswarningAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantswarningAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
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()

This structure is derived from Appointment

Summary

Mandatory: 8 elements(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Appointment.serviceType

 

Other representations of profile: CSV, Excel, Schematron