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/OnlineGPAppointment | Version: 1.1.0 | |||
| Active as of 2026-10-13 | Computable Name: OnlineGPAppointment | |||
A FHIR resource profile for operational reporting of Online GP Appointment.
A FHIR resource profile for operational reporting of Online GP Appointment.
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, patient-or-data-absent-reason |
  meta |
1..1 | Meta | Metadata about the resource | |
   source |
C | 1..1 | uri | HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format |
  Slices for tag |
1..* | Coding | Tags applied to this resource 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". | |
 system |
1..1 | uri | Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..1 | Identifier | External Ids for this item | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..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. | |
| reasonCode |
1..* | CodeableConcept | Coded reason this appointment is scheduled Binding: NZ Appointment Reason Codes Code System (required) | |
 supportingInformation |
1..1 | Reference(Organization) | The provider organisation that owns this appointment | |
| type |
1..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: Organization | |
| identifier |
C | 1..1 | Identifier | Logical reference, when literal reference is not known Constraints: hpiOrganizationIdPattern |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/hpi-organisation-id | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| created |
C | 0..1 | dateTime | The date that this appointment was initially created Constraints: full-datetime-with-timezone |
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by pattern:actor.type Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
  participant:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |
| participant:patient |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 actor |
1..1 | Reference(NZ Patient | Patient) | Person, Location/HealthcareService or Device | |
 type |
1..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: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format Example General: 123456 |
| 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.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.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.reasonCode | Base | required | NZ Appointment Reason Codes Code System | 📦0.4.7 | This IG |
| Appointment.supportingInformation.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.supportingInformation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| full-datetime-with-timezone | error | Appointment.created | DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
|
| hpi-location-url-format | error | Appointment.meta.source | Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A |
matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
|
| hpiOrganizationIdPattern | error | Appointment.supportingInformation.identifier | HPI Organisation ID must conform to format (GXXnnn-C). |
system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
|
| nhi-value-format | error | Appointment.participant:patient.actor.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| patient-or-data-absent-reason | error | Appointment | Either a patient participant must be present, or a participant with a data-absent-reason extension on actor must be provided, but not both. |
participant.where(actor.type = 'Patient').exists() xor participant.where(actor.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()).exists()
|
This structure is derived from Appointment
| 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: patient-or-data-absent-reason |
| meta |
1..1 | Meta | Metadata about the resource | |
| source |
C | 1..1 | uri | HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format |
| Slices for tag |
1..* | Coding | Tags applied to this resource 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 | Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| contained |
0..0 | Contained, inline Resources | ||
| identifier |
0..1 | Identifier | External Ids for this item | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| serviceCategory |
0..0 | A broad categorization of the service that is to be performed during this appointment | ||
| serviceType |
0..0 | The specific service that is to be performed during this appointment | ||
| specialty |
0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
| appointmentType |
0..0 | The style of appointment or patient that has been booked in the slot (not service type) | ||
| reasonCode |
1..* | CodeableConcept | Coded reason this appointment is scheduled Binding: NZ Appointment Reason Codes Code System (required) | |
| reasonReference |
0..0 | Reason the appointment is to take place (resource) | ||
| priority |
0..0 | Used to make informed decisions if needing to re-prioritize | ||
| supportingInformation |
1..1 | Reference(Organization) | The provider organisation that owns this appointment | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Organization | |
| identifier |
C | 1..1 | Identifier | Logical reference, when literal reference is not known Constraints: hpiOrganizationIdPattern |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/hpi-organisation-id | |
| value |
1..1 | string | The value that is unique | |
| minutesDuration |
0..0 | Can be less than start/end (e.g. estimate) | ||
| created |
C | 0..1 | dateTime | The date that this appointment was initially created Constraints: full-datetime-with-timezone |
| patientInstruction |
0..0 | Detailed information and instructions for the patient | ||
| basedOn |
0..0 | The service request this appointment is allocated to assess | ||
| Slices for participant |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by pattern:actor.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| participant:patient |
0..1 | BackboneElement | Participants involved in appointment | |
 actor |
1..1 | Reference(NZ Patient | Patient) | Person, Location/HealthcareService or Device | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format |
| display |
0..0 | Remove from all examples. Never return in a response. Never save if provided. | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.reasonCode | Base | required | NZ Appointment Reason Codes Code System | 📦0.4.7 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| full-datetime-with-timezone | error | Appointment.created | DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
|
| hpi-location-url-format | error | Appointment.meta.source | Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A |
matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
|
| hpiOrganizationIdPattern | error | Appointment.supportingInformation.identifier | HPI Organisation ID must conform to format (GXXnnn-C). |
system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
|
| nhi-value-format | error | Appointment.participant:patient.actor.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| patient-or-data-absent-reason | error | Appointment | Either a patient participant must be present, or a participant with a data-absent-reason extension on actor must be provided, but not both. |
participant.where(actor.type = 'Patient').exists() xor participant.where(actor.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()).exists()
|
| 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, patient-or-data-absent-reason | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
1..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 |
C | 1..1 | uri | HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format | ||||
| 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 | Tags applied to this resource 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 | Hub correlation ID system Required Pattern: 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..1 | Identifier | External Ids for this item | |||||
| 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 | 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 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| 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) | |||||
| reasonCode |
1..* | CodeableConcept | Coded reason this appointment is scheduled Binding: NZ Appointment Reason Codes Code System (required) | |||||
| description |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
| supportingInformation |
1..1 | Reference(Organization) | The provider organisation that owns this 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 |
1..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: Organization | |||||
| identifier |
C | 1..1 | Identifier | Logical reference, when literal reference is not known Constraints: hpiOrganizationIdPattern | ||||
| 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 . Required Pattern: official | |||||
| 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 | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/hpi-organisation-id | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| start |
0..1 | instant | When appointment is to take place | |||||
| end |
0..1 | instant | When appointment is to conclude | |||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created |
C | 0..1 | dateTime | The date that this appointment was initially created Constraints: full-datetime-with-timezone | ||||
| comment |
0..1 | string | Additional comments | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by pattern:actor.type Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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:patient |
C | 0..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 |
1..1 | Reference(NZ Patient | Patient) | Person, Location/HealthcareService or Device | |||||
| 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 |
1..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: Patient | |||||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |||||
| 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 | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |||||
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| 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.reasonCode | Base | required | NZ Appointment Reason Codes Code System | 📦0.4.7 | This IG |
| Appointment.supportingInformation.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.supportingInformation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.supportingInformation.identifier.type | Base | extensible | IdentifierType | 📍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. |
| Appointment.participant:patient.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| full-datetime-with-timezone | error | Appointment.created | DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
|
| hpi-location-url-format | error | Appointment.meta.source | Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A |
matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
|
| hpiOrganizationIdPattern | error | Appointment.supportingInformation.identifier | HPI Organisation ID must conform to format (GXXnnn-C). |
system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
|
| nhi-value-format | error | Appointment.participant:patient.actor.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| patient-or-data-absent-reason | error | Appointment | Either a patient participant must be present, or a participant with a data-absent-reason extension on actor must be provided, but not both. |
participant.where(actor.type = 'Patient').exists() xor participant.where(actor.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()).exists()
|
This structure is derived from Appointment
Summary
Mandatory: 12 elements(7 nested mandatory elements)
Fixed: 1 element
Prohibited: 11 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 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, patient-or-data-absent-reason |
| meta |
1..1 | Meta | Metadata about the resource | |
| source |
C | 1..1 | uri | HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format |
| Slices for tag |
1..* | Coding | Tags applied to this resource 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". | |
| system |
1..1 | uri | Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..1 | Identifier | External Ids for this item | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..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. | |
| reasonCode |
1..* | CodeableConcept | Coded reason this appointment is scheduled Binding: NZ Appointment Reason Codes Code System (required) | |
| supportingInformation |
1..1 | Reference(Organization) | The provider organisation that owns this appointment | |
| type |
1..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: Organization | |
| identifier |
C | 1..1 | Identifier | Logical reference, when literal reference is not known Constraints: hpiOrganizationIdPattern |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/hpi-organisation-id | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| created |
C | 0..1 | dateTime | The date that this appointment was initially created Constraints: full-datetime-with-timezone |
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by pattern:actor.type Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| participant:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |
| participant:patient |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| actor |
1..1 | Reference(NZ Patient | Patient) | Person, Location/HealthcareService or Device | |
| type |
1..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: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format Example General: 123456 |
| 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.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.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.reasonCode | Base | required | NZ Appointment Reason Codes Code System | 📦0.4.7 | This IG |
| Appointment.supportingInformation.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.supportingInformation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| full-datetime-with-timezone | error | Appointment.created | DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
|
| hpi-location-url-format | error | Appointment.meta.source | Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A |
matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
|
| hpiOrganizationIdPattern | error | Appointment.supportingInformation.identifier | HPI Organisation ID must conform to format (GXXnnn-C). |
system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
|
| nhi-value-format | error | Appointment.participant:patient.actor.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| patient-or-data-absent-reason | error | Appointment | Either a patient participant must be present, or a participant with a data-absent-reason extension on actor must be provided, but not both. |
participant.where(actor.type = 'Patient').exists() xor participant.where(actor.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()).exists()
|
Differential View
This structure is derived from Appointment
| 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: patient-or-data-absent-reason |
| meta |
1..1 | Meta | Metadata about the resource | |
| source |
C | 1..1 | uri | HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format |
| Slices for tag |
1..* | Coding | Tags applied to this resource 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 | Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| contained |
0..0 | Contained, inline Resources | ||
| identifier |
0..1 | Identifier | External Ids for this item | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| serviceCategory |
0..0 | A broad categorization of the service that is to be performed during this appointment | ||
| serviceType |
0..0 | The specific service that is to be performed during this appointment | ||
| specialty |
0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
| appointmentType |
0..0 | The style of appointment or patient that has been booked in the slot (not service type) | ||
| reasonCode |
1..* | CodeableConcept | Coded reason this appointment is scheduled Binding: NZ Appointment Reason Codes Code System (required) | |
| reasonReference |
0..0 | Reason the appointment is to take place (resource) | ||
| priority |
0..0 | Used to make informed decisions if needing to re-prioritize | ||
| supportingInformation |
1..1 | Reference(Organization) | The provider organisation that owns this appointment | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Organization | |
| identifier |
C | 1..1 | Identifier | Logical reference, when literal reference is not known Constraints: hpiOrganizationIdPattern |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/hpi-organisation-id | |
| value |
1..1 | string | The value that is unique | |
| minutesDuration |
0..0 | Can be less than start/end (e.g. estimate) | ||
| created |
C | 0..1 | dateTime | The date that this appointment was initially created Constraints: full-datetime-with-timezone |
| patientInstruction |
0..0 | Detailed information and instructions for the patient | ||
| basedOn |
0..0 | The service request this appointment is allocated to assess | ||
| Slices for participant |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by pattern:actor.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| participant:patient |
0..1 | BackboneElement | Participants involved in appointment | |
| actor |
1..1 | Reference(NZ Patient | Patient) | Person, Location/HealthcareService or Device | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format |
| display |
0..0 | Remove from all examples. Never return in a response. Never save if provided. | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.reasonCode | Base | required | NZ Appointment Reason Codes Code System | 📦0.4.7 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| full-datetime-with-timezone | error | Appointment.created | DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
|
| hpi-location-url-format | error | Appointment.meta.source | Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A |
matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
|
| hpiOrganizationIdPattern | error | Appointment.supportingInformation.identifier | HPI Organisation ID must conform to format (GXXnnn-C). |
system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
|
| nhi-value-format | error | Appointment.participant:patient.actor.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| patient-or-data-absent-reason | error | Appointment | Either a patient participant must be present, or a participant with a data-absent-reason extension on actor must be provided, but not both. |
participant.where(actor.type = 'Patient').exists() xor participant.where(actor.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()).exists()
|
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, patient-or-data-absent-reason | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
1..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 |
C | 1..1 | uri | HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format | ||||
| 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 | Tags applied to this resource 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 | Hub correlation ID system Required Pattern: 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..1 | Identifier | External Ids for this item | |||||
| 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 | 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 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| 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) | |||||
| reasonCode |
1..* | CodeableConcept | Coded reason this appointment is scheduled Binding: NZ Appointment Reason Codes Code System (required) | |||||
| description |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
| supportingInformation |
1..1 | Reference(Organization) | The provider organisation that owns this 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 |
1..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: Organization | |||||
| identifier |
C | 1..1 | Identifier | Logical reference, when literal reference is not known Constraints: hpiOrganizationIdPattern | ||||
| 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 . Required Pattern: official | |||||
| 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 | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/hpi-organisation-id | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| start |
0..1 | instant | When appointment is to take place | |||||
| end |
0..1 | instant | When appointment is to conclude | |||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created |
C | 0..1 | dateTime | The date that this appointment was initially created Constraints: full-datetime-with-timezone | ||||
| comment |
0..1 | string | Additional comments | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by pattern:actor.type Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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:patient |
C | 0..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 |
1..1 | Reference(NZ Patient | Patient) | Person, Location/HealthcareService or Device | |||||
| 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 |
1..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: Patient | |||||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |||||
| 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 | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |||||
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| 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.reasonCode | Base | required | NZ Appointment Reason Codes Code System | 📦0.4.7 | This IG |
| Appointment.supportingInformation.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.supportingInformation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.supportingInformation.identifier.type | Base | extensible | IdentifierType | 📍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. |
| Appointment.participant:patient.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.actor.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| full-datetime-with-timezone | error | Appointment.created | DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted. |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
|
| hpi-location-url-format | error | Appointment.meta.source | Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A |
matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
|
| hpiOrganizationIdPattern | error | Appointment.supportingInformation.identifier | HPI Organisation ID must conform to format (GXXnnn-C). |
system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
|
| nhi-value-format | error | Appointment.participant:patient.actor.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| patient-or-data-absent-reason | error | Appointment | Either a patient participant must be present, or a participant with a data-absent-reason extension on actor must be provided, but not both. |
participant.where(actor.type = 'Patient').exists() xor participant.where(actor.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()).exists()
|
This structure is derived from Appointment
Summary
Mandatory: 12 elements(7 nested mandatory elements)
Fixed: 1 element
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron