This page is part of the CH ORF (R4) (v3.0.0: STU 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CH ORF Appointment

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:

• Use this Resource Profile: CH ORF Document
• Refer to this Resource Profile: CH ORF Location and Time
• Examples for this Resource Profile: Appointment/AppointmentBooked, Appointment/AppointmentPending and Appointment/AppointmentProposed

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

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	0..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

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.status	required	ChOrfAppointmentStatus http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus from this IG

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	CH ORF Appointment app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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. ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children
start	SΣ	0..1	instant	When appointment is to take place (required if status="pending" or "booked") ele-1: All FHIR elements must have a @value or children
end	SΣ	0..1	instant	When appointment is to conclude (required if status="pending" or "booked") ele-1: All FHIR elements must have a @value or children
patientInstruction	S	0..1	string	Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction ele-1: All FHIR elements must have a @value or children
participant	SC	1..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	SΣ	0..1	Reference(CH ORF Location)	Name, address and telecom of the appointment location ele-1: All FHIR elements must have a @value or children
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
start	SΣC	0..1	dateTime	Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.status	required	ChOrfAppointmentStatus http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus from this IG
Appointment.participant.status	required	Pattern: tentative http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	CH ORF Appointment app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	SC	1..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
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Σ	0..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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	ChOrfAppointmentStatus http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus from this IG
Appointment.cancelationReason	example	AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard
Appointment.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Appointment.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Appointment.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant.status	required	Pattern: tentative http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Must-Support: 11 elements

Structures

This structure refers to these other structures:

• CH ORF Location (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-location)

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	0..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

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.status	required	ChOrfAppointmentStatus http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	CH ORF Appointment app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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. ele-1: All FHIR elements must have a @value or children
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) ele-1: All FHIR elements must have a @value or children
start	SΣ	0..1	instant	When appointment is to take place (required if status="pending" or "booked") ele-1: All FHIR elements must have a @value or children
end	SΣ	0..1	instant	When appointment is to conclude (required if status="pending" or "booked") ele-1: All FHIR elements must have a @value or children
patientInstruction	S	0..1	string	Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction ele-1: All FHIR elements must have a @value or children
participant	SC	1..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	SΣ	0..1	Reference(CH ORF Location)	Name, address and telecom of the appointment location ele-1: All FHIR elements must have a @value or children
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
start	SΣC	0..1	dateTime	Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.status	required	ChOrfAppointmentStatus http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus from this IG
Appointment.participant.status	required	Pattern: tentative http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	CH ORF Appointment app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	SC	1..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
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Σ	0..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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	ChOrfAppointmentStatus http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus from this IG
Appointment.cancelationReason	example	AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard
Appointment.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Appointment.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Appointment.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant.status	required	Pattern: tentative http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Must-Support: 11 elements

Structures

This structure refers to these other structures:

• CH ORF Location (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-location)

Other representations of profile: CSV, Excel, Schematron