New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Resource Profile: HPI Practitioner role
| Defining URL: | http://hl7.org.nz/fhir/StructureDefinition/HPIPractitionerRole |
| Version: | 0.9.0 |
| Name: | HpiPractitionerRole |
| Title: | HPI Practitioner role |
| Status: | Active as of 12/3/21, 2:22 AM |
| Definition: | 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. |
| Publisher: | Ministry of Health |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/StructureDefinition/HPIPractitionerRole
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
Summary
Mandatory: 4 elements
Must-Support: 1 element
Fixed Value: 2 elements
Prohibited: 7 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason
- http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
- http://hl7.org.nz/fhir/StructureDefinition/edi-address
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)
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 practitionerRole-status-reason | 0..1 | CodeableConcept | The reson 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) | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
  Slices for identifier | 1..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
  identifier:RI | S | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
   use | 1..1 | code | PractitionerRole Id Fixed Value: official | |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id | |
| code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitonerRole code (required) | |
| specialty | 0..0 | |||
| location | 0..1 | Reference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService | 0..0 | |||
| telecom | ||||
| edi-address | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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-status-reason | 0..1 | CodeableConcept | The reson 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) | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system |
| identifier:RI | SΣ | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 |
| 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/hpi-practitionerrole-id |
| value | Σ | 0..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) |
| 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(Practitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitonerRole code (required) |
| location | Σ | 0..1 | Reference(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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| edi-address | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
| system | ΣI | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| identifier:RI | Σ | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
| Documentation for this format | ||||
This structure is derived from PractitionerRole
Summary
Mandatory: 4 elements
Must-Support: 1 element
Fixed Value: 2 elements
Prohibited: 7 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason
- http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
- http://hl7.org.nz/fhir/StructureDefinition/edi-address
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 PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| practitionerRole-status-reason | 0..1 | CodeableConcept | The reson 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) | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| Slices for identifier | 1..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system | |
| identifier:RI | S | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
| use | 1..1 | code | PractitionerRole Id Fixed Value: official | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id | |
| code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitonerRole code (required) | |
| specialty | 0..0 | |||
| location | 0..1 | Reference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService | 0..0 | |||
| telecom | ||||
| edi-address | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
| 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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-status-reason | 0..1 | CodeableConcept | The reson 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) | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system |
| identifier:RI | SΣ | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 |
| 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/hpi-practitionerrole-id |
| value | Σ | 0..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) |
| 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(Practitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitonerRole code (required) |
| location | Σ | 0..1 | Reference(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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| edi-address | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
| system | ΣI | 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 | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| PractitionerRole.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PractitionerRole.identifier:RI.use | required | Fixed Value: official |
| PractitionerRole.identifier:RI.type | extensible | Identifier Type Codes |
| PractitionerRole.code | required | Hpi_practitioner_role |
| PractitionerRole.telecom.system | required | ContactPointSystem |
| PractitionerRole.telecom.use | required | Hpi_ContactPointUse |