eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.6.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
Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-appointment | Version: 3.6.0 | |||
Active as of 2025-10-16 | Computable Name: ehealth-group-appointment |
WARNING
validation issue will be raised if a participant is added to the appointment after this point in time
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Path | Status | Usage | ValueSet | Version | Source |
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
Appointment.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType.coding | Base | required | Appointment Service Type | 📦3.6.0 | This IG |
Appointment.appointmentType | Base | required | Appointment Type Codes | 📦3.6.0 | This IG |
Appointment.reasonCode | Base | required | Appointment Reason | 📦3.6.0 | This IG |
Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced |
%resource.supportingInformation.reference.contains('EpisodeOfCare/')
|
max-participants | warning | Appointment | Too 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-participants | warning | Appointment | Too 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-1 | error | Appointment | Ensuring that responsible entity is a participating party |
(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
|
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used |
%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
|
This structure is derived from Appointment
Path | Status | Usage | ValueSet | Version | Source |
Appointment.serviceType:appointmentType.coding | Base | required | Appointment Service Type | 📦3.6.0 | This IG |
Appointment.appointmentType | Base | required | Appointment Type Codes | 📦3.6.0 | This IG |
Appointment.reasonCode | Base | required | Appointment Reason | 📦3.6.0 | This IG |
Id | Grade | Path(s) | Description | Expression |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced |
%resource.supportingInformation.reference.contains('EpisodeOfCare/')
|
max-participants | warning | Appointment | Too 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-participants | warning | Appointment | Too 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-1 | error | Appointment | Ensuring that responsible entity is a participating party |
(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
|
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used |
%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
|
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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) Constraints: app-2, app-3, app-4, responsible-1, max-participants, min-participants | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2 | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-careteam) {r} | Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(ehealth-organization) {r} | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]() |
?!Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | ||||
![]() ![]() ![]() |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
![]() ![]() ![]() |
0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
![]() ![]() ![]() |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
![]() ![]() ![]() |
0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When appointment is to take place | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When appointment is to conclude | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
![]() ![]() ![]() |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() ![]() |
0..1 | dateTime | The date that this appointment was initially created | |||||
![]() ![]() ![]() |
0..1 | string | Additional comments | |||||
![]() ![]() ![]() |
0..1 | string | Detailed information and instructions for the patient | |||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
![]() ![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference() | Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c} | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]() |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
Appointment.cancelationReason | Base | example | Appointment cancellation reason | 📍4.0.1 | FHIR Std. |
Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
Appointment.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType.coding | Base | required | Appointment Service Type | 📦3.6.0 | This IG |
Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
Appointment.appointmentType | Base | required | Appointment Type Codes | 📦3.6.0 | This IG |
Appointment.reasonCode | Base | required | Appointment Reason | 📦3.6.0 | This IG |
Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced |
%resource.supportingInformation.reference.contains('EpisodeOfCare/')
|
max-participants | warning | Appointment | Too 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-participants | warning | Appointment | Too 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-1 | error | Appointment | Ensuring that responsible entity is a participating party |
(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
|
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used |
%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
|
This structure is derived from Appointment
Summary
Mandatory: 7 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:
Key Elements View
Path | Status | Usage | ValueSet | Version | Source |
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
Appointment.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType.coding | Base | required | Appointment Service Type | 📦3.6.0 | This IG |
Appointment.appointmentType | Base | required | Appointment Type Codes | 📦3.6.0 | This IG |
Appointment.reasonCode | Base | required | Appointment Reason | 📦3.6.0 | This IG |
Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced |
%resource.supportingInformation.reference.contains('EpisodeOfCare/')
|
max-participants | warning | Appointment | Too 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-participants | warning | Appointment | Too 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-1 | error | Appointment | Ensuring that responsible entity is a participating party |
(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
|
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used |
%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
|
Differential View
This structure is derived from Appointment
Path | Status | Usage | ValueSet | Version | Source |
Appointment.serviceType:appointmentType.coding | Base | required | Appointment Service Type | 📦3.6.0 | This IG |
Appointment.appointmentType | Base | required | Appointment Type Codes | 📦3.6.0 | This IG |
Appointment.reasonCode | Base | required | Appointment Reason | 📦3.6.0 | This IG |
Id | Grade | Path(s) | Description | Expression |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced |
%resource.supportingInformation.reference.contains('EpisodeOfCare/')
|
max-participants | warning | Appointment | Too 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-participants | warning | Appointment | Too 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-1 | error | Appointment | Ensuring that responsible entity is a participating party |
(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
|
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used |
%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
|
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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) Constraints: app-2, app-3, app-4, responsible-1, max-participants, min-participants | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2 | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-careteam) {r} | Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(ehealth-organization) {r} | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]() |
?!Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | ||||
![]() ![]() ![]() |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
![]() ![]() ![]() |
0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
![]() ![]() ![]() |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
![]() ![]() ![]() |
0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When appointment is to take place | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When appointment is to conclude | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
![]() ![]() ![]() |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() ![]() |
0..1 | dateTime | The date that this appointment was initially created | |||||
![]() ![]() ![]() |
0..1 | string | Additional comments | |||||
![]() ![]() ![]() |
0..1 | string | Detailed information and instructions for the patient | |||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
![]() ![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference() | Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c} | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]() |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
Appointment.cancelationReason | Base | example | Appointment cancellation reason | 📍4.0.1 | FHIR Std. |
Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
Appointment.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Appointment.serviceType:appointmentType.coding | Base | required | Appointment Service Type | 📦3.6.0 | This IG |
Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
Appointment.appointmentType | Base | required | Appointment Type Codes | 📦3.6.0 | This IG |
Appointment.reasonCode | Base | required | Appointment Reason | 📦3.6.0 | This IG |
Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced |
%resource.supportingInformation.reference.contains('EpisodeOfCare/')
|
max-participants | warning | Appointment | Too 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-participants | warning | Appointment | Too 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-1 | error | Appointment | Ensuring that responsible entity is a participating party |
(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
|
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used |
%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
|
This structure is derived from Appointment
Summary
Mandatory: 7 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:
Other representations of profile: CSV, Excel, Schematron