Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment | Version: 1.0.2 | |||
| Draft as of 2026-10-13 | Computable Name: DHOAppointment | |||
This profile derives from the Appointment Resource, for use in the Dunedin Hospital Outpatients context.
Dunedin Hospital Outpatient Appointment profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:appointmentMethod |
1..1 | CodeableConcept | How the appointment is delivered (in-person | telehealth | home-visit) URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod Binding: DHO Appointment Modality ValueSet (required) | |
 extension:initialPatientClass |
0..1 | CodeableConcept | Expected initial patient class (e.g. ambulatory, inpatient, emergency) at the start of the resulting encounter URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass Binding: Encounter class (extensible) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | |
| serviceType |
0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: DHO Health Speciality ValueSet (extensible) | |
 participant |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 actor |
0..1 | Reference(NZ Patient | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Location resource for use in NZ | RelatedPerson | Device) | Person, Location/HealthcareService or Device | |
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
 meta |
||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
 Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 tag:correlationId |
1..1 | Coding | Tags applied to this resource | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:appointmentMethod |
1..1 | CodeableConcept | How the appointment is delivered (in-person | telehealth | home-visit) URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod Binding: DHO Appointment Modality ValueSet (required) | |
| extension:initialPatientClass |
0..1 | CodeableConcept | Expected initial patient class (e.g. ambulatory, inpatient, emergency) at the start of the resulting encounter URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass Binding: Encounter class (extensible) | |
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| system |
0..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | Time period when id is/was valid for use | ||
| serviceType |
0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: DHO Health Speciality ValueSet (extensible) | |
| participant |
||||
| actor |
0..1 | Reference(NZ Patient | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Location resource for use in NZ | RelatedPerson | Device) | Person, Location/HealthcareService or Device | |
| status |
1..1 | code | accepted | declined | tentative | needs-action | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.serviceType | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| tag:correlationId |
1..1 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:appointmentMethod |
1..1 | CodeableConcept | How the appointment is delivered (in-person | telehealth | home-visit) URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod Binding: DHO Appointment Modality ValueSet (required) | |||||
| extension:initialPatientClass |
0..1 | CodeableConcept | Expected initial patient class (e.g. ambulatory, inpatient, emergency) at the start of the resulting encounter URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass Binding: Encounter class (extensible) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |||||
| 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 |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist 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 |
0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: DHO Health Speciality ValueSet (extensible) | |||||
| 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 |
0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | |||||
| 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 | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| start |
0..1 | instant | When appointment is to take place | |||||
| end |
0..1 | instant | When appointment is to conclude | |||||
| 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 |
0..1 | string | Additional comments | |||||
| patientInstruction |
0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| participant |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| actor |
0..1 | Reference(NZ Patient | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Location resource for use in NZ | RelatedPerson | Device) | 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 | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.cancelationReason | Base | example | Appointment cancellation reason | 📍4.0.1 | FHIR Std. |
| Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Appointment
Summary
Mandatory: 2 elements(6 nested mandatory elements)
Must-Support: 6 elements
Fixed: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:appointmentMethod |
1..1 | CodeableConcept | How the appointment is delivered (in-person | telehealth | home-visit) URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod Binding: DHO Appointment Modality ValueSet (required) | |
| extension:initialPatientClass |
0..1 | CodeableConcept | Expected initial patient class (e.g. ambulatory, inpatient, emergency) at the start of the resulting encounter URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass Binding: Encounter class (extensible) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | |
| serviceType |
0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: DHO Health Speciality ValueSet (extensible) | |
| participant |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| actor |
0..1 | Reference(NZ Patient | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Location resource for use in NZ | RelatedPerson | Device) | Person, Location/HealthcareService or Device | |
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
| meta |
||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| tag:correlationId |
1..1 | Coding | Tags applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:appointmentMethod |
1..1 | CodeableConcept | How the appointment is delivered (in-person | telehealth | home-visit) URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod Binding: DHO Appointment Modality ValueSet (required) | |
| extension:initialPatientClass |
0..1 | CodeableConcept | Expected initial patient class (e.g. ambulatory, inpatient, emergency) at the start of the resulting encounter URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass Binding: Encounter class (extensible) | |
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| system |
0..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | Time period when id is/was valid for use | ||
| serviceType |
0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: DHO Health Speciality ValueSet (extensible) | |
| participant |
||||
| actor |
0..1 | Reference(NZ Patient | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Location resource for use in NZ | RelatedPerson | Device) | Person, Location/HealthcareService or Device | |
| status |
1..1 | code | accepted | declined | tentative | needs-action | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.serviceType | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| tag:correlationId |
1..1 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:appointmentMethod |
1..1 | CodeableConcept | How the appointment is delivered (in-person | telehealth | home-visit) URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod Binding: DHO Appointment Modality ValueSet (required) | |||||
| extension:initialPatientClass |
0..1 | CodeableConcept | Expected initial patient class (e.g. ambulatory, inpatient, emergency) at the start of the resulting encounter URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass Binding: Encounter class (extensible) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |||||
| 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 |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist 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 |
0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: DHO Health Speciality ValueSet (extensible) | |||||
| 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 |
0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | |||||
| 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 | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| start |
0..1 | instant | When appointment is to take place | |||||
| end |
0..1 | instant | When appointment is to conclude | |||||
| 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 |
0..1 | string | Additional comments | |||||
| patientInstruction |
0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| participant |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| actor |
0..1 | Reference(NZ Patient | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Location resource for use in NZ | RelatedPerson | Device) | 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 | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.cancelationReason | Base | example | Appointment cancellation reason | 📍4.0.1 | FHIR Std. |
| Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Appointment
Summary
Mandatory: 2 elements(6 nested mandatory elements)
Must-Support: 6 elements
Fixed: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron