New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HPI Practitioner

Official URL: http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner Version: 1.5.0
Active as of 2026-11-08 Computable Name: HpiPractitioner

The practitioner exposed by the HPI. This is the person who delivers healthcare or healthcare related services.

Describe the Practitioner that will be returned by the HPI

The Practitioner resource represents any provider of healthcare - not restricted to those with formal qualifications.

The current HPI contains practitioners covered by the Health Practitioners Competence Assurance Amendment Act 2019. This includes all:

  • Chinese Medicine Practitioners,
  • Chiropractors,
  • Dentists,
  • Dental hygienist and Dental and Oral health therapists,
  • Dietitians,
  • Medical Laboratory Scientist and Technicians including phlebotomists and mortuary technicians,
  • Anaesthetic Technologists,
  • Medical Radiation Technologists,
  • Medical Practitioners (all doctors and specialists),
  • Midwifes,
  • Nurses,
  • Occupational Therapists,
  • Optometrists and optical dispensers,
  • Osteopaths,
  • Paramedics,
  • Pharmacists,
  • Physiotherapists,
  • Podiatrists, and
  • Psychologists.

It is intended with the upgraded capabilities that other professional groups may supply their members eg Social Workers, Acupuncturists, Audiologists, Counsellors, Cardiac Physiologists, Nutritionist.

Other groups of health workers will need a CPN to be identified in digital records eg Allied Health assistants, Aged care, Personal Care and support workers, administrative staff, practice managers, students working in healthcare setting.

Consideration is being given to ‘self-asserted’ data.

Key differences from spec

  • DeathDate extension
  • Ethnicity extension
  • Qualification has a status (see more differences below)
  • Initial date of registration extension
  • APC history extension
  • Additional Authorizations extension (complex)
  • Scope of Practice extension (complex)
  • Conditions on Practice extension (complex)

Registration Authority (RA)

A registration authority is an organization that asserts the information about a practitioner’s competence to perform a particular health role. This includes the Responsible Authorities named under the Act and Professional bodies who require a level of education and professional development to be registered as a member and be issued a certificate to practice. - Information supplied by the Registration Authority can only be changed by the Registration Authority. Health provider organisations may add their workers to the HPI with personal identity details ie name, date of birth, gender, ethnicity and the languages they speak in order to get a CPN. At a later stage a Responsible Authority or a Professional body may add information about their registration with that body ie Annual Practicing Certificate dates, scopes of practice etc.

Resource identifiers

There are 2 levels of identifier in the practitioner resource.

Practitioner.identifier is the top level identifier assigned by the HPI (and the source of the resource id as described in the background section). There can be multiple identifiers for any given resource as part of managing the Practitioner (for example removal of duplicate identifiers). The current identifier will have a use value of ‘official’, others will have a use value of ‘old’. The HPI identifier will always have a system value of '\https://standards.digital.health.nz/ns/hpi-person-id' It is the client's responsibility to check the value of the use element.

Practitioner.qualification.identifier is the identifier assigned by the Registration authority - for example the Medical Council Number, or Nursing Council number. This will also be found under the Practitioner.identifier but with a system value related to the Registration authority who issued it, for nursing council this will be 'https://standards.digital.health.nz/ns/nursing-council-id'.

Qualifications

To practice in NZ, practitioners must gain registration with a Responsible Authority (RA). The RA ensures practitioners are competent and fit to practice. Practitioners may provide evidence of educational qualifications attained that are considered by the RA when granting registrations, however the educational qualifications alone do not give a practitioner the right to practice in NZ.

In order to clearly distinguish a person’s licence to practice and their educational qualifications the HpiPractitioner profile uses the Practitioner.qualification element to represent the practitioner’s registration and the extension Practitioner.educational.qualification element to represent a person’s educational qualifications.

Other health providers (not considered Practitioners in NZ) are recorded in the HPI. They may not have a registration but will supply educational qualifications as part of their profile. In the HPI educational qualifications are an element of practitioner not a sub element of practitioner.qualification (ie registration).

A registration is made up of

Element Description Profile element
Type the type of registration – nurse, physiotherapist, doctor etc. Practitioner.qualification.code
Identifier an identifier issued by the responsible authority eg medical council number Practitioner.qualification.identifier
Status indicates whether the registration is current Practitioner.qualification.extension:registration-status-code
Initial registration date date the practitioner was first registered with the responsible authority Practitioner.qualification.extension:registration-initial-date
Annual practicing certificate The period of the most recently issued APC. APC periods are also available as repeated APC history extensions, including historical periods. Practitioner.qualification.period
APC history Each occurrence represents one APC period. The period is carried in the extension's required period sub-extension. Periods are ordered by start date, newest first; periods without a start date follow dated periods. Practitioner.qualification.extension:apc-history.extension:period
Issuer HPI Identifier of the responsible authority Practitioner.qualification.issuer
Scope of practice range of health services a practitioner is authorised to perform Practitioner.qualification.extension:scope-of-practice
Condition on practice conditions the health practitioner is subject to in relation to their scope of practice Practitioner.qualification.extension:condition-on-practice
Additional Authorisation additional services that a practitioner is authorised to perform Practitioner.qualification.extension:additional-authorisation

An education qualification is made up of

Element Profile element
Fullname Practitioner.extension:educational-qualification.extension:fullname
Shortname Practitioner.extension:educational-qualification.extension:shortname
Year Practitioner.extension:educational-qualification.extension:year
Institution Practitioner.extension:educational-qualification.extension:institution
City Practitioner.extension:educational-qualification.extension:city
Country Practitioner.extension:educational-qualification.extension:country

Redacted Practitioner details

A person can make a request to their council to make their record confidential. When this is the case the person’s name and other personal details will not be returned in any search or get response. Identifiers and registration details are returned. See Confidentiality.

A practitioner’s Date of birth, Gender and Ethnicity are supplied when a practitioner is added and maintained by their Responsible Authority, but they are withheld on a Get Practitioner response. Admin permissions are required to get all the practitioner details in a response.

The Practitioner resources will contain a security element of "REDACTED" in the meta data when data items within the practitioner resource have been withheld.

HPI Practitioner security labels

Confidentiality level Code HPI Use Information that is redacted with a read scope
Low L All Registered Practitioner records with no confidentiality flag set Gender, birthDate and ethnicity
Moderate M All Non-registered Practitioner records with no confidentiality flag set Gender, birthDate and ethnicity
Restricted and,
Redacted
R, and
REDACTED
All Practitioner records with confidentiality set (Registered and Non-registered Practitioners) Name Official
Name Usual
Name(s) Old
Gender
Date of Birth
Date of death
Language(s)
Ethnicity
ConditionOnPractice (Applies to Registered Practitioner only)

Example of Practitioner with confidentiality flag set

{
    "resourceType": "Practitioner",
    "id": "90ZZLP",
    "meta": {
        "versionId": "9971",
        "lastUpdated": "2022-04-07T09:12:26.000+12:00",
        "profile": [
            "http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"
        ],
        "security": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
                "code": "REDACTED"
            },
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                "code": "R"
            }
        ]
…
}

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date 0..1 (Complex) The date this person died
URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:death-date.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date 0..1 Extension The date of death
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.url 1..1 uri "date"
Practitioner.Slices for extension.extension:death-date.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/death-date"
Practitioner.Slices for extension.extension:educational-qualification 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname 0..1 Extension The full name of the educational qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.url 1..1 uri "fullname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname 0..1 Extension A short name of the educational qualification for when space is limited
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.url 1..1 uri "shortname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year 0..1 Extension The year in which the qualification was granted
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.url 1..1 uri "year"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution 0..1 Extension The institution that granted the qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.url 1..1 uri "institution"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city 0..1 Extension The city where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.url 1..1 uri "city"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country 0..1 Extension The country where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.url 1..1 uri "country"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.value[x] 0..1 string Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Practitioner.Slices for extension.extension:educational-qualification.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
Practitioner.Slices for extension.extension:ethnicity 0..6 CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Open At End by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Practitioner.Slices for identifier.identifier:HPI This element must be supported. This element is included in summaries. 0..1 Identifier The currently active CPN (Common Person Name)
Practitioner.Slices for identifier.identifier:HPI.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier CPN (Common Person Name) identifiers that have been deprecated for this Person
Practitioner.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:RA This element must be supported. This element is included in summaries. 0..* Identifier The RA Identifier
Practitioner.Slices for identifier.identifier:RA.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:RA.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Binding: RaIdentifier (required)
Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:RA.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.extension:death-date.​extension:source.value[x]:valueCodeableConcept Base preferred Date of Death Information Source 📦1.2 HIP FHIR Common Terminology Guide v1.9
Practitioner.extension:educational-qualification.​extension:country.value[x] Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier:HPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​system Base required RaIdentifier 📦1.0 HIP FHIR Common Terminology Guide v1.9

Constraints

Id Grade Path(s) Description Expression

This structure is derived from NzPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date 0..1 Death_date The date this person died
Practitioner.Slices for extension.extension:death-date.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:source 0..0 The source of information
Practitioner.Slices for extension.extension:educational-qualification 0..* EducationalQualification Extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country 0..1 Extension The country where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.value[x] 0..1 string Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Practitioner.Slices for extension.extension:ethnicity 0..6 Nz_ethnicity NZ Ethnicity
Practitioner.Slices for extension.extension:iwi 0..0 Extension
Practitioner.Slices for identifier 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Open At End by value:use, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.use 0..1 code official | old
Binding: IdentifierUse (required)
Practitioner.Slices for identifier.identifier:HPI This element must be supported. 0..1 Identifier The currently active CPN (Common Person Name)
Practitioner.Slices for identifier.identifier:HPI.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.type 0..0 Description of identifier
Practitioner.Slices for identifier.identifier:HPI.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.period 0..0 Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:HPI.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:dormant This element must be supported. 0..* Identifier CPN (Common Person Name) identifiers that have been deprecated for this Person
Practitioner.Slices for identifier.identifier:dormant.use 1..1 code fixed to old
Fixed Value: old (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.type 0..0 Description of identifier
Practitioner.Slices for identifier.identifier:dormant.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.period 0..0 Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:dormant.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:RA This element must be supported. 0..* Identifier The RA Identifier
Practitioner.Slices for identifier.identifier:RA.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:RA.type 0..0 Description of identifier
Practitioner.Slices for identifier.identifier:RA.system 0..1 uri The namespace for the identifier value
Binding: RaIdentifier (required)
Practitioner.Slices for identifier.identifier:RA.period 0..0 Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:RA.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.active 0..0 Whether this practitioner's record is in active use
Practitioner.name.use 0..1 code usual | official | old
Binding: Use values for a HumanName (required)
Practitioner.name.text 0..0 Text representation of the full name
Practitioner.name.prefix 0..* string Parts that come before the name
Binding: Name Prefix Codes (required)
Practitioner.name.suffix 0..0 Parts that come after the name
Binding: Name Suffix Codes (required)
Practitioner.name.period 0..0 Time period when name was/is in use
Practitioner.telecom 0..0 A contact detail for the practitioner (that apply to all roles)
Practitioner.address 0..0 Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.photo 0..0 Image of the person
Practitioner.qualification
Practitioner.qualification.id 0..0 Unique id for inter-element referencing
Practitioner.qualification.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation 0..* AdditionalAuthorisation Additional things the person is authorized to do
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerAdditionalAuthorisationCode (1.0.1) (preferred)
Practitioner.qualification.Slices for extension.extension:condition-on-practice 0..* ConditionOnPractice Conditions that have been applied to the ability of the person to practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date 0..1 RegistrationInitialDate The date that the person was originally registered
Practitioner.qualification.Slices for extension.extension:registration-status-code 0..1 RegistrationStatusCode Status of the registration, and the date it was set
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerRegistrationStatusCode (2.0) (extensible)
Practitioner.qualification.Slices for extension.extension:scope-of-practice 0..* ScopeOfPractice the health services a practitioner is authorised to perform eg Nurse Practitioner
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
Practitioner.qualification.Slices for extension.extension:apc-history 0..* (Complex) A period covered by an annual practicing certificate (APC), including previous APC periods
URL: http://hl7.org.nz/fhir/StructureDefinition/apc-history
Practitioner.qualification.identifier 0..* Identifier The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the Responsible Authority that issues the registration
Binding: HPI Registration Type (required)
Practitioner.qualification.period 0..1 Period The period of the annual practicing certificate issued by the Responsible Authority
Practitioner.qualification.issuer 0..1 Reference(HPI Organization) The HPI Organisation ID of the Responsible Authority that issues the registration
Practitioner.communication
Practitioner.communication.coding 0..* Coding Code defined by a terminology system
Binding: ISO 639-3:2007 (3-alpha language code) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.extension:educational-qualification.​extension:country.value[x] Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier:RA.​system Base required RaIdentifier 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.use Base required Use values for a HumanName 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.prefix Base required Name Prefix Codes 📦2.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​extension:additional-authorisation.​extension:code.valueCodeableConcept Base preferred Additional Practitioner authorisations 📍1.0.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​extension:registration-status-code.​extension:status.valueCodeableConcept Base extensible Registration Status of Practitioners 📍2.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0
Practitioner.qualification.​extension:scope-of-practice.​extension:code.valueCodeableConcept Base preferred Scope of practice 📍2.1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​code Base required HPI Registration Type 📦2.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.communication.​coding Base required ISO 639-3:2007 (3-alpha language code) 📦1.0 HIP FHIR Common Terminology Guide v1.9
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.id This element is included in summaries. 0..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Practitioner.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
Practitioner.contained 0..* Resource Contained, inline Resources
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date 0..1 (Complex) The date this person died
URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:death-date.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:death-date.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date 0..1 Extension The date of death
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.url 1..1 uri "date"
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.value[x] 0..1 dateTime Value of extension
Practitioner.Slices for extension.extension:death-date.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/death-date"
Practitioner.Slices for extension.extension:educational-qualification 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:educational-qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname 0..1 Extension The full name of the educational qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.url 1..1 uri "fullname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname 0..1 Extension A short name of the educational qualification for when space is limited
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.url 1..1 uri "shortname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year 0..1 Extension The year in which the qualification was granted
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.url 1..1 uri "year"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.value[x] 0..1 date Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution 0..1 Extension The institution that granted the qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.url 1..1 uri "institution"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city 0..1 Extension The city where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.url 1..1 uri "city"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country 0..1 Extension The country where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.url 1..1 uri "country"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.value[x] 0..1 string Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Practitioner.Slices for extension.extension:educational-qualification.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
Practitioner.Slices for extension.extension:ethnicity 0..6 CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Open At End by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Practitioner.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
Practitioner.Slices for identifier.identifier:All Slices.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:All Slices.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:HPI This element must be supported. This element is included in summaries. 0..1 Identifier The currently active CPN (Common Person Name)
Practitioner.Slices for identifier.identifier:HPI.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:HPI.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:HPI.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:HPI.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier CPN (Common Person Name) identifiers that have been deprecated for this Person
Practitioner.Slices for identifier.identifier:dormant.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:dormant.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:RA This element must be supported. This element is included in summaries. 0..* Identifier The RA Identifier
Practitioner.Slices for identifier.identifier:RA.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:RA.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:RA.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:RA.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Binding: RaIdentifier (required)
Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:RA.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:RA.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.name This element is included in summaries. 0..* HumanName The name(s) associated with the practitioner
Practitioner.name.id 0..1 string Unique id for inter-element referencing
Practitioner.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | old
Binding: Use values for a HumanName (required)
Practitioner.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Practitioner.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
Binding: Name Prefix Codes (required)
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation 0..* (Complex) Additional things the person is authorized to do
URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification.Slices for extension.extension:additional-authorisation.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.url 1..1 uri "code"
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.Slices for value[x] Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerAdditionalAuthorisationCode (1.0.1) (preferred)
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.url 1..1 uri "period"
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.value[x] 0..1 Period Value of extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation"
Practitioner.qualification.Slices for extension.extension:condition-on-practice 0..* (Complex) Conditions that have been applied to the ability of the person to practice
URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date 0..1 date The date that the person was originally registered
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification.Slices for extension.extension:registration-status-code 0..1 (Complex) Status of the registration, and the date it was set
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification.Slices for extension.extension:registration-status-code.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.url 1..1 uri "status"
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.Slices for value[x] Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerRegistrationStatusCode (2.0) (extensible)
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.url 1..1 uri "period"
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.value[x] 0..1 Period Value of extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/registration-status-code"
Practitioner.qualification.Slices for extension.extension:scope-of-practice 0..* (Complex) the health services a practitioner is authorised to perform eg Nurse Practitioner
URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
Practitioner.qualification.Slices for extension.extension:scope-of-practice.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.url 1..1 uri "code"
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.Slices for value[x] Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.url 1..1 uri "period"
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.value[x] 0..1 Period Value of extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice"
Practitioner.qualification.Slices for extension.extension:apc-history 0..* (Complex) A period covered by an annual practicing certificate (APC), including previous APC periods
URL: http://hl7.org.nz/fhir/StructureDefinition/apc-history
Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier 0..* Identifier The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the Responsible Authority that issues the registration
Binding: HPI Registration Type (required)
Practitioner.qualification.period 0..1 Period The period of the annual practicing certificate issued by the Responsible Authority
Practitioner.qualification.issuer 0..1 Reference(HPI Organization) The HPI Organisation ID of the Responsible Authority that issues the registration
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Practitioner.communication.id 0..1 string Unique id for inter-element referencing
Practitioner.communication.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.communication.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: ISO 639-3:2007 (3-alpha language code) (required)
Practitioner.communication.text This element is included in summaries. 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Practitioner.extension:death-date.​extension:source.value[x]:valueCodeableConcept Base preferred Date of Death Information Source 📦1.2 HIP FHIR Common Terminology Guide v1.9
Practitioner.extension:educational-qualification.​extension:country.value[x] Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Practitioner.identifier:HPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​system Base required RaIdentifier 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.use Base required Use values for a HumanName 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.prefix Base required Name Prefix Codes 📦2.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​extension:additional-authorisation.​extension:code.value[x]:valueCodeableConcept Base preferred Additional Practitioner authorisations 📍1.0.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​extension:registration-status-code.​extension:status.value[x]:valueCodeableConcept Base extensible Registration Status of Practitioners 📍2.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0
Practitioner.qualification.​extension:scope-of-practice.​extension:code.value[x]:valueCodeableConcept Base preferred Scope of practice 📍2.1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​code Base required HPI Registration Type 📦2.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.communication Base preferred Common Languages 📦4.0.1 FHIR Std.
Practitioner.communication.​coding Base required ISO 639-3:2007 (3-alpha language code) 📦1.0 HIP FHIR Common Terminology Guide v1.9

Constraints

Id Grade Path(s) Description Expression

This structure is derived from NzPractitioner

Summary

Mandatory: 0 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 5 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Practitioner.identifier (Open at End)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date 0..1 (Complex) The date this person died
URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:death-date.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date 0..1 Extension The date of death
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.url 1..1 uri "date"
Practitioner.Slices for extension.extension:death-date.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/death-date"
Practitioner.Slices for extension.extension:educational-qualification 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname 0..1 Extension The full name of the educational qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.url 1..1 uri "fullname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname 0..1 Extension A short name of the educational qualification for when space is limited
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.url 1..1 uri "shortname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year 0..1 Extension The year in which the qualification was granted
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.url 1..1 uri "year"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution 0..1 Extension The institution that granted the qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.url 1..1 uri "institution"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city 0..1 Extension The city where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.url 1..1 uri "city"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country 0..1 Extension The country where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.url 1..1 uri "country"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.value[x] 0..1 string Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Practitioner.Slices for extension.extension:educational-qualification.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
Practitioner.Slices for extension.extension:ethnicity 0..6 CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Open At End by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Practitioner.Slices for identifier.identifier:HPI This element must be supported. This element is included in summaries. 0..1 Identifier The currently active CPN (Common Person Name)
Practitioner.Slices for identifier.identifier:HPI.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier CPN (Common Person Name) identifiers that have been deprecated for this Person
Practitioner.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:RA This element must be supported. This element is included in summaries. 0..* Identifier The RA Identifier
Practitioner.Slices for identifier.identifier:RA.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:RA.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Binding: RaIdentifier (required)
Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:RA.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.extension:death-date.​extension:source.value[x]:valueCodeableConcept Base preferred Date of Death Information Source 📦1.2 HIP FHIR Common Terminology Guide v1.9
Practitioner.extension:educational-qualification.​extension:country.value[x] Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier:HPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​system Base required RaIdentifier 📦1.0 HIP FHIR Common Terminology Guide v1.9

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from NzPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date 0..1 Death_date The date this person died
Practitioner.Slices for extension.extension:death-date.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:source 0..0 The source of information
Practitioner.Slices for extension.extension:educational-qualification 0..* EducationalQualification Extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country 0..1 Extension The country where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.value[x] 0..1 string Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Practitioner.Slices for extension.extension:ethnicity 0..6 Nz_ethnicity NZ Ethnicity
Practitioner.Slices for extension.extension:iwi 0..0 Extension
Practitioner.Slices for identifier 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Open At End by value:use, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.use 0..1 code official | old
Binding: IdentifierUse (required)
Practitioner.Slices for identifier.identifier:HPI This element must be supported. 0..1 Identifier The currently active CPN (Common Person Name)
Practitioner.Slices for identifier.identifier:HPI.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.type 0..0 Description of identifier
Practitioner.Slices for identifier.identifier:HPI.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.period 0..0 Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:HPI.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:dormant This element must be supported. 0..* Identifier CPN (Common Person Name) identifiers that have been deprecated for this Person
Practitioner.Slices for identifier.identifier:dormant.use 1..1 code fixed to old
Fixed Value: old (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.type 0..0 Description of identifier
Practitioner.Slices for identifier.identifier:dormant.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.period 0..0 Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:dormant.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:RA This element must be supported. 0..* Identifier The RA Identifier
Practitioner.Slices for identifier.identifier:RA.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:RA.type 0..0 Description of identifier
Practitioner.Slices for identifier.identifier:RA.system 0..1 uri The namespace for the identifier value
Binding: RaIdentifier (required)
Practitioner.Slices for identifier.identifier:RA.period 0..0 Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:RA.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.active 0..0 Whether this practitioner's record is in active use
Practitioner.name
Practitioner.name.use 0..1 code usual | official | old
Binding: Use values for a HumanName (required)
Practitioner.name.text 0..0 Text representation of the full name
Practitioner.name.prefix 0..* string Parts that come before the name
Binding: Name Prefix Codes (required)
Practitioner.name.suffix 0..0 Parts that come after the name
Binding: Name Suffix Codes (required)
Practitioner.name.period 0..0 Time period when name was/is in use
Practitioner.telecom 0..0 A contact detail for the practitioner (that apply to all roles)
Practitioner.address 0..0 Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.photo 0..0 Image of the person
Practitioner.qualification
Practitioner.qualification.id 0..0 Unique id for inter-element referencing
Practitioner.qualification.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation 0..* AdditionalAuthorisation Additional things the person is authorized to do
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerAdditionalAuthorisationCode (1.0.1) (preferred)
Practitioner.qualification.Slices for extension.extension:condition-on-practice 0..* ConditionOnPractice Conditions that have been applied to the ability of the person to practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date 0..1 RegistrationInitialDate The date that the person was originally registered
Practitioner.qualification.Slices for extension.extension:registration-status-code 0..1 RegistrationStatusCode Status of the registration, and the date it was set
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerRegistrationStatusCode (2.0) (extensible)
Practitioner.qualification.Slices for extension.extension:scope-of-practice 0..* ScopeOfPractice the health services a practitioner is authorised to perform eg Nurse Practitioner
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
Practitioner.qualification.Slices for extension.extension:apc-history 0..* (Complex) A period covered by an annual practicing certificate (APC), including previous APC periods
URL: http://hl7.org.nz/fhir/StructureDefinition/apc-history
Practitioner.qualification.identifier 0..* Identifier The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the Responsible Authority that issues the registration
Binding: HPI Registration Type (required)
Practitioner.qualification.period 0..1 Period The period of the annual practicing certificate issued by the Responsible Authority
Practitioner.qualification.issuer 0..1 Reference(HPI Organization) The HPI Organisation ID of the Responsible Authority that issues the registration
Practitioner.communication
Practitioner.communication.coding 0..* Coding Code defined by a terminology system
Binding: ISO 639-3:2007 (3-alpha language code) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.extension:educational-qualification.​extension:country.value[x] Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier:RA.​system Base required RaIdentifier 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.use Base required Use values for a HumanName 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.prefix Base required Name Prefix Codes 📦2.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​extension:additional-authorisation.​extension:code.valueCodeableConcept Base preferred Additional Practitioner authorisations 📍1.0.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​extension:registration-status-code.​extension:status.valueCodeableConcept Base extensible Registration Status of Practitioners 📍2.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0
Practitioner.qualification.​extension:scope-of-practice.​extension:code.valueCodeableConcept Base preferred Scope of practice 📍2.1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​code Base required HPI Registration Type 📦2.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.communication.​coding Base required ISO 639-3:2007 (3-alpha language code) 📦1.0 HIP FHIR Common Terminology Guide v1.9

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.id This element is included in summaries. 0..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Practitioner.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
Practitioner.contained 0..* Resource Contained, inline Resources
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date 0..1 (Complex) The date this person died
URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:death-date.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:death-date.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date 0..1 Extension The date of death
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.url 1..1 uri "date"
Practitioner.Slices for extension.extension:death-date.Slices for extension.extension:date.value[x] 0..1 dateTime Value of extension
Practitioner.Slices for extension.extension:death-date.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/death-date"
Practitioner.Slices for extension.extension:educational-qualification 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:educational-qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname 0..1 Extension The full name of the educational qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.url 1..1 uri "fullname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:fullname.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname 0..1 Extension A short name of the educational qualification for when space is limited
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.url 1..1 uri "shortname"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:shortname.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year 0..1 Extension The year in which the qualification was granted
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.url 1..1 uri "year"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:year.value[x] 0..1 date Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution 0..1 Extension The institution that granted the qualification
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.url 1..1 uri "institution"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:institution.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city 0..1 Extension The city where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.url 1..1 uri "city"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:city.value[x] 0..1 string Value of extension
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country 0..1 Extension The country where the institution is located
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.url 1..1 uri "country"
Practitioner.Slices for extension.extension:educational-qualification.Slices for extension.extension:country.value[x] 0..1 string Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Practitioner.Slices for extension.extension:educational-qualification.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
Practitioner.Slices for extension.extension:ethnicity 0..6 CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Open At End by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Practitioner.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
Practitioner.Slices for identifier.identifier:All Slices.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:All Slices.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:HPI This element must be supported. This element is included in summaries. 0..1 Identifier The currently active CPN (Common Person Name)
Practitioner.Slices for identifier.identifier:HPI.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:HPI.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:HPI.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:HPI.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:HPI.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier CPN (Common Person Name) identifiers that have been deprecated for this Person
Practitioner.Slices for identifier.identifier:dormant.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:dormant.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:dormant.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:RA This element must be supported. This element is included in summaries. 0..* Identifier The RA Identifier
Practitioner.Slices for identifier.identifier:RA.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:RA.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:RA.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Practitioner.Slices for identifier.identifier:RA.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Binding: RaIdentifier (required)
Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:RA.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Practitioner.Slices for identifier.identifier:RA.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Practitioner.name This element is included in summaries. 0..* HumanName The name(s) associated with the practitioner
Practitioner.name.id 0..1 string Unique id for inter-element referencing
Practitioner.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | old
Binding: Use values for a HumanName (required)
Practitioner.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Practitioner.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
Binding: Name Prefix Codes (required)
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation 0..* (Complex) Additional things the person is authorized to do
URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification.Slices for extension.extension:additional-authorisation.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.url 1..1 uri "code"
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.Slices for value[x] Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:code.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerAdditionalAuthorisationCode (1.0.1) (preferred)
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.url 1..1 uri "period"
Practitioner.qualification.Slices for extension.extension:additional-authorisation.Slices for extension.extension:period.value[x] 0..1 Period Value of extension
Practitioner.qualification.Slices for extension.extension:additional-authorisation.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation"
Practitioner.qualification.Slices for extension.extension:condition-on-practice 0..* (Complex) Conditions that have been applied to the ability of the person to practice
URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date 0..1 date The date that the person was originally registered
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification.Slices for extension.extension:registration-status-code 0..1 (Complex) Status of the registration, and the date it was set
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification.Slices for extension.extension:registration-status-code.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.url 1..1 uri "status"
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.Slices for value[x] Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:status.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerRegistrationStatusCode (2.0) (extensible)
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.url 1..1 uri "period"
Practitioner.qualification.Slices for extension.extension:registration-status-code.Slices for extension.extension:period.value[x] 0..1 Period Value of extension
Practitioner.qualification.Slices for extension.extension:registration-status-code.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/registration-status-code"
Practitioner.qualification.Slices for extension.extension:scope-of-practice 0..* (Complex) the health services a practitioner is authorised to perform eg Nurse Practitioner
URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
Practitioner.qualification.Slices for extension.extension:scope-of-practice.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.url 1..1 uri "code"
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.Slices for value[x] Content/Rules for all slices
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:code.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period 0..1 Extension Extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.extension 0..0 Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.url 1..1 uri "period"
Practitioner.qualification.Slices for extension.extension:scope-of-practice.Slices for extension.extension:period.value[x] 0..1 Period Value of extension
Practitioner.qualification.Slices for extension.extension:scope-of-practice.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice"
Practitioner.qualification.Slices for extension.extension:apc-history 0..* (Complex) A period covered by an annual practicing certificate (APC), including previous APC periods
URL: http://hl7.org.nz/fhir/StructureDefinition/apc-history
Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier 0..* Identifier The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the Responsible Authority that issues the registration
Binding: HPI Registration Type (required)
Practitioner.qualification.period 0..1 Period The period of the annual practicing certificate issued by the Responsible Authority
Practitioner.qualification.issuer 0..1 Reference(HPI Organization) The HPI Organisation ID of the Responsible Authority that issues the registration
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Practitioner.communication.id 0..1 string Unique id for inter-element referencing
Practitioner.communication.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.communication.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: ISO 639-3:2007 (3-alpha language code) (required)
Practitioner.communication.text This element is included in summaries. 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Practitioner.extension:death-date.​extension:source.value[x]:valueCodeableConcept Base preferred Date of Death Information Source 📦1.2 HIP FHIR Common Terminology Guide v1.9
Practitioner.extension:educational-qualification.​extension:country.value[x] Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Practitioner.identifier:HPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier:RA.​system Base required RaIdentifier 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.use Base required Use values for a HumanName 📦1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.name.prefix Base required Name Prefix Codes 📦2.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​extension:additional-authorisation.​extension:code.value[x]:valueCodeableConcept Base preferred Additional Practitioner authorisations 📍1.0.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​extension:registration-status-code.​extension:status.value[x]:valueCodeableConcept Base extensible Registration Status of Practitioners 📍2.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0
Practitioner.qualification.​extension:scope-of-practice.​extension:code.value[x]:valueCodeableConcept Base preferred Scope of practice 📍2.1.0 HIP FHIR Common Terminology Guide v1.9
Practitioner.qualification.​code Base required HPI Registration Type 📦2.1 HIP FHIR Common Terminology Guide v1.9
Practitioner.communication Base preferred Common Languages 📦4.0.1 FHIR Std.
Practitioner.communication.​coding Base required ISO 639-3:2007 (3-alpha language code) 📦1.0 HIP FHIR Common Terminology Guide v1.9

Constraints

Id Grade Path(s) Description Expression

This structure is derived from NzPractitioner

Summary

Mandatory: 0 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 5 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Practitioner.identifier (Open at End)

 

Other representations of profile: CSV, Excel, Schematron