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 Response

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

Genie EBookings Appointment Response Profile

Usage:

- Examples for this Resource Profile: AppointmentResponse/bd1efd6a-e035-4fa8-b539-f0939de7c5ed

### 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 AppointmentResponse

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AppointmentResponse |  | 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)
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 | Date/time of operation, or requested new date/time
participantType | S | 1..1 | CodeableConcept | Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
actor | S | 1..1 | Reference(Genie HealthcareService | Genie Patient) | Hospital GSHealthcareService or GSPatient
reference |  | 0..1 | string | Relative reference to Patient or HealthcareService
type |  | 0..1 | uri | GSHealthcareService | GSPatient
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
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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) apr-1: Either the participantType or actor must be specified
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 | Date/time of operation, or requested new date/time
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 | Genie Patient) | Hospital GSHealthcareService or GSPatient
reference | Σ C | 0..1 | string | Relative reference to Patient or HealthcareService
type | Σ | 0..1 | uri | GSHealthcareService | GSPatient 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AppointmentResponse.participantType | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
AppointmentResponse.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AppointmentResponse.participantStatus | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
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
--- | --- | --- | --- | ---
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) apr-1: Either the participantType or actor must be specified
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
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 | Date/time of operation, or requested new date/time
end |  | 0..1 | instant | Time from appointment, or requested new end time
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 | Genie Patient) | Hospital GSHealthcareService or GSPatient
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 | GSPatient 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AppointmentResponse.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
AppointmentResponse.appointment.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AppointmentResponse.participantType | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
AppointmentResponse.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AppointmentResponse.participantStatus | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
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 AppointmentResponse

Summary

Mandatory: 3 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

- Genie HealthcareService (http://fhir.geniesolutions.io/StructureDefinition/gs-healthcareservice)
- Genie Patient (http://fhir.geniesolutions.io/StructureDefinition/gs-patient)
- Australian Hospital Provider Number (http://fhir.geniesolutions.io/StructureDefinition/gs-hospitalprovidernumber)

Differential View

This structure is derived from AppointmentResponse

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AppointmentResponse |  | 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)
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 | Date/time of operation, or requested new date/time
participantType | S | 1..1 | CodeableConcept | Hospital - http://snomed.info/sct#22232009 | Patient - http://snomed.info/sct#116154003
actor | S | 1..1 | Reference(Genie HealthcareService | Genie Patient) | Hospital GSHealthcareService or GSPatient
reference |  | 0..1 | string | Relative reference to Patient or HealthcareService
type |  | 0..1 | uri | GSHealthcareService | GSPatient
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
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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) apr-1: Either the participantType or actor must be specified
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 | Date/time of operation, or requested new date/time
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 | Genie Patient) | Hospital GSHealthcareService or GSPatient
reference | Σ C | 0..1 | string | Relative reference to Patient or HealthcareService
type | Σ | 0..1 | uri | GSHealthcareService | GSPatient 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AppointmentResponse.participantType | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
AppointmentResponse.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AppointmentResponse.participantStatus | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
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
--- | --- | --- | --- | ---
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) apr-1: Either the participantType or actor must be specified
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
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 | Date/time of operation, or requested new date/time
end |  | 0..1 | instant | Time from appointment, or requested new end time
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 | Genie Patient) | Hospital GSHealthcareService or GSPatient
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 | GSPatient 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AppointmentResponse.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
AppointmentResponse.appointment.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AppointmentResponse.participantType | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
AppointmentResponse.actor.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AppointmentResponse.participantStatus | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
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 AppointmentResponse

Summary

Mandatory: 3 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

- Genie HealthcareService (http://fhir.geniesolutions.io/StructureDefinition/gs-healthcareservice)
- Genie Patient (http://fhir.geniesolutions.io/StructureDefinition/gs-patient)
- Australian Hospital Provider Number (http://fhir.geniesolutions.io/StructureDefinition/gs-hospitalprovidernumber)

Other representations of profile: CSV, Excel, Schematron