Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release Australia

This page is part of the Magentus Practice Management FHIR Implementation Guide (v1.3.2: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: EBookings Appointment Response

Official URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointmentresponse Version: 1.3.2
Active as of 2026-10-02 Computable Name: EBookingsAppointmentResponse

A hospital's or patient's response to a proposed theatre booking. actor identifies the responder — a HealthcareService carrying the hospital provider number, or the patient — and participantStatus conveys the decision: accepted, declined, tentative or needs-action. start carries a counter-proposed operation time with needs-action, or may echo the booked time for information with accepted, and comment a free-text note such as an outstanding admission form.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A response to an EBookings Appointment for a patient or hospital, such as an initial tentative response, acceptance, rejection or needing action (rescheduling)
Constraints: apr-1, ebookings-appointmentresponse-start-end-01
... 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
... appointment SΣ 1..1 Reference(Appointment) Appointment this response relates to
.... reference ΣC 1..1 string Relative reference to Appointment this response relates to
... start S 0..1 instant Counter-proposed date/time with needs-action; informational echo with accepted
... end 0..1 instant End date/time that goes with start. (Only when start is populated)
... participantType SΣ 1..1 CodeableConcept Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 Reference(Genie HealthcareService | EBookings Patient) Hospital GSHealthcareService or EBookingsPatient
.... reference ΣC 0..1 string Relative reference to Patient or HealthcareService
.... type Σ 0..1 uri GSHealthcareService | EBookingsPatient
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 GSHospitalProviderNumber Hospital provider number HealthcareService
.... display Σ 0..1 string Name of hospital when HealthcareService
... participantStatus ?!SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... comment S 0..1 string Participation status notes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AppointmentResponse.​participantType Base extensible Participant type 📍4.0.1 FHIR Std.
AppointmentResponse.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse A resource should have narrative for robust management text.`div`.exists()
ebookings-appointmentresponse-start-end-01 error AppointmentResponse start SHALL be present when end is populated end.exists() implies start.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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A response to an EBookings Appointment for a patient or hospital, such as an initial tentative response, acceptance, rejection or needing action (rescheduling)
Constraints: ebookings-appointmentresponse-start-end-01
... id S 0..1 id Logical id of this artifact
... appointment S 1..1 Reference(Appointment) Appointment this response relates to
.... reference 1..1 string Relative reference to Appointment this response relates to
... start S 0..1 instant Counter-proposed date/time with needs-action; informational echo with accepted
... end 0..1 instant End date/time that goes with start. (Only when start is populated)
... participantType S 1..1 CodeableConcept Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
... actor S 1..1 Reference(Genie HealthcareService | EBookings Patient) Hospital GSHealthcareService or EBookingsPatient
.... reference 0..1 string Relative reference to Patient or HealthcareService
.... type 0..1 uri GSHealthcareService | EBookingsPatient
.... identifier 0..1 GSHospitalProviderNumber Hospital provider number HealthcareService
.... display 0..1 string Name of hospital when HealthcareService
... participantStatus S 1..1 code accepted | declined | tentative | needs-action
... comment S 0..1 string Participation status notes

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ebookings-appointmentresponse-start-end-01 error AppointmentResponse start SHALL be present when end is populated end.exists() implies start.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A response to an EBookings Appointment for a patient or hospital, such as an initial tentative response, acceptance, rejection or needing action (rescheduling)
Constraints: apr-1, ebookings-appointmentresponse-start-end-01
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... appointment SΣ 1..1 Reference(Appointment) Appointment this response relates to
.... 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 Appointment this response relates to
.... 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
... start S 0..1 instant Counter-proposed date/time with needs-action; informational echo with accepted
... end 0..1 instant End date/time that goes with start. (Only when start is populated)
... participantType SΣ 1..1 CodeableConcept Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 Reference(Genie HealthcareService | EBookings Patient) Hospital GSHealthcareService or EBookingsPatient
.... 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 Patient or HealthcareService
.... type Σ 0..1 uri GSHealthcareService | EBookingsPatient
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 GSHospitalProviderNumber Hospital provider number HealthcareService
.... display Σ 0..1 string Name of hospital when HealthcareService
... participantStatus ?!SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... comment S 0..1 string Participation status notes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AppointmentResponse.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
AppointmentResponse.​appointment.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AppointmentResponse.​participantType Base extensible Participant type 📍4.0.1 FHIR Std.
AppointmentResponse.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse A resource should have narrative for robust management text.`div`.exists()
ebookings-appointmentresponse-start-end-01 error AppointmentResponse start SHALL be present when end is populated end.exists() implies start.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A response to an EBookings Appointment for a patient or hospital, such as an initial tentative response, acceptance, rejection or needing action (rescheduling)
Constraints: apr-1, ebookings-appointmentresponse-start-end-01
... 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
... appointment SΣ 1..1 Reference(Appointment) Appointment this response relates to
.... reference ΣC 1..1 string Relative reference to Appointment this response relates to
... start S 0..1 instant Counter-proposed date/time with needs-action; informational echo with accepted
... end 0..1 instant End date/time that goes with start. (Only when start is populated)
... participantType SΣ 1..1 CodeableConcept Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 Reference(Genie HealthcareService | EBookings Patient) Hospital GSHealthcareService or EBookingsPatient
.... reference ΣC 0..1 string Relative reference to Patient or HealthcareService
.... type Σ 0..1 uri GSHealthcareService | EBookingsPatient
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 GSHospitalProviderNumber Hospital provider number HealthcareService
.... display Σ 0..1 string Name of hospital when HealthcareService
... participantStatus ?!SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... comment S 0..1 string Participation status notes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AppointmentResponse.​participantType Base extensible Participant type 📍4.0.1 FHIR Std.
AppointmentResponse.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse A resource should have narrative for robust management text.`div`.exists()
ebookings-appointmentresponse-start-end-01 error AppointmentResponse start SHALL be present when end is populated end.exists() implies start.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A response to an EBookings Appointment for a patient or hospital, such as an initial tentative response, acceptance, rejection or needing action (rescheduling)
Constraints: ebookings-appointmentresponse-start-end-01
... id S 0..1 id Logical id of this artifact
... appointment S 1..1 Reference(Appointment) Appointment this response relates to
.... reference 1..1 string Relative reference to Appointment this response relates to
... start S 0..1 instant Counter-proposed date/time with needs-action; informational echo with accepted
... end 0..1 instant End date/time that goes with start. (Only when start is populated)
... participantType S 1..1 CodeableConcept Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
... actor S 1..1 Reference(Genie HealthcareService | EBookings Patient) Hospital GSHealthcareService or EBookingsPatient
.... reference 0..1 string Relative reference to Patient or HealthcareService
.... type 0..1 uri GSHealthcareService | EBookingsPatient
.... identifier 0..1 GSHospitalProviderNumber Hospital provider number HealthcareService
.... display 0..1 string Name of hospital when HealthcareService
... participantStatus S 1..1 code accepted | declined | tentative | needs-action
... comment S 0..1 string Participation status notes

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ebookings-appointmentresponse-start-end-01 error AppointmentResponse start SHALL be present when end is populated end.exists() implies start.exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A response to an EBookings Appointment for a patient or hospital, such as an initial tentative response, acceptance, rejection or needing action (rescheduling)
Constraints: apr-1, ebookings-appointmentresponse-start-end-01
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... appointment SΣ 1..1 Reference(Appointment) Appointment this response relates to
.... 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 Appointment this response relates to
.... 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
... start S 0..1 instant Counter-proposed date/time with needs-action; informational echo with accepted
... end 0..1 instant End date/time that goes with start. (Only when start is populated)
... participantType SΣ 1..1 CodeableConcept Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 Reference(Genie HealthcareService | EBookings Patient) Hospital GSHealthcareService or EBookingsPatient
.... 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 Patient or HealthcareService
.... type Σ 0..1 uri GSHealthcareService | EBookingsPatient
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 GSHospitalProviderNumber Hospital provider number HealthcareService
.... display Σ 0..1 string Name of hospital when HealthcareService
... participantStatus ?!SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... comment S 0..1 string Participation status notes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AppointmentResponse.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
AppointmentResponse.​appointment.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AppointmentResponse.​participantType Base extensible Participant type 📍4.0.1 FHIR Std.
AppointmentResponse.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse A resource should have narrative for robust management text.`div`.exists()
ebookings-appointmentresponse-start-end-01 error AppointmentResponse start SHALL be present when end is populated end.exists() implies start.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()

 

Other representations of profile: CSV, Excel, Schematron