Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: Appointment Cancellation

The profile for Appointment cancellation request

Usages:

• Examples for this Profile: Appointment/appointment-cancellation-full-example and Appointment/appointment-cancellation-min-example

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	AlexAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. Required Pattern: cancelled
start	SΣ	0..1	instant	When appointment is to take place
end	SΣ	0..1	instant	When appointment is to conclude
created	S	0..1	dateTime	The date that this appointment was initially created
comment	S	0..1	string	Additional comments
Slices for participant	SC	2..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
participant:practitioner	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
participant:location	SC	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Location
display	SΣ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍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.
Appointment.participant:patient.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:location.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:location.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:practitioner, Appointment.participant:location	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 AlexAppointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	AlexAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
id		1..1	id	Logical id of this artifact
status		1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Required Pattern: cancelled
slot		0..0		The slots that this appointment is filling
participant		2..3	BackboneElement	Participants involved in appointment
Slices for participant				Content/Rules for all slices
participant:practitioner		1..1	BackboneElement	Participants involved in appointment
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	AlexAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. Required Pattern: cancelled
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
start	SΣ	0..1	instant	When appointment is to take place
end	SΣ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
created	S	0..1	dateTime	The date that this appointment was initially created
comment	S	0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
Slices for participant	SC	2..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
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	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
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	Σ	0..1	Reference(Patient)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
participant:practitioner	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
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	Σ	0..1	Reference(Practitioner)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
participant:location	SC	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Location
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.cancelationReason	Base	example	Appointment cancellation reason	📍4.0.1	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦2.0.0	THO v5.5
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.
Appointment.participant:patient.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:location.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:location.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:location.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:practitioner, Appointment.participant:location	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 AlexAppointment

Summary

Mandatory: 2 elements
Prohibited: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	AlexAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. Required Pattern: cancelled
start	SΣ	0..1	instant	When appointment is to take place
end	SΣ	0..1	instant	When appointment is to conclude
created	S	0..1	dateTime	The date that this appointment was initially created
comment	S	0..1	string	Additional comments
Slices for participant	SC	2..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
participant:practitioner	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
participant:location	SC	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Location
display	SΣ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍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.
Appointment.participant:patient.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:location.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:location.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:practitioner, Appointment.participant:location	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 AlexAppointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	AlexAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
id		1..1	id	Logical id of this artifact
status		1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Required Pattern: cancelled
slot		0..0		The slots that this appointment is filling
participant		2..3	BackboneElement	Participants involved in appointment
Slices for participant				Content/Rules for all slices
participant:practitioner		1..1	BackboneElement	Participants involved in appointment
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	AlexAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. Required Pattern: cancelled
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
start	SΣ	0..1	instant	When appointment is to take place
end	SΣ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
created	S	0..1	dateTime	The date that this appointment was initially created
comment	S	0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
Slices for participant	SC	2..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
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	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
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	Σ	0..1	Reference(Patient)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
participant:practitioner	SC	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
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	Σ	0..1	Reference(Practitioner)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
participant:location	SC	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Location
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.cancelationReason	Base	example	Appointment cancellation reason	📍4.0.1	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦2.0.0	THO v5.5
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.
Appointment.participant:patient.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:practitioner.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:location.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:location.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:location.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:practitioner, Appointment.participant:location	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 AlexAppointment

Summary

Mandatory: 2 elements
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron