Magentus Practice Management FHIR Implementation Guide
1.2.35 - ci-build
Magentus Practice Management FHIR Implementation Guide
1.2.35 - ci-build
Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.35) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment | Version: 1.2.35 | |||
| Draft as of 2025-03-02 | Computable Name: EBookingsAppointment | |||
EBookings Appointment Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment |
C | 0..* | EBookingsAppointmentBase | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
  id |
SΣ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
   contained:anaesthetic |
S | 0..1 | EBookingsAnaestheticRequest | A request for a service to be performed |
 contained:prosthesis |
S | 0..1 | EBookingsProsthesis | Item used in healthcare |
| Slices for extension |
Content/Rules for all slices | |||
| extension:lastModified |
S | 0..1 | dateTime | EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!SΣ | 1..1 | code | pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
 serviceType |
SΣ | 0..1 | CodeableConcept | Procedure name Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children |
 text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Pre-op diagnosis Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| Slices for supportingInformation |
S | 0..* | Reference(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve() ele-1: All FHIR elements must have a @value or children |
| supportingInformation:anaesthetic |
S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment ele-1: All FHIR elements must have a @value or children |
  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). ele-1: All FHIR elements must have a @value or children Required Pattern: ServiceRequest |
| supportingInformation:prosthesis |
S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment ele-1: All FHIR elements must have a @value or children |
 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). ele-1: All FHIR elements must have a @value or children Required Pattern: Device |
| start |
SΣ | 0..1 | instant | Proposed operation date/time ele-1: All FHIR elements must have a @value or children |
| end |
SΣ | 0..1 | instant | Proposed operation end date/time. (Required when start is populated) ele-1: All FHIR elements must have a @value or children |
| comment |
S | 0..1 | string | Pre-op notes ele-1: All FHIR elements must have a @value or children |
| patientInstruction |
S | 0..1 | string | Fast from instructions ele-1: All FHIR elements must have a @value or children |
 basedOn |
S | 1..1 | Reference(EBookings ServiceRequest) | Service request this theatre booking is for ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Releative reference to the booking service request ele-1: All FHIR elements must have a @value or children |
| identifier |
SΣ | 0..1 | Identifier | Booking service request identifier ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| 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 ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | Procedure ID ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
Σ | 1..1 | Reference(Organization) | Organisation that assigned the booking service request identifier ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Organisation name ele-1: All FHIR elements must have a @value or children |
| 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 ele-1: All FHIR elements must have a @value or children |
 participant:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:provider |
SC | 0..1 | BackboneElement | Primary provider app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 1..1 | AUMedicareProviderNumber | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of primary provider ele-1: All FHIR elements must have a @value or children |
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children Required Pattern: required |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:assistant |
SC | 0..1 | BackboneElement | Assistant provider app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children Required Pattern: assistant |
| actor |
Σ | 1..1 | Reference(Practitioner) | Assistant Practitioner ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of the assisting provider ele-1: All FHIR elements must have a @value or children |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:anaesthetist |
SC | 0..1 | BackboneElement | Anaesthetist app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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: Anaesthetist | |
| text |
Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: anaesthetist |
| actor |
Σ | 1..1 | Reference(Practitioner) | Anaesthetist Practitioner ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of Anaesthetist ele-1: All FHIR elements must have a @value or children |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:hospital |
SC | 0..1 | BackboneElement | Hospital the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children Required Pattern: hospital |
| actor |
Σ | 1..1 | Reference(Genie HealthcareService) | Hospital HealthcareService ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 1..1 | GSHospitalProviderNumber | Hospital provider number ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of hospital ele-1: All FHIR elements must have a @value or children |
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children Required Pattern: required |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:patient |
SC | 1..1 | BackboneElement | Patient the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children Required Pattern: patient |
| actor |
Σ | 1..1 | Reference(Genie Patient) | Patient ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Relative reference to Patient ele-1: All FHIR elements must have a @value or children |
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children Required Pattern: required |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequesthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Devicehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Appointment.basedOn.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:provider.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | |
| Appointment.participant:provider.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:assistant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anaesthetist")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:anaesthetist.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:hospital.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | |
| Appointment.participant:hospital.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:patient.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | |
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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 EBookingsAppointmentBase
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
0..* | EBookingsAppointmentBase | Appointment base | |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:anaesthetic |
S | 0..1 | EBookingsAnaestheticRequest | A request for a service to be performed |
| contained:prosthesis |
S | 0..1 | EBookingsProsthesis | Item used in healthcare |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | EBookingsAppointmentBase | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
| contained:anaesthetic |
S | 0..1 | EBookingsAnaestheticRequest | A request for a service to be performed | ||||
| contained:prosthesis |
S | 0..1 | EBookingsProsthesis | Item used in healthcare | ||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:lastModified |
S | 0..1 | dateTime | EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!SΣ | 1..1 | code | pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancelationReason |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
SΣ | 0..1 | CodeableConcept | Procedure name Binding: ServiceType (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: 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 |
SC | 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 | Logical reference, when literal reference is not known | ||||
| display |
Σ | 1..1 | string | Name of primary provider | ||||
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required | ||||
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:assistant |
SC | 0..1 | BackboneElement | Assistant provider 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 |
SC | 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: Anaesthetist | |||||
| 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 |
SC | 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 |
SC | 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Appointment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequesthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Devicehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.basedOn.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.basedOn.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Appointment.basedOn.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Appointment.basedOn.identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:provider.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:provider.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:provider.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:assistant.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:assistant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:assistant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anaesthetist")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:anaesthetist.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:anaesthetist.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:anaesthetist.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:hospital.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:hospital.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:hospital.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:patient.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:patient.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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 EBookingsAppointmentBase
Summary
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
C | 0..* | EBookingsAppointmentBase | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:anaesthetic |
S | 0..1 | EBookingsAnaestheticRequest | A request for a service to be performed |
| contained:prosthesis |
S | 0..1 | EBookingsProsthesis | Item used in healthcare |
| Slices for extension |
Content/Rules for all slices | |||
| extension:lastModified |
S | 0..1 | dateTime | EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!SΣ | 1..1 | code | pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
| serviceType |
SΣ | 0..1 | CodeableConcept | Procedure name Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Pre-op diagnosis Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| Slices for supportingInformation |
S | 0..* | Reference(Resource) | Anaesthetic and prosthesis information Slice: Unordered, Open by type:$this.resolve() ele-1: All FHIR elements must have a @value or children |
| supportingInformation:anaesthetic |
S | 0..1 | Reference(EBookings Anaesthetic Request) | Additional information to support the appointment ele-1: All FHIR elements must have a @value or children |
| 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). ele-1: All FHIR elements must have a @value or children Required Pattern: ServiceRequest |
| supportingInformation:prosthesis |
S | 0..1 | Reference(EBookings Prosthesis Device) | Additional information to support the appointment ele-1: All FHIR elements must have a @value or children |
| 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). ele-1: All FHIR elements must have a @value or children Required Pattern: Device |
| start |
SΣ | 0..1 | instant | Proposed operation date/time ele-1: All FHIR elements must have a @value or children |
| end |
SΣ | 0..1 | instant | Proposed operation end date/time. (Required when start is populated) ele-1: All FHIR elements must have a @value or children |
| comment |
S | 0..1 | string | Pre-op notes ele-1: All FHIR elements must have a @value or children |
| patientInstruction |
S | 0..1 | string | Fast from instructions ele-1: All FHIR elements must have a @value or children |
| basedOn |
S | 1..1 | Reference(EBookings ServiceRequest) | Service request this theatre booking is for ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Releative reference to the booking service request ele-1: All FHIR elements must have a @value or children |
| identifier |
SΣ | 0..1 | Identifier | Booking service request identifier ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| 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 ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | Procedure ID ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
Σ | 1..1 | Reference(Organization) | Organisation that assigned the booking service request identifier ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Organisation name ele-1: All FHIR elements must have a @value or children |
| 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 ele-1: All FHIR elements must have a @value or children |
| participant:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:provider |
SC | 0..1 | BackboneElement | Primary provider app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 1..1 | AUMedicareProviderNumber | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of primary provider ele-1: All FHIR elements must have a @value or children |
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children Required Pattern: required |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:assistant |
SC | 0..1 | BackboneElement | Assistant provider app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children Required Pattern: assistant |
| actor |
Σ | 1..1 | Reference(Practitioner) | Assistant Practitioner ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of the assisting provider ele-1: All FHIR elements must have a @value or children |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:anaesthetist |
SC | 0..1 | BackboneElement | Anaesthetist app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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: Anaesthetist | |
| text |
Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: anaesthetist |
| actor |
Σ | 1..1 | Reference(Practitioner) | Anaesthetist Practitioner ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of Anaesthetist ele-1: All FHIR elements must have a @value or children |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:hospital |
SC | 0..1 | BackboneElement | Hospital the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children Required Pattern: hospital |
| actor |
Σ | 1..1 | Reference(Genie HealthcareService) | Hospital HealthcareService ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 1..1 | GSHospitalProviderNumber | Hospital provider number ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 1..1 | string | Name of hospital ele-1: All FHIR elements must have a @value or children |
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children Required Pattern: required |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| participant:patient |
SC | 1..1 | BackboneElement | Patient the theatre booking is for app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children Required Pattern: patient |
| actor |
Σ | 1..1 | Reference(Genie Patient) | Patient ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Relative reference to Patient ele-1: All FHIR elements must have a @value or children |
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children Required Pattern: required |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequesthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Devicehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Appointment.basedOn.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:provider.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | |
| Appointment.participant:provider.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:assistant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anaesthetist")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:anaesthetist.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:hospital.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | |
| Appointment.participant:hospital.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | |
| Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant:patient.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | |
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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() |
Differential View
This structure is derived from EBookingsAppointmentBase
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
0..* | EBookingsAppointmentBase | Appointment base | |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:anaesthetic |
S | 0..1 | EBookingsAnaestheticRequest | A request for a service to be performed |
| contained:prosthesis |
S | 0..1 | EBookingsProsthesis | Item used in healthcare |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | EBookingsAppointmentBase | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
| contained:anaesthetic |
S | 0..1 | EBookingsAnaestheticRequest | A request for a service to be performed | ||||
| contained:prosthesis |
S | 0..1 | EBookingsProsthesis | Item used in healthcare | ||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:lastModified |
S | 0..1 | dateTime | EBookings Appointment lastModified Extension URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-appointment-lastModified-ext | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!SΣ | 1..1 | code | pending | booked | fulfilled | cancelled Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancelationReason |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
SΣ | 0..1 | CodeableConcept | Procedure name Binding: ServiceType (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: 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 |
SC | 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 | Logical reference, when literal reference is not known | ||||
| display |
Σ | 1..1 | string | Name of primary provider | ||||
| required |
Σ | 0..1 | code | required Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. Required Pattern: required | ||||
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:assistant |
SC | 0..1 | BackboneElement | Assistant provider 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 |
SC | 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: Anaesthetist | |||||
| 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 |
SC | 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 |
SC | 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Appointment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.supportingInformation:anaesthetic.type | extensible | Pattern: ServiceRequesthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.supportingInformation:prosthesis.type | extensible | Pattern: Devicehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.basedOn.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.basedOn.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Appointment.basedOn.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Appointment.basedOn.identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:provider.type | extensible | Pattern: PPRF("primary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:provider.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:provider.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:provider.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:assistant.type | extensible | Pattern: SPRF("secondary performer")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:assistant.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:assistant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:assistant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:anaesthetist.type | extensible | Pattern: SNOMED-CT Code 88189002("Anaesthetist")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:anaesthetist.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:anaesthetist.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:anaesthetist.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:hospital.type | extensible | Pattern: SNOMED-CT Code 22232009("Hospital")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:hospital.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:hospital.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:hospital.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard | ||||
| Appointment.participant:patient.type | extensible | Pattern: SNOMED-CT Code 116154003("Patient")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant:patient.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant:patient.required | required | Pattern: requiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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 EBookingsAppointmentBase
Summary
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
The following Appointment Search parameters are useful for querying Appointments or specifying Subscription criteria. See HL7 FHIR R4 for the full list of Appointment search parameters including common parameters.
| Name | Type | Description | Expression |
|---|---|---|---|
| actor | reference | Any one of the individuals participating in the appointment | Appointment.participant.actor (any actor type) |
| date | date | Appointment date/time. | Appointment.start |
| part-status | token | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | Appointment.participant.status |
| status | token | The overall status of the appointment | Appointment.status |