Magentus Practice Management FHIR Implementation Guide
1.2.16 - ci-build

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

## Resource Profile: EBookings Appointment Base ( Abstract )

Official URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-base | Version: 1.2.16
Draft as of 2024-08-15 | Computable Name: EBookingsAppointmentBase

EBookings appointment base that excludes the contained anaesthetic and prosthesis.

Usage:

- Derived from this Resource Profile: EBookings Appointment for a Theatre List and EBookings Appointment

### Formal Views of Profile Content

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

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

This structure is derived from Appointment

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment |  | 0..* | Appointment | This is an abstractprofile. Childprofiles: EBookingsAppointmentForTheatreList, EBookingsAppointment Appointment base
id | S | 0..1 | id | Logical id of this artifact
status | S | 1..1 | code | pending | booked | fulfilled | cancelled
serviceType | S | 0..1 | CodeableConcept | Procedure name
coding |  | 0..0 |  |
text |  | 1..1 | string | Plain text representation of the concept
reasonCode | S | 0..1 | CodeableConcept | Pre-op diagnosis
coding |  | 0..0 |  |
text |  | 1..1 | string | Plain text representation of the concept
Slices for supportingInformation | S | 0..* | Reference(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve()
supportingInformation:anaesthetic | S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ServiceRequest
supportingInformation:prosthesis | S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Device
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 |  | 1..1 | string | Releative reference to the booking service request
identifier | S | 0..1 | Identifier | Booking service request identifier
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
value |  | 1..1 | string | Procedure ID
assigner |  | 1..1 | Reference(Organization) | Organisation that assigned the booking service request identifier
display |  | 1..1 | string | Organisation name
Slices for participant |  | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:type
participant:provider | S | 0..1 | BackboneElement | Primary provider
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
actor |  | 1..1 | Reference(Genie PractitionerRole) | Primary Provider PractitionerRole
reference |  | 0..1 | string | Relative reference to primary provider PractitionerRole
identifier |  | 1..1 | AUMedicareProviderNumber | Medicare Provider Number
display |  | 1..1 | string | Name of primary provider
required |  | 0..1 | code | required Required Pattern: required
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:assistant | S | 0..1 | BackboneElement | Assistant provider
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: assistant
actor |  | 1..1 | Reference(Practitioner) | Assistant Practitioner
reference |  | 0..0 |  |
display |  | 1..1 | string | Name of the assisting provider
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:anaesthetist | S | 0..1 | BackboneElement | Anaesthetist
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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: Anesthesiologist
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: anaesthetist
actor |  | 1..1 | Reference(Practitioner) | Anaesthetist Practitioner
reference |  | 0..0 |  |
display |  | 1..1 | string | Name of Anaesthetist
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:hospital | S | 0..1 | BackboneElement | Hospital the theatre booking is for
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: hospital
actor |  | 1..1 | Reference(Genie HealthcareService) | Hospital HealthcareService
reference |  | 0..1 | string | Relative reference to Hospital HealthcareService
identifier |  | 1..1 | GSHospitalProviderNumber | Hospital provider number
display |  | 1..1 | string | Name of hospital
required |  | 0..1 | code | required Required Pattern: required
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:patient | S | 1..1 | BackboneElement | Patient the theatre booking is for
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: patient
actor |  | 1..1 | Reference(Genie Patient) | Patient
reference |  | 1..1 | string | Relative reference to Patient
required |  | 0..1 | code | required Required Pattern: required
status | S | 1..1 | code | accepted | declined | tentative | needs-action
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | This is an abstractprofile. Childprofiles: EBookingsAppointmentForTheatreList, EBookingsAppointment Appointment base app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id | S Σ | 0..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | 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(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve()
supportingInformation:anaesthetic | S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment
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). Required Pattern: ServiceRequest
supportingInformation:prosthesis | S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment
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). Required Pattern: Device
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 app-1: Either the type or actor on the participant SHALL be specified
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 | S C | 0..1 | BackboneElement | Primary provider app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
actor | Σ | 1..1 | Reference(Genie PractitionerRole) | Primary Provider PractitionerRole
reference | Σ C | 0..1 | string | Relative reference to primary provider PractitionerRole
identifier |  | 1..1 | AUMedicareProviderNumber | Medicare Provider Number
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 | S C | 0..1 | BackboneElement | Assistant provider app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: assistant
actor | Σ | 1..1 | Reference(Practitioner) | 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 | S C | 0..1 | BackboneElement | Anaesthetist app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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: Anesthesiologist
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: anaesthetist
actor | Σ | 1..1 | Reference(Practitioner) | 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:hospital | S C | 0..1 | BackboneElement | Hospital the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: hospital
actor | Σ | 1..1 | Reference(Genie HealthcareService) | Hospital HealthcareService
reference | Σ C | 0..1 | string | Relative reference to 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:patient | S C | 1..1 | BackboneElement | Patient the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: patient
actor | Σ | 1..1 | Reference(Genie 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 | Conformance | ValueSet / Code | URI
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequest `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Device `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:provider.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:provider.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:assistant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anesthesiologist") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:anaesthetist.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:hospital.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:hospital.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:patient.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:patient.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:hospital, 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() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | This is an abstractprofile. Childprofiles: EBookingsAppointmentForTheatreList, EBookingsAppointment Appointment base app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
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: hl7VS-appointmentReasonCodes (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(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve()
supportingInformation:anaesthetic | S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment
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). Required Pattern: ServiceRequest
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
supportingInformation:prosthesis | S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment
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). Required Pattern: Device
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
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 app-1: Either the type or actor on the participant SHALL be specified
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 | S C | 0..1 | BackboneElement | Primary provider app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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(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 | Medicare Provider Number
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 | S C | 0..1 | BackboneElement | Assistant provider app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: assistant
actor | Σ | 1..1 | Reference(Practitioner) | 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
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 | S C | 0..1 | BackboneElement | Anaesthetist app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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: Anesthesiologist
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: anaesthetist
actor | Σ | 1..1 | Reference(Practitioner) | 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
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:hospital | S C | 0..1 | BackboneElement | Hospital the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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
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
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:patient | S C | 1..1 | BackboneElement | Patient the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: patient
actor | Σ | 1..1 | Reference(Genie 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 | Conformance | ValueSet / Code | URI
Appointment.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.cancelationReason | example | AppointmentCancellationReason `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` from the FHIR Standard
Appointment.serviceCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes `http://terminology.hl7.org/ValueSet/v2-0276`
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequest `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Device `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.basedOn.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Appointment.basedOn.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Appointment.basedOn.identifier.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:provider.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:provider.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:provider.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:assistant.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:assistant.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:assistant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anesthesiologist") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:anaesthetist.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:anaesthetist.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:anaesthetist.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:hospital.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:hospital.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:hospital.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:patient.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:patient.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:patient.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:hospital, 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 Appointment

Summary

Mandatory: 6 elements(20 nested mandatory elements)
Must-Support: 23 elements
Prohibited: 4 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)
- EBookings ServiceRequest (http://fhir.geniesolutions.io/StructureDefinition/ebookings-servicerequest)
- Genie PractitionerRole (http://fhir.geniesolutions.io/StructureDefinition/gs-practitionerrole)
- AU Medicare Provider Number (http://hl7.org.au/fhir/StructureDefinition/au-medicareprovidernumber)
- Genie HealthcareService (http://fhir.geniesolutions.io/StructureDefinition/gs-healthcareservice)
- Australian Hospital Provider Number (http://fhir.geniesolutions.io/StructureDefinition/gs-hospitalprovidernumber)
- Genie Patient (http://fhir.geniesolutions.io/StructureDefinition/gs-patient)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Appointment.supportingInformation
- The element 1 is sliced based on the value of Appointment.participant

Differential View

This structure is derived from Appointment

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment |  | 0..* | Appointment | This is an abstractprofile. Childprofiles: EBookingsAppointmentForTheatreList, EBookingsAppointment Appointment base
id | S | 0..1 | id | Logical id of this artifact
status | S | 1..1 | code | pending | booked | fulfilled | cancelled
serviceType | S | 0..1 | CodeableConcept | Procedure name
coding |  | 0..0 |  |
text |  | 1..1 | string | Plain text representation of the concept
reasonCode | S | 0..1 | CodeableConcept | Pre-op diagnosis
coding |  | 0..0 |  |
text |  | 1..1 | string | Plain text representation of the concept
Slices for supportingInformation | S | 0..* | Reference(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve()
supportingInformation:anaesthetic | S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ServiceRequest
supportingInformation:prosthesis | S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Device
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 |  | 1..1 | string | Releative reference to the booking service request
identifier | S | 0..1 | Identifier | Booking service request identifier
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
value |  | 1..1 | string | Procedure ID
assigner |  | 1..1 | Reference(Organization) | Organisation that assigned the booking service request identifier
display |  | 1..1 | string | Organisation name
Slices for participant |  | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:type
participant:provider | S | 0..1 | BackboneElement | Primary provider
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
actor |  | 1..1 | Reference(Genie PractitionerRole) | Primary Provider PractitionerRole
reference |  | 0..1 | string | Relative reference to primary provider PractitionerRole
identifier |  | 1..1 | AUMedicareProviderNumber | Medicare Provider Number
display |  | 1..1 | string | Name of primary provider
required |  | 0..1 | code | required Required Pattern: required
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:assistant | S | 0..1 | BackboneElement | Assistant provider
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: assistant
actor |  | 1..1 | Reference(Practitioner) | Assistant Practitioner
reference |  | 0..0 |  |
display |  | 1..1 | string | Name of the assisting provider
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:anaesthetist | S | 0..1 | BackboneElement | Anaesthetist
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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: Anesthesiologist
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: anaesthetist
actor |  | 1..1 | Reference(Practitioner) | Anaesthetist Practitioner
reference |  | 0..0 |  |
display |  | 1..1 | string | Name of Anaesthetist
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:hospital | S | 0..1 | BackboneElement | Hospital the theatre booking is for
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: hospital
actor |  | 1..1 | Reference(Genie HealthcareService) | Hospital HealthcareService
reference |  | 0..1 | string | Relative reference to Hospital HealthcareService
identifier |  | 1..1 | GSHospitalProviderNumber | Hospital provider number
display |  | 1..1 | string | Name of hospital
required |  | 0..1 | code | required Required Pattern: required
status | S | 1..1 | code | accepted | declined | tentative | needs-action
participant:patient | S | 1..1 | BackboneElement | Patient the theatre booking is for
type |  | 1..1 | CodeableConcept | Role of participant in the appointment Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text |  | 0..1 | string | Plain text representation of the concept Required Pattern: patient
actor |  | 1..1 | Reference(Genie Patient) | Patient
reference |  | 1..1 | string | Relative reference to Patient
required |  | 0..1 | code | required Required Pattern: required
status | S | 1..1 | code | accepted | declined | tentative | needs-action
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | This is an abstractprofile. Childprofiles: EBookingsAppointmentForTheatreList, EBookingsAppointment Appointment base app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id | S Σ | 0..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | 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(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve()
supportingInformation:anaesthetic | S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment
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). Required Pattern: ServiceRequest
supportingInformation:prosthesis | S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment
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). Required Pattern: Device
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 app-1: Either the type or actor on the participant SHALL be specified
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 | S C | 0..1 | BackboneElement | Primary provider app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
actor | Σ | 1..1 | Reference(Genie PractitionerRole) | Primary Provider PractitionerRole
reference | Σ C | 0..1 | string | Relative reference to primary provider PractitionerRole
identifier |  | 1..1 | AUMedicareProviderNumber | Medicare Provider Number
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 | S C | 0..1 | BackboneElement | Assistant provider app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: assistant
actor | Σ | 1..1 | Reference(Practitioner) | 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 | S C | 0..1 | BackboneElement | Anaesthetist app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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: Anesthesiologist
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: anaesthetist
actor | Σ | 1..1 | Reference(Practitioner) | 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:hospital | S C | 0..1 | BackboneElement | Hospital the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: hospital
actor | Σ | 1..1 | Reference(Genie HealthcareService) | Hospital HealthcareService
reference | Σ C | 0..1 | string | Relative reference to 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:patient | S C | 1..1 | BackboneElement | Patient the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
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
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: patient
actor | Σ | 1..1 | Reference(Genie 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 | Conformance | ValueSet / Code | URI
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequest `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Device `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:provider.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:provider.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:assistant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anesthesiologist") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:anaesthetist.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:hospital.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:hospital.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:patient.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:patient.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:hospital, 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() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | This is an abstractprofile. Childprofiles: EBookingsAppointmentForTheatreList, EBookingsAppointment Appointment base app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
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: hl7VS-appointmentReasonCodes (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(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve()
supportingInformation:anaesthetic | S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment
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). Required Pattern: ServiceRequest
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
supportingInformation:prosthesis | S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment
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). Required Pattern: Device
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
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 app-1: Either the type or actor on the participant SHALL be specified
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 | S C | 0..1 | BackboneElement | Primary provider app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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(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 | Medicare Provider Number
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 | S C | 0..1 | BackboneElement | Assistant provider app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: assistant
actor | Σ | 1..1 | Reference(Practitioner) | 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
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 | S C | 0..1 | BackboneElement | Anaesthetist app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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: Anesthesiologist
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: anaesthetist
actor | Σ | 1..1 | Reference(Practitioner) | 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
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:hospital | S C | 0..1 | BackboneElement | Hospital the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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
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
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:patient | S C | 1..1 | BackboneElement | Patient the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 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
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
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: patient
actor | Σ | 1..1 | Reference(Genie 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 | Conformance | ValueSet / Code | URI
Appointment.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.cancelationReason | example | AppointmentCancellationReason `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` from the FHIR Standard
Appointment.serviceCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes `http://terminology.hl7.org/ValueSet/v2-0276`
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequest `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Device `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.basedOn.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Appointment.basedOn.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Appointment.basedOn.identifier.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:provider.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:provider.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:provider.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:assistant.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:assistant.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:assistant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anesthesiologist") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:anaesthetist.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:anaesthetist.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:anaesthetist.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:hospital.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:hospital.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:hospital.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard
Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient") `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant:patient.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant:patient.required | required | Pattern: required `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant:patient.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant, Appointment.participant:provider, Appointment.participant:assistant, Appointment.participant:anaesthetist, Appointment.participant:hospital, 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 Appointment

Summary

Mandatory: 6 elements(20 nested mandatory elements)
Must-Support: 23 elements
Prohibited: 4 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)
- EBookings ServiceRequest (http://fhir.geniesolutions.io/StructureDefinition/ebookings-servicerequest)
- Genie PractitionerRole (http://fhir.geniesolutions.io/StructureDefinition/gs-practitionerrole)
- AU Medicare Provider Number (http://hl7.org.au/fhir/StructureDefinition/au-medicareprovidernumber)
- Genie HealthcareService (http://fhir.geniesolutions.io/StructureDefinition/gs-healthcareservice)
- Australian Hospital Provider Number (http://fhir.geniesolutions.io/StructureDefinition/gs-hospitalprovidernumber)
- Genie Patient (http://fhir.geniesolutions.io/StructureDefinition/gs-patient)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Appointment.supportingInformation
- The element 1 is sliced based on the value of Appointment.participant

Other representations of profile: CSV, Excel, Schematron