CH ORF (R4)
1.0.0 - STU 1
CH ORF (R4)
1.0.0 - STU 1
This page is part of the CH ORF (R4) (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.2. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment | Version: 1.0.0 | |||
| Active as of 2022-02-22 | Computable Name: ChOrfAppointment | |||
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | 0..* | Appointment | CH ORF Appointment | |
  identifier | 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. |
| status | 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) |
| start | S | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
| end | S | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
| patientInstruction | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
 participant | S | 1..1 | BackboneElement | Participants involved in appointment |
  actor | S | 1..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
 status | S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: tentative |
 requestedPeriod | 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. |
 start | S | 0..1 | dateTime | Starting time with inclusive boundary |
| end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 0..* | Appointment | CH ORF Appointment |
 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 | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 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. |
| status | ?!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) |
| 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) |
| serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) |
| appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| 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..* | Reference(Resource) | Additional information to support the appointment | |
| start | SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
| end | SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
| 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 | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
| participant | SI | 1..1 | BackboneElement | Participants involved in appointment |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| 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 | SΣ | 1..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. |
| status | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
| period | 0..1 | Period | Participation period of the actor | |
| requestedPeriod | 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. |
| 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 | |
| start | SΣI | 0..1 | dateTime | Starting time with inclusive boundary |
| end | SΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 0..* | Appointment | CH ORF Appointment |
| identifier | Σ | 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. |
| status | ?!Σ | 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) |
| start | Σ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
| end | Σ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
| patientInstruction | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction | |
| participant | I | 1..1 | BackboneElement | Participants involved in appointment |
| actor | Σ | 1..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
| requestedPeriod | 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. | |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
This structure is derived from Appointment
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | 0..* | Appointment | CH ORF Appointment | |
| identifier | 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. |
| status | 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) |
| start | S | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
| end | S | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
| patientInstruction | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
| participant | S | 1..1 | BackboneElement | Participants involved in appointment |
| actor | S | 1..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
| status | S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: tentative |
| requestedPeriod | 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. |
| start | S | 0..1 | dateTime | Starting time with inclusive boundary |
| end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 0..* | Appointment | CH ORF Appointment |
| 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 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. |
| status | ?!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) |
| 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) |
| serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) |
| appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| 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..* | Reference(Resource) | Additional information to support the appointment | |
| start | SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") |
| end | SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") |
| 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 | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction |
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
| participant | SI | 1..1 | BackboneElement | Participants involved in appointment |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| 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 | SΣ | 1..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location |
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. |
| status | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
| period | 0..1 | Period | Participation period of the actor | |
| requestedPeriod | 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. |
| 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 | |
| start | SΣI | 0..1 | dateTime | Starting time with inclusive boundary |
| end | SΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Appointment.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Appointment.status | required | ChOrfAppointmentStatus |
| Appointment.cancelationReason | example | AppointmentCancellationReason |
| Appointment.serviceCategory | example | ServiceCategory |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | preferred | PracticeSettingCodeValueSet |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes |
| Appointment.reasonCode | preferred | EncounterReasonCodes |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.required | required | ParticipantRequired |
| Appointment.participant.status | required | Pattern: tentative |
| Id | Grade | Path | Details | Requirements |
| 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 | Appointment.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Appointment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Appointment.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Appointment.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Appointment.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.cancelationReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.serviceCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.serviceType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.specialty | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.appointmentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.supportingInformation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.minutesDuration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.slot | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.patientInstruction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| ele-1 | error | Appointment.participant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.participant.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Appointment.participant.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Appointment.participant.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Appointment.participant.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Appointment.participant.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.participant.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.participant.required | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.participant.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.participant.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.requestedPeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.requestedPeriod.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Appointment.requestedPeriod.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Appointment.requestedPeriod.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Appointment.requestedPeriod.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |