Appointment booked to carry out a referral - FHIR equivalent of the 360X Scheduling Option HL7 v2 SIU^S12 (new), SIU^S13 (reschedule), SIU^S15 (cancel) and SIU^S26 (no-show) messages.

FDP Canonical Data Model

Equivalent FDP Canonical Data Model (CDM) v1.0.0 objects: Appointment, Clinic Slot.

Differences:

• Good fit: CDM Appointment links to the referral (referralId) and the slot, with booking and attendance status and outcomeOfAttendanceCode.
• The CDM records consultation mechanism (face to face, telephone, video) - candidate for serviceType / appointment type.
• Attendance outcome (discharged, another appointment) is how the CDM records the end of care; this guide closes the loop with the outcome report [PCC-57].

The CDM is a downstream persistence model, used here as evidence of what NHS operations record, not as a design source. Mapping by property name - To confirm. See FDP Canonical Data Model Mapping for the full mapping.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	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
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Appointment ID (SCH-2)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	booked (S12/S13) | cancelled (S15) | noshow (S26) | fulfilled Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Appointment date and time (TQ1-7)
Appointment.end	S This element must be supported. Σ This element is included in summaries.	0..1	instant	When appointment is to conclude
Appointment.slot	S This element must be supported.	0..*	Reference(Slot)	The Slot booked (eRS, GP Connect Appointment Management and local booking all book Slots)
Appointment.basedOn	S This element must be supported.	1..*	Reference(Referral Request)	The referral (SCH-26 Referral ID)
Appointment.basedOn.identifier	Σ This element is included in summaries.	0..1	ReferralIdentifier	Logical reference, when literal reference is not known
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	The patient and the appointment provider (AIP-3) Constraints: app-1
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Appointment.participant.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	Appointment	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)
Appointment.identifier	S This element must be supported.	1..*	Identifier	Appointment ID (SCH-2)
Appointment.status	S This element must be supported.	1..1	code	booked (S12/S13) | cancelled (S15) | noshow (S26) | fulfilled
Appointment.serviceType	S This element must be supported.	0..*	CodeableConcept	The specific service that is to be performed during this appointment
Appointment.reasonCode	S This element must be supported.	0..*	CodeableConcept	Coded reason this appointment is scheduled
Appointment.start	S This element must be supported.	1..1	instant	Appointment date and time (TQ1-7)
Appointment.end	S This element must be supported.	0..1	instant	When appointment is to conclude
Appointment.slot	S This element must be supported.	0..*	Reference(Slot)	The Slot booked (eRS, GP Connect Appointment Management and local booking all book Slots)
Appointment.basedOn	S This element must be supported.	1..*	Reference(Referral Request)	The referral (SCH-26 Referral ID)
Appointment.basedOn.identifier		0..1	ReferralIdentifier	Logical reference, when literal reference is not known
Appointment.participant	S This element must be supported.	1..*	BackboneElement	The patient and the appointment provider (AIP-3)
Appointment.participant.actor	S This element must be supported.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	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
Appointment.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Appointment.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Appointment.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
Appointment.contained		0..*	Resource	Contained, inline Resources
Appointment.extension		0..*	Extension	Additional content defined by implementations
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Appointment ID (SCH-2)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	booked (S12/S13) | cancelled (S15) | noshow (S26) | fulfilled Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
Appointment.serviceCategory	Σ This element is included in summaries.	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
Appointment.specialty	Σ This element is included in summaries.	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
Appointment.appointmentType	Σ This element is included in summaries.	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
Appointment.reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
Appointment.description		0..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Appointment date and time (TQ1-7)
Appointment.end	S This element must be supported. Σ This element is included in summaries.	0..1	instant	When appointment is to conclude
Appointment.minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot	S This element must be supported.	0..*	Reference(Slot)	The Slot booked (eRS, GP Connect Appointment Management and local booking all book Slots)
Appointment.created		0..1	dateTime	The date that this appointment was initially created
Appointment.comment		0..1	string	Additional comments
Appointment.patientInstruction		0..1	string	Detailed information and instructions for the patient
Appointment.basedOn	S This element must be supported.	1..*	Reference(Referral Request)	The referral (SCH-26 Referral ID)
Appointment.basedOn.id		0..1	string	Unique id for inter-element referencing
Appointment.basedOn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.basedOn.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Appointment.basedOn.type	Σ This element is included in summaries.	0..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).
Appointment.basedOn.identifier	Σ This element is included in summaries.	0..1	ReferralIdentifier	Logical reference, when literal reference is not known
Appointment.basedOn.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	The patient and the appointment provider (AIP-3) Constraints: app-1
Appointment.participant.id		0..1	string	Unique id for inter-element referencing
Appointment.participant.extension		0..*	Extension	Additional content defined by implementations
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.type	Σ This element is included in summaries.	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Appointment.participant.required	Σ This element is included in summaries.	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.participant.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.participant.period		0..1	Period	Participation period of the actor
Appointment.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.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.serviceCategory	Base	example	Service category	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.0.1	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦3.0.0	THO v7.5
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Appointment.basedOn.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	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
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Appointment ID (SCH-2)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	booked (S12/S13) | cancelled (S15) | noshow (S26) | fulfilled Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Appointment date and time (TQ1-7)
Appointment.end	S This element must be supported. Σ This element is included in summaries.	0..1	instant	When appointment is to conclude
Appointment.slot	S This element must be supported.	0..*	Reference(Slot)	The Slot booked (eRS, GP Connect Appointment Management and local booking all book Slots)
Appointment.basedOn	S This element must be supported.	1..*	Reference(Referral Request)	The referral (SCH-26 Referral ID)
Appointment.basedOn.identifier	Σ This element is included in summaries.	0..1	ReferralIdentifier	Logical reference, when literal reference is not known
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	The patient and the appointment provider (AIP-3) Constraints: app-1
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Appointment.participant.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	Appointment	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)
Appointment.identifier	S This element must be supported.	1..*	Identifier	Appointment ID (SCH-2)
Appointment.status	S This element must be supported.	1..1	code	booked (S12/S13) | cancelled (S15) | noshow (S26) | fulfilled
Appointment.serviceType	S This element must be supported.	0..*	CodeableConcept	The specific service that is to be performed during this appointment
Appointment.reasonCode	S This element must be supported.	0..*	CodeableConcept	Coded reason this appointment is scheduled
Appointment.start	S This element must be supported.	1..1	instant	Appointment date and time (TQ1-7)
Appointment.end	S This element must be supported.	0..1	instant	When appointment is to conclude
Appointment.slot	S This element must be supported.	0..*	Reference(Slot)	The Slot booked (eRS, GP Connect Appointment Management and local booking all book Slots)
Appointment.basedOn	S This element must be supported.	1..*	Reference(Referral Request)	The referral (SCH-26 Referral ID)
Appointment.basedOn.identifier		0..1	ReferralIdentifier	Logical reference, when literal reference is not known
Appointment.participant	S This element must be supported.	1..*	BackboneElement	The patient and the appointment provider (AIP-3)
Appointment.participant.actor	S This element must be supported.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	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
Appointment.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Appointment.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Appointment.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
Appointment.contained		0..*	Resource	Contained, inline Resources
Appointment.extension		0..*	Extension	Additional content defined by implementations
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Appointment ID (SCH-2)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	booked (S12/S13) | cancelled (S15) | noshow (S26) | fulfilled Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
Appointment.serviceCategory	Σ This element is included in summaries.	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
Appointment.specialty	Σ This element is included in summaries.	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
Appointment.appointmentType	Σ This element is included in summaries.	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
Appointment.reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
Appointment.description		0..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Appointment date and time (TQ1-7)
Appointment.end	S This element must be supported. Σ This element is included in summaries.	0..1	instant	When appointment is to conclude
Appointment.minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot	S This element must be supported.	0..*	Reference(Slot)	The Slot booked (eRS, GP Connect Appointment Management and local booking all book Slots)
Appointment.created		0..1	dateTime	The date that this appointment was initially created
Appointment.comment		0..1	string	Additional comments
Appointment.patientInstruction		0..1	string	Detailed information and instructions for the patient
Appointment.basedOn	S This element must be supported.	1..*	Reference(Referral Request)	The referral (SCH-26 Referral ID)
Appointment.basedOn.id		0..1	string	Unique id for inter-element referencing
Appointment.basedOn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.basedOn.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Appointment.basedOn.type	Σ This element is included in summaries.	0..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).
Appointment.basedOn.identifier	Σ This element is included in summaries.	0..1	ReferralIdentifier	Logical reference, when literal reference is not known
Appointment.basedOn.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	The patient and the appointment provider (AIP-3) Constraints: app-1
Appointment.participant.id		0..1	string	Unique id for inter-element referencing
Appointment.participant.extension		0..*	Extension	Additional content defined by implementations
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.type	Σ This element is included in summaries.	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Appointment.participant.required	Σ This element is included in summaries.	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.participant.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.participant.period		0..1	Period	Participation period of the actor
Appointment.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.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.serviceCategory	Base	example	Service category	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.0.1	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦3.0.0	THO v7.5
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Appointment.basedOn.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 3 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

• Slot (https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/Slot)
• Referral Request (https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/ReferralRequest)
• Referral Identifier (https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/ReferralIdentifier)