This page is part of the FUT Infrastructure (v3.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment | Version: 3.1.0 | |||
Active as of 2024-07-01 | Computable Name: ehealth-appointment |
An Appointment is a booking of a healthcare event among ehealth patients, practitioners, related persons, and locations. This may be either a physical or virtual meeting. Even though a meeting may span a number of participants, only one physical Appointment resource must be created. Participant status (approved, declined etc.) is handled using the AppointmentResponse resource, which in turn updates the status of the participant on the appointment resource.
The most important fields of the ehealth-appointment are described below:
description: The “subject” of the appointment (textual description).
comment: Free text description of the appointment to take place.
participants: A list of participants invited to the meeting. These may be of type Patient, Practitioner, RelatedPerson, and Location. At least two participants are required. Each participant has a status, which may only be updated by creating an AppointmentResponse. In that case, the status on the Appointment will be updated with the participantStatus sent in the response.
start/end: the start and end time of when the appointment is to take place.
ehealth-responsible (extension): the responsible individual, care team and/or organization for the meeting.
appointmentType: the type of appointment booked (checkup, emergency, followup etc).
If other resources need to be referenced as part of the appointment, it is possible to reference Condition and Procedure resources as the reason for the meeting, or using “supportingInformation” to reference other resource types. The “group-id” extension can be used for logically grouping different appointments.
In the eHealth Infrastructure the Appointment resource is used in conjunction with the following resources:
The following rules apply to ehealth-appointment resources, given the appointment contains a participant of type Patient, who allows reception of NemSMS (has telecom with value ‘NemSMS’):
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) responsible-1: Ensuring that responsible entity is a participating party single-patient-appointment: Only a single patient is allowed pr. appointment |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
groupId | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used |
releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
performingOrganization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
Slices for serviceType | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code | |
serviceType:appointmentType | 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: regular | |
appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) | |
reasonCode | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | |
supportingInformation | 0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |
participant | 2..* | BackboneElement | Participants involved in appointment | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
actor | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c} | Person, Location/HealthcareService or Device | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetype from this IG | |
Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codes from this IG | |
Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-1 | error | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) 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 single-patient-appointment: Only a single patient is allowed pr. appointment |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
groupId | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used |
releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
performingOrganization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
Slices for serviceType | Σ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example) |
serviceType:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: regular |
appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) |
reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) |
supportingInformation | 0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |
participant | C | 2..* | 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 | |
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. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | |
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Appointment.serviceType:appointmentType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetype from this IG | |
Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codes from this IG | |
Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reason from this IG | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-1 | error | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) 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 single-patient-appointment: Only a single patient is allowed pr. appointment | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |||||
groupId | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |||||
legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used | ||||
releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |||||
responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |||||
performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |||||
performingOrganization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
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:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: regular | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) | ||||
reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | ||||
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
supportingInformation | 0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |||||
start | Σ | 0..1 | instant | When appointment is to take place | ||||
end | Σ | 0..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 | 2..* | 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 | |||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | ||||
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | ||||
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.serviceType:appointmentType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetype from this IG | ||||
Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codes from this IG | ||||
Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reason from this IG | ||||
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-1 | error | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
This structure is derived from Appointment
Summary
Mandatory: 5 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:
Differential View
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) responsible-1: Ensuring that responsible entity is a participating party single-patient-appointment: Only a single patient is allowed pr. appointment |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
groupId | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used |
releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
performingOrganization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
Slices for serviceType | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code | |
serviceType:appointmentType | 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: regular | |
appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) | |
reasonCode | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | |
supportingInformation | 0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |
participant | 2..* | BackboneElement | Participants involved in appointment | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
actor | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c} | Person, Location/HealthcareService or Device | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetype from this IG | |
Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codes from this IG | |
Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-1 | error | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) 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 single-patient-appointment: Only a single patient is allowed pr. appointment |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
groupId | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used |
releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
performingOrganization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
Slices for serviceType | Σ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example) |
serviceType:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: regular |
appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) |
reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) |
supportingInformation | 0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |
participant | C | 2..* | 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 | |
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. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | |
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Appointment.serviceType:appointmentType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetype from this IG | |
Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codes from this IG | |
Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reason from this IG | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-1 | error | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) 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 single-patient-appointment: Only a single patient is allowed pr. appointment | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |||||
groupId | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |||||
legalBasis | C | 0..1 | CodeableConcept | Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) governance-1: When extension is used a Episode of Care MUST be referenced responsible-2: Both performing organization and responsible organization must be populated when legal basis is used | ||||
releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |||||
responsibleOrganization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |||||
performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |||||
performingOrganization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
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:appointmentType | Σ | 1..1 | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Service Type (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: regular | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required) | ||||
reasonCode | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: Appointment Reason (required) | ||||
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
supportingInformation | 0..1 | Reference(ehealth-episodeofcare | ehealth-careplan) {r} | Additional information to support the appointment | |||||
start | Σ | 0..1 | instant | When appointment is to take place | ||||
end | Σ | 0..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 | 2..* | 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 | |||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | ||||
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | ||||
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.serviceType:appointmentType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType (a valid code from Appointment Service Types)http://ehealth.sundhed.dk/vs/appointment-servicetype from this IG | ||||
Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
Appointment.appointmentType | required | AppointmentTypeCodes (a valid code from Appointment Type Codes)http://ehealth.sundhed.dk/vs/appointmenttype-codes from this IG | ||||
Appointment.reasonCode | required | AppointmentReason (a valid code from Appointment Reason)http://ehealth.sundhed.dk/vs/appointment-reason from this IG | ||||
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-1 | error | Appointment | Ensuring that responsible entity is a participating party : (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference) | |
responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
single-patient-appointment | error | Appointment | Only a single patient is allowed pr. appointment : participant.actor.where(reference.contains('/Patient')).count() < 2 |
This structure is derived from Appointment
Summary
Mandatory: 5 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