HL7® FHIR® New Zealand Base Implementation Guide
3.2.0-ci-build - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.2.0-ci-build - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole | Version: 1.0.0 | ||||
| Draft as of 2026-10-15 | Computable Name: NzPractitionerRole | ||||
PractitionerRole resource for use in NZ
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:practitionerRole-creator |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| extension:practitionerRole-status-reason |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
 extension:messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 extension:practitionerRole-creator |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| extension:practitionerRole-status-reason |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
| extension:messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:practitionerRole-creator |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
| extension:practitionerRole-status-reason |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |||||
| extension:messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |||||
| 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..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | |||||
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | |||||
| location |
0..* | Reference(Location) | The location(s) at which this practitioner provides care | |||||
| healthcareService |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service | |||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| 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 | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| 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 | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std. |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from PractitionerRole
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:practitionerRole-creator |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| extension:practitionerRole-status-reason |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
| extension:messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:practitionerRole-creator |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| extension:practitionerRole-status-reason |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
| extension:messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:practitionerRole-creator |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
| extension:practitionerRole-status-reason |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |||||
| extension:messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |||||
| 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..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | |||||
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | |||||
| location |
0..* | Reference(Location) | The location(s) at which this practitioner provides care | |||||
| healthcareService |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service | |||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| 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 | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| 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 | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std. |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from PractitionerRole
Other representations of profile: CSV, Excel, Schematron