eHealth Infrastructure
2022.1 - release
eHealth Infrastructure
2022.1 - release
eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions
| Defining URL: | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-appointment |
| Version: | 2022.1 |
| Name: | ehealth-group-appointment |
| Status: | Active as of 1/18/22, 9:57 AM |
| Publisher: | Systematic | Trifork |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-appointment
WARNING validation issue will be raised if a participant is added to the appointment after this point in time
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
Summary
Mandatory: 7 elements (1 nested mandatory element)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | I | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) responsible-1: Ensuring that responsible entity is a participating party max-participants: Too many intended participants min-participants: Too few intended participants |
  id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
 ehealth-responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
| ehealth-group-id | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
| ehealth-legalBasis | I | 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 |
| ehealth-releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
| ehealth-responsible-organization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
| ehealth-performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
| ehealth-performing-organization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
| ehealth-creator | 0..1 | Reference(ehealth-careteam) {r} | Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator | |
| ehealth-intendedAudience | 0..* | Reference() | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
| ehealth-registration-deadline | 0..1 | dateTime | Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |
 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 | |
| Slices for 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group |
| 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 | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-ext-careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
| ehealth-assigning-careteam | 1..1 | Reference() | Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| actor | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {rc} | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) responsible-1: Ensuring that responsible entity is a participating party max-participants: Too many intended participants min-participants: Too few intended participants |
| Documentation for this format | ||||
This structure is derived from Appointment
Summary
Mandatory: 7 elements (1 nested mandatory element)
Fixed Value: 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
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) responsible-1: Ensuring that responsible entity is a participating party max-participants: Too many intended participants min-participants: Too few intended participants |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
| ehealth-responsible | 1..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
| ehealth-group-id | 0..1 | string | Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
| ehealth-legalBasis | I | 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 |
| ehealth-releasableResource | 0..1 | boolean | Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
| ehealth-responsible-organization | 0..1 | Reference(ehealth-organization) {r} | Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
| ehealth-performer | 0..1 | Reference(ehealth-careteam | ehealth-practitioner) {r} | Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
| ehealth-performing-organization | 0..1 | Reference(ehealth-organization) {r} | Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
| ehealth-creator | 0..1 | Reference(ehealth-careteam) {r} | Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator | |
| ehealth-intendedAudience | 0..* | Reference() | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
| ehealth-registration-deadline | 0..1 | dateTime | Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |
| 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 | |
| Slices for 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: group |
| 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 | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-ext-careteam | 0..1 | Reference(ehealth-careteam) {r} | Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
| ehealth-assigning-careteam | 1..1 | Reference() | Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| actor | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {rc} | 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 | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Appointment.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancelationReason | example | AppointmentCancellationReason |
| Appointment.serviceCategory | example | ServiceCategory |
| Appointment.serviceType | example | ServiceType |
| Appointment.serviceType:appointmentType | example | ServiceType |
| Appointment.serviceType:appointmentType.coding | required | AppointmentServiceType |
| Appointment.specialty | preferred | PracticeSettingCodeValueSet |
| Appointment.appointmentType | required | AppointmentTypeCodes |
| Appointment.reasonCode | required | AppointmentReason |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.required | required | ParticipantRequired |
| Appointment.participant.status | required | ParticipationStatus |
| Id | Grade | Path | Details | Requirements |
| 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) | |
| 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 | |
| governance-1 | error | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
| responsible-2 | error | Appointment.extension:legalBasis | Both performing organization and responsible organization must be populated when legal basis is used : %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists() | |
| app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() |
IG © 2021+ Systematic | Trifork. Package dk.ehealth.sundhed.fhir.ig.core#2022.1 based on FHIR 4.0.1. Generated 2022-01-18
