CH ORF (R4)
3.0.2-ci-build - ci-build
CH ORF (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 3.0.2-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-orf/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment | Version: 3.0.2-ci-build | |||
| Active as of 2025-10-30 | Computable Name: ChOrfAppointment | |||
Copyright/Legal: CC0-1.0 |
||||
Profile to describe the location and time for the fulfillment of the service request. In this resource, the status of the appointment is defined, patient-oriented instructions are listed here and where and when the service request is to be fulfilled.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Appointment | CH ORF Appointment Constraints: app-2, app-3, app-4 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may
change in time whereas Appointment.status reflects the status at the time the appointment is initiated. |
![]() ![]() |
?!SΣ | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: Appointment Status (required) |
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
![]() ![]() |
S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
![]() ![]() |
SC | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
![]() ![]() |
S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have
the same value for start and end. |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | Appointment Status | 📦3.0.2-ci-build | 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()
|
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Appointment | CH ORF Appointment | |
![]() ![]() |
S | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may change in time whereas Appointment.status reflects the status at the time the appointment is initiated. |
![]() ![]() |
S | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: Appointment Status (required) |
![]() ![]() |
S | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
![]() ![]() |
S | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
![]() ![]() |
S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
![]() ![]() |
S | 1..1 | BackboneElement | Participants involved in appointment |
![]() ![]() ![]() |
S | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
![]() ![]() ![]() |
S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: tentative |
![]() ![]() |
S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have the same value for start and end. |
![]() ![]() ![]() |
S | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | Appointment Status | 📦3.0.2-ci-build | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Appointment | CH ORF Appointment Constraints: app-2, app-3, app-4 | ||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may
change in time whereas Appointment.status reflects the status at the time the appointment is initiated. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: Appointment Status (required) | ||||
![]() ![]() |
Σ | 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) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
![]() ![]() |
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..* | Reference(Resource) | Additional information to support the appointment | |||||
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") | ||||
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
![]() ![]() |
SC | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative | ||||
![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() |
S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have
the same value for start and end. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | Appointment Status | 📦3.0.2-ci-build | This IG |
| 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.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| 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()
|
This structure is derived from Appointment
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Appointment | CH ORF Appointment Constraints: app-2, app-3, app-4 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may
change in time whereas Appointment.status reflects the status at the time the appointment is initiated. |
![]() ![]() |
?!SΣ | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: Appointment Status (required) |
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
![]() ![]() |
S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
![]() ![]() |
SC | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
![]() ![]() |
S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have
the same value for start and end. |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | Appointment Status | 📦3.0.2-ci-build | 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()
|
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Appointment | CH ORF Appointment | |
![]() ![]() |
S | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may change in time whereas Appointment.status reflects the status at the time the appointment is initiated. |
![]() ![]() |
S | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: Appointment Status (required) |
![]() ![]() |
S | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
![]() ![]() |
S | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
![]() ![]() |
S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
![]() ![]() |
S | 1..1 | BackboneElement | Participants involved in appointment |
![]() ![]() ![]() |
S | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
![]() ![]() ![]() |
S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: tentative |
![]() ![]() |
S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have the same value for start and end. |
![]() ![]() ![]() |
S | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | Appointment Status | 📦3.0.2-ci-build | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Appointment | CH ORF Appointment Constraints: app-2, app-3, app-4 | ||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may
change in time whereas Appointment.status reflects the status at the time the appointment is initiated. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: Appointment Status (required) | ||||
![]() ![]() |
Σ | 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) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
![]() ![]() |
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..* | Reference(Resource) | Additional information to support the appointment | |||||
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") | ||||
![]() ![]() |
SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
![]() ![]() |
SC | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative | ||||
![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() |
S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have
the same value for start and end. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | Appointment Status | 📦3.0.2-ci-build | This IG |
| 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.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| 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()
|
This structure is derived from Appointment
Other representations of profile: CSV, Excel, Schematron