New Zealand HPI IG
0.2.0 - CI Build

New Zealand HPI IG, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.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: CommonPractitioner

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/CommonPractitioner
Version:0.2.0
Name:CommonPractitioner
Title:NZ Practitioner
Status:Active as of 2020-10-11T23:44:54+00:00
Definition:

The New Zealand base practitioner. Slices on identifier for CPN, makes name mandatory and uses NZ address.

Publisher:David Hay
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/CommonPractitioner

Formal Views of Profile Content

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

This structure is derived from Practitioner

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

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

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a perrson (preferred)
... identifier 0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI S0..1IdentifierThe currently active CPN (Common Person Name)
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... type 0..0
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-id
... address 0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical 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
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a perrson (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI 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)
Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... 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)
.... 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)
Max Binding: AllLanguages

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... identifier:HPI Σ0..1IdentifierThe currently active CPN (Common Person Name)
... name Σ1..*HumanNameThe name(s) associated with the practitioner

doco Documentation for this format

This structure is derived from Practitioner

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

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 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a perrson (preferred)
... identifier 0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI S0..1IdentifierThe currently active CPN (Common Person Name)
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... type 0..0
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-id
... address 0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical 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
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a perrson (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:use, value:system
.... identifier:HPI 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)
Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... 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)
.... 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)
Max Binding: AllLanguages

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.identifier:HPI.userequiredFixed Value: official
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages