New Zealand HPI Implementation Guide
1.4.10 - Release
New Zealand HPI Implementation Guide
1.4.10 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.4.10) 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.4.10 | |||
| Active as of 2025-04-06 | 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 |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole |
0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
Content/Rules for all slices | |||
   extension:practitionerRole-creator |
0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:practitionerRole-status-reason |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 extension:messaging-address |
0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system ele-1: All FHIR elements must have a @value or children |
 identifier:RI |
SΣ | 0..1 | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children |
  use |
?!Σ | 1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official |
 system |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id |
 practitioner |
Σ | 0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children |
| organization |
Σ | 0..1 | Reference(HPI Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children |
 code |
Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCode (required) ele-1: All FHIR elements must have a @value or children |
 location |
Σ | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| PractitionerRole.identifier:RI.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| PractitionerRole.code | required | PractitionerRoleCodehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code |
Other representations of profile: CSV, Excel, Schematron
