New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/HPIPractitionerRole | Version: 1.5.0 | |||
| Active as of 2026-11-08 | Computable Name: HpiPractitionerRole | |||
The practitioner role exposed by the HPI. Used to connect Practitioners with Organizations and Locations, indicating the role they have. A single Practitioner can have roles with multiple organizations.
Describe the PractitionerRole that will be returned by the HPI
| PractitionerRole Attribute | Description |
|---|---|
| PractitionerRole-creator | The Person and Organisation that created the PractitionerRole record |
| PractitionerRole-status-reason | The reason that the PractitionerRole record was ended Only present when a PractitionerRole has a period end date |
| Messaging-address | The electronic messaging address for the person's role Only to be used if the Facility messaging address is not appropriate for the specific role Used for the healthlink edi-address |
| identifier:RI | The unique PractitionerRole record identifier |
| Active | Whether this PractitionerRole record is in active use This is a derived field from the period start and end dates |
| Period | The start and end dates for a PractitinerRole record |
| Practitioner | The Practitioner assigned to the role hpi-person-id (CPN) and name |
| Organization | The Organisation the Practitioner works for in this role hpi-organization-id and name |
| Code | The role the Practitioner is assinged to |
| Location | The Facility where the Practitioner works in this role hpi-facility-id and name |
| Telecom | The Contact details for this Practitioner in this role |
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: ![]() |
|---|---|---|---|---|
![]() |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
![]() ![]() ![]() |
0..1 | CodeableConcept | The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
![]() ![]() ![]() |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
![]() ![]() ![]() |
0..1 | Identifier | Business Identifiers that are specific to a role/location | |
![]() ![]() ![]() ![]() |
1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id (no extensions allowed) | |
![]() ![]() |
0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() |
0..1 | Reference(HPI Organization) | Organization where the roles are available | |
![]() ![]() |
0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) | |
![]() ![]() |
0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier:RI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | required | PractitionerRoleCode | 📦20240821 | HIP FHIR Common Terminology Guide v1.9 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from NzPractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | PractitionerRoleCreator | The person and/or organization that created the PR | |
![]() ![]() ![]() |
0..1 | PractitionerRoleStatusReason | The reason for the status of this role. Generally when it is inactive. | |
![]() ![]() ![]() |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() ![]() |
0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
![]() ![]() ![]() |
0..1 | Identifier | Business Identifiers that are specific to a role/location | |
![]() ![]() ![]() ![]() |
1..1 | code | PractitionerRole Id Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() |
0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() |
0..1 | Reference(HPI Organization) | Organization where the roles are available | |
![]() ![]() |
0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) | |
![]() ![]() |
0..0 | Specific specialty of the practitioner | ||
![]() ![]() |
0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |
![]() ![]() |
0..0 | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
![]() ![]() |
0..0 | Times the Service Site is available | ||
![]() ![]() |
0..0 | Not available during this time due to provided reason | ||
![]() ![]() |
0..0 | Description of availability exceptions | ||
![]() ![]() |
0..0 | Technical endpoints providing access to services operated for the practitioner with this role | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | required | PractitionerRoleCode | 📦20240821 | HIP FHIR Common Terminology Guide v1.9 |
| PractitionerRole.telecom.use | Base | required | Use values for a ContactPoint | 📦1.0 | HIP FHIR Common Terminology Guide v1.9 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business Identifiers that are specific to a role/location | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..1 | boolean | Whether this practitioner role record is in active use | |||||
![]() ![]() |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
![]() ![]() |
0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |||||
![]() ![]() |
0..1 | Reference(HPI Organization) | Organization where the roles are available | |||||
![]() ![]() |
0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) | |||||
![]() ![]() |
0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |||||
![]() ![]() |
0..* | ContactPoint | Contact details that are specific to the role/location/service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier:RI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | required | PractitionerRoleCode | 📦20240821 | HIP FHIR Common Terminology Guide v1.9 |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | Use values for a ContactPoint | 📦1.0 | HIP FHIR Common Terminology Guide v1.9 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from NzPractitionerRole
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 2 elements
Prohibited: 9 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: ![]() |
|---|---|---|---|---|
![]() |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
![]() ![]() ![]() |
0..1 | CodeableConcept | The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
![]() ![]() ![]() |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
![]() ![]() ![]() |
0..1 | Identifier | Business Identifiers that are specific to a role/location | |
![]() ![]() ![]() ![]() |
1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id (no extensions allowed) | |
![]() ![]() |
0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() |
0..1 | Reference(HPI Organization) | Organization where the roles are available | |
![]() ![]() |
0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) | |
![]() ![]() |
0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier:RI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | required | PractitionerRoleCode | 📦20240821 | HIP FHIR Common Terminology Guide v1.9 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from NzPractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | PractitionerRoleCreator | The person and/or organization that created the PR | |
![]() ![]() ![]() |
0..1 | PractitionerRoleStatusReason | The reason for the status of this role. Generally when it is inactive. | |
![]() ![]() ![]() |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() ![]() |
0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
![]() ![]() ![]() |
0..1 | Identifier | Business Identifiers that are specific to a role/location | |
![]() ![]() ![]() ![]() |
1..1 | code | PractitionerRole Id Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() |
0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() |
0..1 | Reference(HPI Organization) | Organization where the roles are available | |
![]() ![]() |
0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) | |
![]() ![]() |
0..0 | Specific specialty of the practitioner | ||
![]() ![]() |
0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |
![]() ![]() |
0..0 | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
![]() ![]() |
0..0 | Times the Service Site is available | ||
![]() ![]() |
0..0 | Not available during this time due to provided reason | ||
![]() ![]() |
0..0 | Description of availability exceptions | ||
![]() ![]() |
0..0 | Technical endpoints providing access to services operated for the practitioner with this role | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | required | PractitionerRoleCode | 📦20240821 | HIP FHIR Common Terminology Guide v1.9 |
| PractitionerRole.telecom.use | Base | required | Use values for a ContactPoint | 📦1.0 | HIP FHIR Common Terminology Guide v1.9 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business Identifiers that are specific to a role/location | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..1 | boolean | Whether this practitioner role record is in active use | |||||
![]() ![]() |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
![]() ![]() |
0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |||||
![]() ![]() |
0..1 | Reference(HPI Organization) | Organization where the roles are available | |||||
![]() ![]() |
0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) | |||||
![]() ![]() |
0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |||||
![]() ![]() |
0..* | ContactPoint | Contact details that are specific to the role/location/service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
0..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier:RI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | required | PractitionerRoleCode | 📦20240821 | HIP FHIR Common Terminology Guide v1.9 |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | Use values for a ContactPoint | 📦1.0 | HIP FHIR Common Terminology Guide v1.9 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from NzPractitionerRole
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 2 elements
Prohibited: 9 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