New Zealand HPI Implementation Guide - Local Development build (v1.3.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: HPI Practitioner role
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/HPIPractitionerRole | Version: 1.3.1 | |||
| Active as of 2024-03-04 | 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
HPI PractitionerRole
Practitioner Role Attributes
| 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:
- Examples for this Resource Profile: PractitionerRole/R00000012-G, PractitionerRole/R00000015-C and PractitionerRole/R00000029-P
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NzPractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
  extension:practitionerRole-creator | 0..1 | PractitionerRoleCreator | The person and/or organization that created the PR | |
| extension:practitionerRole-status-reason | 0..1 | PractitionerRoleStatusReason | The reason for the status of this role. Generally when it is inactive. | |
| messaging-address | 0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
  Slices for identifier | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
  identifier:RI | S | 0..1 | Identifier | Business Identifiers that are specific to a role/location |
   use | 1..1 | code | PractitionerRole Id Fixed Value: official | |
| type | 0..0 | |||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id | |
 period | 0..0 | |||
 practitioner | 0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization | 0..1 | Reference(HPI Organization) | Organization where the roles are available | |
| code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole code (required) | |
| specialty | 0..0 | |||
| location | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |
| healthcareService | 0..0 | |||
| telecom | ||||
 use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
| availableTime | 0..0 | |||
| notAvailable | 0..0 | |||
| availabilityExceptions | 0..0 | |||
| endpoint | 0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | required | Hpi_practitioner_rolehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code | |
| PractitionerRole.telecom.use | required | Hpi_ContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| 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) | |
| messaging-address | 0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system |
| identifier:RI | SΣ | 0..1 | Identifier | Business Identifiers that are specific to a role/location |
| use | ?!Σ | 1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
| system | Σ | 1..1 | uri | The namespace for the identifier value 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 |
| organization | Σ | 0..1 | Reference(HPI Organization) | Organization where the roles are available |
 code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole code (required) |
| location | Σ | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care |
| Documentation for this format | ||||
Terminology Bindings
| 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 | Hpi_practitioner_rolehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole | 0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
| 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) | |||||
| messaging-address | 0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | ||||
| identifier:RI | SΣ | 0..1 | Identifier | Business Identifiers that are specific to a role/location | ||||
| 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 | ?!Σ | 1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner | Σ | 0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
| organization | Σ | 0..1 | Reference(HPI Organization) | Organization where the roles are available | ||||
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole code (required) | ||||
| location | Σ | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | ||||
 telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| 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 | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.identifier:RI.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.code | required | Hpi_practitioner_rolehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | Hpi_ContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code |
This structure is derived from NzPractitionerRole
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 2 elements
Prohibited: 9 elements
Structures
This structure refers to these other structures:
- HPI Practitioner (http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner)
- HPI Organization (http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization)
- HPI Location (http://hl7.org.nz/fhir/StructureDefinition/HPILocation)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element PractitionerRole.identifier is sliced based on the values of value:use, value:system (Open at End)
Differential View
This structure is derived from NzPractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
| extension:practitionerRole-creator | 0..1 | PractitionerRoleCreator | The person and/or organization that created the PR | |
| extension:practitionerRole-status-reason | 0..1 | PractitionerRoleStatusReason | The reason for the status of this role. Generally when it is inactive. | |
| messaging-address | 0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| Slices for identifier | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
| identifier:RI | S | 0..1 | Identifier | Business Identifiers that are specific to a role/location |
| use | 1..1 | code | PractitionerRole Id Fixed Value: official | |
| type | 0..0 | |||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id | |
| period | 0..0 | |||
| practitioner | 0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization | 0..1 | Reference(HPI Organization) | Organization where the roles are available | |
| code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole code (required) | |
| specialty | 0..0 | |||
| location | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | |
| healthcareService | 0..0 | |||
| telecom | ||||
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
| availableTime | 0..0 | |||
| notAvailable | 0..0 | |||
| availabilityExceptions | 0..0 | |||
| endpoint | 0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | required | Hpi_practitioner_rolehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code | |
| PractitionerRole.telecom.use | required | Hpi_ContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| 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) | |
| messaging-address | 0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system |
| identifier:RI | SΣ | 0..1 | Identifier | Business Identifiers that are specific to a role/location |
| use | ?!Σ | 1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
| system | Σ | 1..1 | uri | The namespace for the identifier value 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 |
| organization | Σ | 0..1 | Reference(HPI Organization) | Organization where the roles are available |
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole code (required) |
| location | Σ | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care |
| Documentation for this format | ||||
Terminology Bindings
| 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 | Hpi_practitioner_rolehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole | 0..* | NzPractitionerRole | Roles/organizations the practitioner is associated with | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
| 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) | |||||
| messaging-address | 0..1 | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | ||||
| identifier:RI | SΣ | 0..1 | Identifier | Business Identifiers that are specific to a role/location | ||||
| 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 | ?!Σ | 1..1 | code | PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner | Σ | 0..1 | Reference(HPI Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
| organization | Σ | 0..1 | Reference(HPI Organization) | Organization where the roles are available | ||||
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole code (required) | ||||
| location | Σ | 0..1 | Reference(HPI Location) | The location(s) at which this practitioner provides care | ||||
| telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| 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 | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.identifier:RI.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.code | required | Hpi_practitioner_rolehttps://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | Hpi_ContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code |
This structure is derived from NzPractitionerRole
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 2 elements
Prohibited: 9 elements
Structures
This structure refers to these other structures:
- HPI Practitioner (http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner)
- HPI Organization (http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization)
- HPI Location (http://hl7.org.nz/fhir/StructureDefinition/HPILocation)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element PractitionerRole.identifier is sliced based on the values of value:use, value:system (Open at End)
Other representations of profile: CSV, Excel, Schematron