CH ORF (R4)
1.1.0 - CI Build Switzerland flag

CH ORF (R4), published by HL7 Switzerland. This is not an authorized publication; it is the continuous build for version 1.1.0). This version is based on the current content of https://github.com/hl7ch/ch-orf/ and changes regularly. See the Directory of published versions

Resource Profile: CH ORF Appointment

Official URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment Version: 1.1.0
Active as of 2023-01-06 Computable Name: ChOrfAppointment

Copyright/Legal: CC-BY-SA-4.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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment 0..*AppointmentCH ORF Appointment
... identifier S0..*IdentifierExternal 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 S1..1codeUsed 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 S0..1instantWhen appointment is to take place (required if status="pending" or "booked")
... patientInstruction S0..1stringPatient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction
... participant S1..1BackboneElementParticipants involved in appointment
.... actor S1..1Reference(CH ORF Location)Name, address and telecom of the appointment location
.... status S1..1codeaccepted | declined | tentative | needs-action
Required Pattern: tentative
... requestedPeriod S0..1PeriodSingle 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 S0..1dateTimeStarting time with inclusive boundary
.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Appointment.statusrequiredChOrfAppointmentStatus
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentCH ORF Appointment
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal 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.
... start SΣ0..1instantWhen appointment is to take place (required if status="pending" or "booked")
... end SΣ0..1instantWhen appointment is to conclude (required if status="pending" or "booked")
... patientInstruction S0..1stringPatient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction
... participant SC1..1BackboneElementParticipants involved in appointment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor SΣ1..1Reference(CH ORF Location)Name, address and telecom of the appointment location
.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


Required Pattern: tentative
... requestedPeriod S0..1PeriodSingle 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ΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Appointment.statusrequiredChOrfAppointmentStatus
Appointment.participant.statusrequiredPattern: tentative

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentCH ORF Appointment
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal 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..1codeUsed 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..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ0..*CodeableConceptCoded 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..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
... start SΣ0..1instantWhen appointment is to take place (required if status="pending" or "booked")
... end SΣ0..1instantWhen appointment is to conclude (required if status="pending" or "booked")
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction S0..1stringPatient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant SC1..1BackboneElementParticipants involved in appointment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor SΣ1..1Reference(CH ORF Location)Name, address and telecom of the appointment location
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


Required Pattern: tentative
.... period 0..1PeriodParticipation period of the actor
... requestedPeriod S0..1PeriodSingle 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Appointment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Appointment.statusrequiredChOrfAppointmentStatus
Appointment.cancelationReasonexampleAppointmentCancellationReason
Appointment.serviceCategoryexampleServiceCategory
Appointment.serviceTypeexampleServiceType
Appointment.specialtypreferredPracticeSettingCodeValueSet
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
Appointment.reasonCodepreferredEncounterReasonCodes
Appointment.participant.typeextensibleParticipantType
Appointment.participant.requiredrequiredParticipantRequired
Appointment.participant.statusrequiredPattern: tentative

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 1 element
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment 0..*AppointmentCH ORF Appointment
... identifier S0..*IdentifierExternal 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 S1..1codeUsed 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 S0..1instantWhen appointment is to take place (required if status="pending" or "booked")
... patientInstruction S0..1stringPatient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction
... participant S1..1BackboneElementParticipants involved in appointment
.... actor S1..1Reference(CH ORF Location)Name, address and telecom of the appointment location
.... status S1..1codeaccepted | declined | tentative | needs-action
Required Pattern: tentative
... requestedPeriod S0..1PeriodSingle 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 S0..1dateTimeStarting time with inclusive boundary
.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Appointment.statusrequiredChOrfAppointmentStatus

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentCH ORF Appointment
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal 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.
... start SΣ0..1instantWhen appointment is to take place (required if status="pending" or "booked")
... end SΣ0..1instantWhen appointment is to conclude (required if status="pending" or "booked")
... patientInstruction S0..1stringPatient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction
... participant SC1..1BackboneElementParticipants involved in appointment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor SΣ1..1Reference(CH ORF Location)Name, address and telecom of the appointment location
.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


Required Pattern: tentative
... requestedPeriod S0..1PeriodSingle 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ΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Appointment.statusrequiredChOrfAppointmentStatus
Appointment.participant.statusrequiredPattern: tentative

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment C0..*AppointmentCH ORF Appointment
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal 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..1codeUsed 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..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ0..*CodeableConceptCoded 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..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
... start SΣ0..1instantWhen appointment is to take place (required if status="pending" or "booked")
... end SΣ0..1instantWhen appointment is to conclude (required if status="pending" or "booked")
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction S0..1stringPatient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant SC1..1BackboneElementParticipants involved in appointment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor SΣ1..1Reference(CH ORF Location)Name, address and telecom of the appointment location
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


Required Pattern: tentative
.... period 0..1PeriodParticipation period of the actor
... requestedPeriod S0..1PeriodSingle 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Appointment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Appointment.statusrequiredChOrfAppointmentStatus
Appointment.cancelationReasonexampleAppointmentCancellationReason
Appointment.serviceCategoryexampleServiceCategory
Appointment.serviceTypeexampleServiceType
Appointment.specialtypreferredPracticeSettingCodeValueSet
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
Appointment.reasonCodepreferredEncounterReasonCodes
Appointment.participant.typeextensibleParticipantType
Appointment.participant.requiredrequiredParticipantRequired
Appointment.participant.statusrequiredPattern: tentative

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 1 element
Must-Support: 11 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron