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/DHOAppointmentResponse | Version: 1.0.2 | |||
| Active as of 2026-10-13 | Computable Name: DHOAppointmentResponse | |||
This profile derives from the AppointmentResponse Resource for use in the Dunedin Hospital Outpatients context.
Dunedin Hospital Outpatient AppointmentResponse 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:  |
|---|---|---|---|---|
  AppointmentResponse |
C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection Constraints: apr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 appointment |
1..1 | Reference(Appointment) | Appointment this response relates to | |
 participantType |
1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |
 participantStatus |
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 |
| AppointmentResponse.participantType | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.participantStatus | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AppointmentResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AppointmentResponse |
0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | |
  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 | |
| appointment |
1..1 | Reference(Appointment) | Appointment this response relates to | |
| start |
0..0 | Time from appointment, or requested new start time | ||
| end |
0..0 | Time from appointment, or requested new end time | ||
| participantType |
1..1 | CodeableConcept | Role of participant in the appointment | |
| actor |
0..0 | Person, Location, HealthcareService, or Device | ||
| participantStatus |
1..1 | code | accepted | declined | tentative | needs-action | |
| comment |
0..0 | Additional comments | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AppointmentResponse |
C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection Constraints: apr-1 | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External Ids for this item | |||||
| appointment |
1..1 | Reference(Appointment) | Appointment this response relates to | |||||
| participantType |
1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| participantStatus |
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 |
| AppointmentResponse.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.participantType | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.participantStatus | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AppointmentResponse
Summary
Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 4 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AppointmentResponse |
C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection Constraints: apr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| appointment |
1..1 | Reference(Appointment) | Appointment this response relates to | |
| participantType |
1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |
| participantStatus |
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 |
| AppointmentResponse.participantType | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.participantStatus | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from AppointmentResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AppointmentResponse |
0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | |
| 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 | |
| appointment |
1..1 | Reference(Appointment) | Appointment this response relates to | |
| start |
0..0 | Time from appointment, or requested new start time | ||
| end |
0..0 | Time from appointment, or requested new end time | ||
| participantType |
1..1 | CodeableConcept | Role of participant in the appointment | |
| actor |
0..0 | Person, Location, HealthcareService, or Device | ||
| participantStatus |
1..1 | code | accepted | declined | tentative | needs-action | |
| comment |
0..0 | Additional comments | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AppointmentResponse |
C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection Constraints: apr-1 | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External Ids for this item | |||||
| appointment |
1..1 | Reference(Appointment) | Appointment this response relates to | |||||
| participantType |
1..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| participantStatus |
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 |
| AppointmentResponse.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.participantType | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| AppointmentResponse.participantStatus | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AppointmentResponse
Summary
Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 4 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron