Northern Region Implementation Guide
0.4.6 - CI Build
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
Official URL: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPractitioner | Version: 0.4.6 | |||
Active as of 2024-01-24 |
Realm: |
Computable Name: NorthernRegionPractitioner |
Represents Practitioner data exposed by northern region DHBs.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | Practitioner | |||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
![]() ![]() ![]() | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | The currently active CPN (Common Person Name) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 1..* | HumanName | The name(s) associated with the practitioner |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id |
![]() ![]() ![]() | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
![]() |
Path | Conformance | ValueSet / Code | URI |
Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |||||
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |||||
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
![]() ![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() ![]() | 0..1 | Period | Period during which the qualification is valid | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:HPI_CPN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from 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-0360 from the FHIR Standard | ||||
Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
This structure is derived from Practitioner
Summary
Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements
Prohibited: 5 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | Practitioner | |||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
![]() ![]() ![]() | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | The currently active CPN (Common Person Name) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 1..* | HumanName | The name(s) associated with the practitioner |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id |
![]() ![]() ![]() | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
![]() |
Path | Conformance | ValueSet / Code | URI |
Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:use, value:system | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | The currently active CPN (Common Person Name) | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |||||
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |||||
![]() ![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
![]() ![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() ![]() | 0..1 | Period | Period during which the qualification is valid | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.identifier:HPI_CPN.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:HPI_CPN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from 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-0360 from the FHIR Standard | ||||
Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
This structure is derived from Practitioner
Summary
Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements
Prohibited: 5 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron