Northern Region Implementation Guide, published by healthAlliance. This guide is not an authorized publication; it is the continuous build for version 0.4.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/northernRegion/ and changes regularly. See the Directory of published versions
Resource Profile: Northern region Practitioner profile
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPractitioner | Version: 0.4.6 | |||
| Active as of 2024-10-16 | Computable Name: NorthernRegionPractitioner | |||
Represents Practitioner data exposed by northern region DHBs.
Usage:
- Refer to this Resource Profile: Northern Region PractitionerRole profile
- Examples for this Resource Profile: Practitioner/practitioner1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner |
Practitioner | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   nzEthnicity |
0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
 Slices for identifier |
0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | |
 identifier:HPI_CPN |
S | 0..1 | Identifier | The currently active CPN (Common Person Name) |
   use |
1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
 system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id | |
 active |
0..0 | |||
| name |
S | 1..* | HumanName | The name(s) associated with the practitioner |
| telecom |
0..0 | |||
| address |
0..0 | |||
| birthDate |
0..0 | |||
| photo |
0..0 | |||
 qualification |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |
| scope-of-practice |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| condition-on-practive |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
 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 | |
| nzEthnicity |
0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system |
| identifier:HPI_CPN |
SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) 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-person-id |
  name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| 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 | |||||
| nzEthnicity |
0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | ||||
| identifier:HPI_CPN |
SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) | ||||
| 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 | usual | official | temp | secondary | old (If known) 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-person-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) | ||||
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |||||
| scope-of-practice |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |||||
| condition-on-practive |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.identifier:HPI_CPN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
This structure is derived from Practitioner
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 2 elements
Prohibited: 5 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
- http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
- http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
- http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Slices
This structure defines the following Slices:
- The element 2 is sliced based on the values of Practitioner.identifier
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
Practitioner | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| nzEthnicity |
0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
| Slices for identifier |
0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | |
| identifier:HPI_CPN |
S | 0..1 | Identifier | The currently active CPN (Common Person Name) |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id | |
| active |
0..0 | |||
| name |
S | 1..* | HumanName | The name(s) associated with the practitioner |
| telecom |
0..0 | |||
| address |
0..0 | |||
| birthDate |
0..0 | |||
| photo |
0..0 | |||
| qualification |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |
| scope-of-practice |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| condition-on-practive |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| 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 | |
| nzEthnicity |
0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system |
| identifier:HPI_CPN |
SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) 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-person-id |
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| 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 | |||||
| nzEthnicity |
0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | ||||
| identifier:HPI_CPN |
SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) | ||||
| 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 | usual | official | temp | secondary | old (If known) 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-person-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) | ||||
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |||||
| scope-of-practice |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |||||
| condition-on-practive |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.identifier:HPI_CPN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
This structure is derived from Practitioner
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 2 elements
Prohibited: 5 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
- http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
- http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
- http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Slices
This structure defines the following Slices:
- The element 2 is sliced based on the values of Practitioner.identifier
Other representations of profile: CSV, Excel, Schematron