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

Resource Profile: Northern region Practitioner profile

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPractitioner Version: 0.4.6
Active as of 2024-01-24 Realm: New Zealand flag Computable Name: NorthernRegionPractitioner

Represents Practitioner data exposed by northern region DHBs.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner Practitioner
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzEthnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... Slices for identifier 0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI_CPN S0..1IdentifierThe currently active CPN (Common Person Name)
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
... name S1..*HumanNameThe name(s) associated with the practitioner
... telecom 0..0
... address 0..0
... birthDate 0..0
... photo 0..0
... qualification
.... Slices for extension 0..*ExtensionExtension
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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzEthnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... Slices for identifier Σ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI_CPN SΣ0..1IdentifierThe currently active CPN (Common Person Name)
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
... name SΣ1..*HumanNameThe name(s) associated with the practitioner

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.identifier:HPI_CPN.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzEthnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI_CPN SΣ0..1IdentifierThe currently active CPN (Common Person Name)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier:HPI_CPN.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier:HPI_CPN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.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.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
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:

  • The element Practitioner.identifier is sliced based on the values of value:use, value:system

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner Practitioner
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzEthnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... Slices for identifier 0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI_CPN S0..1IdentifierThe currently active CPN (Common Person Name)
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
... name S1..*HumanNameThe name(s) associated with the practitioner
... telecom 0..0
... address 0..0
... birthDate 0..0
... photo 0..0
... qualification
.... Slices for extension 0..*ExtensionExtension
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

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzEthnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... Slices for identifier Σ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI_CPN SΣ0..1IdentifierThe currently active CPN (Common Person Name)
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
... name SΣ1..*HumanNameThe name(s) associated with the practitioner

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.identifier:HPI_CPN.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzEthnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI_CPN SΣ0..1IdentifierThe currently active CPN (Common Person Name)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier:HPI_CPN.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier:HPI_CPN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.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.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
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:

  • The element Practitioner.identifier is sliced based on the values of value:use, value:system

 

Other representations of profile: CSV, Excel, Schematron