Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: EBookings Appointment

EBookings Appointment Profile

Usages:

• Refer to this Profile: EBooking Difference Between Appointment Versions
• Examples for this Profile: Appointment/840fdd86-f273-4c56-89af-cc5dcda592ab

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..*	EBookingsAppointmentBase	Appointment base Constraints: app-2, app-3, app-4
id	SΣ	0..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:anaesthetic	S	0..1	EBookingsAnaestheticRequest	A request for a service to be performed
contained:prosthesis	S	0..1	EBookingsProsthesis	Item used in healthcare
Slices for extension				Content/Rules for all slices
extension:lastModified	S	0..1	dateTime	EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceType	SΣ	0..1	CodeableConcept	Procedure name Binding: ServiceType (example)
text	Σ	1..1	string	Plain text representation of the concept
reasonCode	SΣ	0..1	CodeableConcept	Pre-op diagnosis Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
text	Σ	1..1	string	Plain text representation of the concept
Slices for supportingInformation	S	0..*	Reference(ServiceRequest | Device | DocumentReference)	Anaesthetic and prosthesis information Slice: Unordered, Open by profile:$this.resolve()
supportingInformation:anaesthetic	S	0..1	Reference(EBookings Anaesthetic Request)	Additional information to support the appointment
supportingInformation:prosthesis	S	0..1	Reference(EBookings Prosthesis Device)	Additional information to support the appointment
supportingInformation:pdf	S	0..*	Reference(EBookings PDF)	Additional information to support the appointment
start	SΣ	0..1	instant	Proposed operation date/time
end	SΣ	0..1	instant	Proposed operation end date/time. (Required when start is populated)
comment	S	0..1	string	Pre-op notes
patientInstruction	S	0..1	string	Fast from instructions
basedOn	S	1..1	Reference(EBookings ServiceRequest)	Service request this theatre booking is for
reference	ΣC	1..1	string	Releative reference to the booking service request
identifier	SΣ	0..1	Identifier	Booking service request identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	System identifier of the organisation that assigned the booking service request identifier, preferably a HPI-O scoped local order identifier system. For example http://ns.electronichealth.net.au/id/hpio-scoped/order/1.0/8003620000000000 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Procedure ID Example General: 123456
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the booking service request identifier
display	Σ	1..1	string	Organisation name
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:type Constraints: app-1
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:provider	SC	0..1	BackboneElement	Primary provider Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPRF
display		1..1	string	Representation defined by the system Fixed Value: primary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(EBookings VMO | Genie PractitionerRole)	Primary Provider PractitionerRole
identifier	Σ	1..1	AUMedicareProviderNumber	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of primary provider
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:assistant	SC	0..1	BackboneElement	Assistant provider Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SPRF
display		1..1	string	Representation defined by the system Fixed Value: secondary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: assistant
actor	Σ	1..1	Reference(PractitionerRole)	Assistant Practitioner
display	Σ	1..1	string	Name of the assisting provider
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:anaesthetist	SC	0..1	BackboneElement	Anaesthetist Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 88189002
display		1..1	string	Representation defined by the system Fixed Value: Anaesthetist
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: anaesthetist
actor	Σ	1..1	Reference(PractitionerRole)	Anaesthetist Practitioner
display	Σ	1..1	string	Name of Anaesthetist
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:paediatrician	SC	0..1	BackboneElement	Paediatrician Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82296001
display		1..1	string	Representation defined by the system Fixed Value: Paediatrician
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(PractitionerRole)	Person, Location/HealthcareService or Device
display	Σ	1..1	string	Text alternative for the resource
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:hospital	SC	0..1	BackboneElement	Hospital the theatre booking is for Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 22232009
display		1..1	string	Representation defined by the system Fixed Value: Hospital
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: hospital
actor	Σ	1..1	Reference(Genie HealthcareService)	Hospital HealthcareService
identifier	Σ	1..1	GSHospitalProviderNumber	Hospital provider number
display	Σ	1..1	string	Name of hospital
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:icu	SC	0..1	BackboneElement	ICU bed required Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 309904001
display		1..1	string	Representation defined by the system Fixed Value: Intensive care unit
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Location)	Person, Location/HealthcareService or Device
display	Σ	1..1	string	Text alternative for the resource
required	SΣ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:patient	SC	1..1	BackboneElement	Patient the theatre booking is for Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 116154003
display		1..1	string	Representation defined by the system Fixed Value: Patient
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: patient
actor	Σ	1..1	Reference(EBookings Patient)	Patient
reference	ΣC	1..1	string	Relative reference to Patient
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	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.basedOn.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:provider.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:provider.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:provider.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:icu.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:icu.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:icu.​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.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:paediatrician, Appointment.participant:hospital, Appointment.participant:icu, Appointment.participant:patient	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 EBookingsAppointmentBase

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	EBookingsAppointmentBase	Appointment base
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:anaesthetic	S	0..1	EBookingsAnaestheticRequest	A request for a service to be performed
contained:prosthesis	S	0..1	EBookingsProsthesis	Item used in healthcare
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	EBookingsAppointmentBase	Appointment base Constraints: app-2, app-3, app-4
id	SΣ	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:anaesthetic	S	0..1	EBookingsAnaestheticRequest	A request for a service to be performed
contained:prosthesis	S	0..1	EBookingsProsthesis	Item used in healthcare
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:lastModified	S	0..1	dateTime	EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!SΣ	1..1	code	pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment.
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	SΣ	0..1	CodeableConcept	Procedure name Binding: ServiceType (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	1..1	string	Plain text representation of the concept
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: Hl7VSAppointmentReasonCodes (3.0.0) (preferred)
reasonCode	SΣ	0..1	CodeableConcept	Pre-op diagnosis Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	1..1	string	Plain text representation of the concept
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
Slices for supportingInformation	S	0..*	Reference(ServiceRequest | Device | DocumentReference)	Anaesthetic and prosthesis information Slice: Unordered, Open by profile:$this.resolve()
supportingInformation:anaesthetic	S	0..1	Reference(EBookings Anaesthetic Request)	Additional information to support the appointment
supportingInformation:prosthesis	S	0..1	Reference(EBookings Prosthesis Device)	Additional information to support the appointment
supportingInformation:pdf	S	0..*	Reference(EBookings PDF)	Additional information to support the appointment
start	SΣ	0..1	instant	Proposed operation date/time
end	SΣ	0..1	instant	Proposed operation end date/time. (Required when start is populated)
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	S	0..1	string	Pre-op notes
patientInstruction	S	0..1	string	Fast from instructions
basedOn	S	1..1	Reference(EBookings ServiceRequest)	Service request this theatre booking is for
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	1..1	string	Releative reference to the booking service request
type	Σ	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).
identifier	SΣ	0..1	Identifier	Booking service request identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	System identifier of the organisation that assigned the booking service request identifier, preferably a HPI-O scoped local order identifier system. For example http://ns.electronichealth.net.au/id/hpio-scoped/order/1.0/8003620000000000 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Procedure ID Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the booking service request identifier
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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Organisation name
display	Σ	0..1	string	Text alternative for the resource
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value: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.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:provider	SC	0..1	BackboneElement	Primary provider 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPRF
display		1..1	string	Representation defined by the system Fixed Value: primary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(EBookings VMO | Genie PractitionerRole)	Primary Provider PractitionerRole
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	Relative reference to primary provider PractitionerRole
type	Σ	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).
identifier	Σ	1..1	AUMedicareProviderNumber	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of primary provider
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:assistant	SC	0..1	BackboneElement	Assistant provider 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SPRF
display		1..1	string	Representation defined by the system Fixed Value: secondary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: assistant
actor	Σ	1..1	Reference(PractitionerRole)	Assistant Practitioner
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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of the assisting provider
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.
period		0..1	Period	Participation period of the actor
participant:anaesthetist	SC	0..1	BackboneElement	Anaesthetist 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 88189002
display		1..1	string	Representation defined by the system Fixed Value: Anaesthetist
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: anaesthetist
actor	Σ	1..1	Reference(PractitionerRole)	Anaesthetist Practitioner
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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of Anaesthetist
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.
period		0..1	Period	Participation period of the actor
participant:paediatrician	SC	0..1	BackboneElement	Paediatrician 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82296001
display		1..1	string	Representation defined by the system Fixed Value: Paediatrician
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(PractitionerRole)	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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..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.
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:hospital	SC	0..1	BackboneElement	Hospital the theatre booking is for 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 22232009
display		1..1	string	Representation defined by the system Fixed Value: Hospital
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: hospital
actor	Σ	1..1	Reference(Genie HealthcareService)	Hospital HealthcareService
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	Relative reference to Hospital HealthcareService
type	Σ	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).
identifier	Σ	1..1	GSHospitalProviderNumber	Hospital provider number
display	Σ	1..1	string	Name of hospital
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:icu	SC	0..1	BackboneElement	ICU bed required 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 309904001
display		1..1	string	Representation defined by the system Fixed Value: Intensive care unit
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
required	SΣ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:patient	SC	1..1	BackboneElement	Patient the theatre booking is for 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 116154003
display		1..1	string	Representation defined by the system Fixed Value: Patient
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: patient
actor	Σ	1..1	Reference(EBookings Patient)	Patient
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	1..1	string	Relative reference to Patient
type	Σ	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).
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 Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
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.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.1
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Appointment.basedOn.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.basedOn.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.basedOn.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.basedOn.​identifier.assigner.​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.
Appointment.participant:provider.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:provider.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:provider.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:provider.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:icu.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:icu.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:icu.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:icu.​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.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:paediatrician, Appointment.participant:hospital, Appointment.participant:icu, Appointment.participant:patient	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 EBookingsAppointmentBase

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

• EBookings Anaesthetic Request (http://fhir.geniesolutions.io/StructureDefinition/ebookings-anaestheticrequest)
• EBookings Prosthesis Device (http://fhir.geniesolutions.io/StructureDefinition/ebookings-prosthesis)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Appointment.contained (Closed)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	EBookingsAppointmentBase	Appointment base Constraints: app-2, app-3, app-4
id	SΣ	0..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:anaesthetic	S	0..1	EBookingsAnaestheticRequest	A request for a service to be performed
contained:prosthesis	S	0..1	EBookingsProsthesis	Item used in healthcare
Slices for extension				Content/Rules for all slices
extension:lastModified	S	0..1	dateTime	EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceType	SΣ	0..1	CodeableConcept	Procedure name Binding: ServiceType (example)
text	Σ	1..1	string	Plain text representation of the concept
reasonCode	SΣ	0..1	CodeableConcept	Pre-op diagnosis Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
text	Σ	1..1	string	Plain text representation of the concept
Slices for supportingInformation	S	0..*	Reference(ServiceRequest | Device | DocumentReference)	Anaesthetic and prosthesis information Slice: Unordered, Open by profile:$this.resolve()
supportingInformation:anaesthetic	S	0..1	Reference(EBookings Anaesthetic Request)	Additional information to support the appointment
supportingInformation:prosthesis	S	0..1	Reference(EBookings Prosthesis Device)	Additional information to support the appointment
supportingInformation:pdf	S	0..*	Reference(EBookings PDF)	Additional information to support the appointment
start	SΣ	0..1	instant	Proposed operation date/time
end	SΣ	0..1	instant	Proposed operation end date/time. (Required when start is populated)
comment	S	0..1	string	Pre-op notes
patientInstruction	S	0..1	string	Fast from instructions
basedOn	S	1..1	Reference(EBookings ServiceRequest)	Service request this theatre booking is for
reference	ΣC	1..1	string	Releative reference to the booking service request
identifier	SΣ	0..1	Identifier	Booking service request identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	System identifier of the organisation that assigned the booking service request identifier, preferably a HPI-O scoped local order identifier system. For example http://ns.electronichealth.net.au/id/hpio-scoped/order/1.0/8003620000000000 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Procedure ID Example General: 123456
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the booking service request identifier
display	Σ	1..1	string	Organisation name
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:type Constraints: app-1
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:provider	SC	0..1	BackboneElement	Primary provider Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPRF
display		1..1	string	Representation defined by the system Fixed Value: primary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(EBookings VMO | Genie PractitionerRole)	Primary Provider PractitionerRole
identifier	Σ	1..1	AUMedicareProviderNumber	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of primary provider
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:assistant	SC	0..1	BackboneElement	Assistant provider Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SPRF
display		1..1	string	Representation defined by the system Fixed Value: secondary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: assistant
actor	Σ	1..1	Reference(PractitionerRole)	Assistant Practitioner
display	Σ	1..1	string	Name of the assisting provider
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:anaesthetist	SC	0..1	BackboneElement	Anaesthetist Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 88189002
display		1..1	string	Representation defined by the system Fixed Value: Anaesthetist
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: anaesthetist
actor	Σ	1..1	Reference(PractitionerRole)	Anaesthetist Practitioner
display	Σ	1..1	string	Name of Anaesthetist
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:paediatrician	SC	0..1	BackboneElement	Paediatrician Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82296001
display		1..1	string	Representation defined by the system Fixed Value: Paediatrician
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(PractitionerRole)	Person, Location/HealthcareService or Device
display	Σ	1..1	string	Text alternative for the resource
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:hospital	SC	0..1	BackboneElement	Hospital the theatre booking is for Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 22232009
display		1..1	string	Representation defined by the system Fixed Value: Hospital
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: hospital
actor	Σ	1..1	Reference(Genie HealthcareService)	Hospital HealthcareService
identifier	Σ	1..1	GSHospitalProviderNumber	Hospital provider number
display	Σ	1..1	string	Name of hospital
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:icu	SC	0..1	BackboneElement	ICU bed required Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 309904001
display		1..1	string	Representation defined by the system Fixed Value: Intensive care unit
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Location)	Person, Location/HealthcareService or Device
display	Σ	1..1	string	Text alternative for the resource
required	SΣ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:patient	SC	1..1	BackboneElement	Patient the theatre booking is for Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 116154003
display		1..1	string	Representation defined by the system Fixed Value: Patient
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: patient
actor	Σ	1..1	Reference(EBookings Patient)	Patient
reference	ΣC	1..1	string	Relative reference to Patient
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	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.basedOn.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:provider.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:provider.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:provider.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:icu.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:icu.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:icu.​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.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:paediatrician, Appointment.participant:hospital, Appointment.participant:icu, Appointment.participant:patient	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 EBookingsAppointmentBase

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	EBookingsAppointmentBase	Appointment base
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:anaesthetic	S	0..1	EBookingsAnaestheticRequest	A request for a service to be performed
contained:prosthesis	S	0..1	EBookingsProsthesis	Item used in healthcare
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	EBookingsAppointmentBase	Appointment base Constraints: app-2, app-3, app-4
id	SΣ	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:anaesthetic	S	0..1	EBookingsAnaestheticRequest	A request for a service to be performed
contained:prosthesis	S	0..1	EBookingsProsthesis	Item used in healthcare
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:lastModified	S	0..1	dateTime	EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!SΣ	1..1	code	pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment.
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	SΣ	0..1	CodeableConcept	Procedure name Binding: ServiceType (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	1..1	string	Plain text representation of the concept
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: Hl7VSAppointmentReasonCodes (3.0.0) (preferred)
reasonCode	SΣ	0..1	CodeableConcept	Pre-op diagnosis Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	1..1	string	Plain text representation of the concept
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
Slices for supportingInformation	S	0..*	Reference(ServiceRequest | Device | DocumentReference)	Anaesthetic and prosthesis information Slice: Unordered, Open by profile:$this.resolve()
supportingInformation:anaesthetic	S	0..1	Reference(EBookings Anaesthetic Request)	Additional information to support the appointment
supportingInformation:prosthesis	S	0..1	Reference(EBookings Prosthesis Device)	Additional information to support the appointment
supportingInformation:pdf	S	0..*	Reference(EBookings PDF)	Additional information to support the appointment
start	SΣ	0..1	instant	Proposed operation date/time
end	SΣ	0..1	instant	Proposed operation end date/time. (Required when start is populated)
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	S	0..1	string	Pre-op notes
patientInstruction	S	0..1	string	Fast from instructions
basedOn	S	1..1	Reference(EBookings ServiceRequest)	Service request this theatre booking is for
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	1..1	string	Releative reference to the booking service request
type	Σ	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).
identifier	SΣ	0..1	Identifier	Booking service request identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	System identifier of the organisation that assigned the booking service request identifier, preferably a HPI-O scoped local order identifier system. For example http://ns.electronichealth.net.au/id/hpio-scoped/order/1.0/8003620000000000 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Procedure ID Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the booking service request identifier
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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Organisation name
display	Σ	0..1	string	Text alternative for the resource
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value: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.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:provider	SC	0..1	BackboneElement	Primary provider 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPRF
display		1..1	string	Representation defined by the system Fixed Value: primary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(EBookings VMO | Genie PractitionerRole)	Primary Provider PractitionerRole
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	Relative reference to primary provider PractitionerRole
type	Σ	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).
identifier	Σ	1..1	AUMedicareProviderNumber	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of primary provider
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:assistant	SC	0..1	BackboneElement	Assistant provider 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SPRF
display		1..1	string	Representation defined by the system Fixed Value: secondary performer
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: assistant
actor	Σ	1..1	Reference(PractitionerRole)	Assistant Practitioner
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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of the assisting provider
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.
period		0..1	Period	Participation period of the actor
participant:anaesthetist	SC	0..1	BackboneElement	Anaesthetist 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 88189002
display		1..1	string	Representation defined by the system Fixed Value: Anaesthetist
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: anaesthetist
actor	Σ	1..1	Reference(PractitionerRole)	Anaesthetist Practitioner
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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of Anaesthetist
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.
period		0..1	Period	Participation period of the actor
participant:paediatrician	SC	0..1	BackboneElement	Paediatrician 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 82296001
display		1..1	string	Representation defined by the system Fixed Value: Paediatrician
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(PractitionerRole)	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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..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.
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:hospital	SC	0..1	BackboneElement	Hospital the theatre booking is for 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 22232009
display		1..1	string	Representation defined by the system Fixed Value: Hospital
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: hospital
actor	Σ	1..1	Reference(Genie HealthcareService)	Hospital HealthcareService
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	Relative reference to Hospital HealthcareService
type	Σ	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).
identifier	Σ	1..1	GSHospitalProviderNumber	Hospital provider number
display	Σ	1..1	string	Name of hospital
required	Σ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:icu	SC	0..1	BackboneElement	ICU bed required 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 309904001
display		1..1	string	Representation defined by the system Fixed Value: Intensive care unit
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..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	Σ	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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
required	SΣ	0..1	code	required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:patient	SC	1..1	BackboneElement	Patient the theatre booking is for 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	Σ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 116154003
display		1..1	string	Representation defined by the system Fixed Value: Patient
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: patient
actor	Σ	1..1	Reference(EBookings Patient)	Patient
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	1..1	string	Relative reference to Patient
type	Σ	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).
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 Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
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.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.1
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Appointment.basedOn.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.basedOn.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.basedOn.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.basedOn.​identifier.assigner.​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.
Appointment.participant:provider.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:provider.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:provider.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:provider.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:assistant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:anaesthetist.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:paediatrician.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:hospital.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:icu.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant:icu.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:icu.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:icu.​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.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:paediatrician, Appointment.participant:hospital, Appointment.participant:icu, Appointment.participant:patient	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 EBookingsAppointmentBase

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

• EBookings Anaesthetic Request (http://fhir.geniesolutions.io/StructureDefinition/ebookings-anaestheticrequest)
• EBookings Prosthesis Device (http://fhir.geniesolutions.io/StructureDefinition/ebookings-prosthesis)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Appointment.contained (Closed)