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
• 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

An education qualification is made up of

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

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"
            }
        ]
…
}

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from NzPractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
Slices for extension				Content/Rules for all slices
extension:death-date		0..1	Death_date	The date this person died
Slices for extension				Content/Rules for all slices
extension:source		0..0
extension:educational-qualification		0..*	EducationalQualification	Extension
Slices for extension				Content/Rules for all slices
extension:country		0..1	Extension	Extension
value[x]		0..1	string	Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required)
extension:ethnicity		0..6	Nz_ethnicity	NZ Ethnicity
extension:iwi		0..0
Slices for identifier		0..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open At End by value:use, value:system
identifier:All Slices				Content/Rules for all slices
use		0..1	code	official | old Binding: IdentifierUse (required)
identifier:HPI	S	0..1	Identifier	The currently active CPN (Common Person Name)
use		1..1	code	fixed to official Fixed Value: official
type		0..0
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
period		0..0
assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:dormant	S	0..*	Identifier	CPN (Common Person Name) identifiers that have been deprecated for this Person
use		1..1	code	fixed to old Fixed Value: old
type		0..0
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
period		0..0
assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:RA	S	0..*	Identifier	The RA Identifier
use		1..1	code	fixed to official Fixed Value: official
type		0..0
system		0..1	uri	The namespace for the identifier value Binding: RaIdentifier (required)
period		0..0
assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
active		0..0
name
use		0..1	code	usual | official | old Binding: Use values for a HumanName (required)
text		0..0
prefix		0..*	string	Parts that come before the name Binding: Name Prefix Codes (required)
suffix		0..0
period		0..0
telecom		0..0
address		0..0
photo		0..0
qualification
id		0..0
Slices for extension				Content/Rules for all slices
extension:additional-authorisation		0..*	AdditionalAuthorisation	Additional things the person is authorized to do
extension:condition-on-practice		0..*	ConditionOnPractice	Conditions that have been applied to the ability of the person to practice
extension:registration-initial-date		0..1	RegistrationInitialDate	The date that the person was originally registered
extension:registration-status-code		0..1	RegistrationStatusCode	Status of the registration, and the date it was set
extension:scope-of-practice		0..*	ScopeOfPractice	the health services a practitioner is authorised to perform eg Nurse Practitioner
Slices for extension				Content/Rules for all slices
extension:code		0..1	Extension	Extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
identifier		0..*	Identifier	The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
code		1..1	CodeableConcept	Coded representation of the Responsible Authority that issues the registration Binding: HPI Registration Type (required)
period		0..1	Period	The period of the annual practicing certificate issued by the Responsible Authority
issuer		0..1	Reference(HPI Organization)	The HPI Organisation ID of the Responsible Authority that issues the registration
communication
coding		0..*	Coding	Code defined by a terminology system Binding: ISO 639-3:2007 (3-alpha language code) (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Practitioner.extension:educational-qualification.extension:country.value[x]	required	Hpi_country_code_iso_3166_1 https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Practitioner.identifier.use	required	Hpi_IdentfierUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.identifier:RA.system	required	Hpi_Ra_Identifier https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code
Practitioner.name.use	required	Hpi_HumanNameUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
Practitioner.name.prefix	required	Hpi_name_prefix https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Practitioner.qualification.extension:scope-of-practice.extension:code.value[x]:valueCodeableConcept	preferred	PractitionerScopeOfPractice https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code|2.1.0
Practitioner.qualification.code	required	Hpi_registration_type https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
Practitioner.communication.coding	required	Hpi_language_code_iso_639_3 https://nzhts.digital.health.nz/fhir/ValueSet/language-code

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
death-date		0..1	(Complex)	The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:date		0..1	Extension	The date of death ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"date"
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/death-date"
educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:fullname		0..1	Extension	The full name of the educational qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"fullname"
extension:shortname		0..1	Extension	A short name of the educational qualification for when space is limited ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"shortname"
extension:year		0..1	Extension	The year in which the qualification was granted ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"year"
extension:institution		0..1	Extension	The institution that granted the qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"institution"
extension:city		0..1	Extension	The city where the institution is located ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"city"
extension:country		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"country"
value[x]		0..1	string	Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required) ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	Σ	0..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open At End by value:use, value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	official | old Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children
identifier:HPI	SΣ	0..1	Identifier	The currently active CPN (Common Person Name) ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
identifier:dormant	SΣ	0..*	Identifier	CPN (Common Person Name) identifiers that have been deprecated for this Person ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: old
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
identifier:RA	SΣ	0..*	Identifier	The RA Identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official
system	Σ	0..1	uri	The namespace for the identifier value Binding: RaIdentifier (required) ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Practitioner.extension:death-date.extension:source.value[x]:valueCodeableConcept	preferred	Nhi_date_of_death_source https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Practitioner.extension:educational-qualification.extension:country.value[x]	required	Hpi_country_code_iso_3166_1 https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Practitioner.identifier.use	required	Hpi_IdentfierUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.identifier:HPI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:dormant.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.system	required	Hpi_Ra_Identifier https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
death-date		0..1	(Complex)	The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:date		0..1	Extension	The date of death
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"date"
value[x]		0..1	dateTime	Value of extension
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/death-date"
educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:fullname		0..1	Extension	The full name of the educational qualification
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"fullname"
value[x]		0..1	string	Value of extension
extension:shortname		0..1	Extension	A short name of the educational qualification for when space is limited
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"shortname"
value[x]		0..1	string	Value of extension
extension:year		0..1	Extension	The year in which the qualification was granted
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"year"
value[x]		0..1	date	Value of extension
extension:institution		0..1	Extension	The institution that granted the qualification
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"institution"
value[x]		0..1	string	Value of extension
extension:city		0..1	Extension	The city where the institution is located
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"city"
value[x]		0..1	string	Value of extension
extension:country		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"country"
value[x]		0..1	string	Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required)
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open At End by value:use, value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	official | old Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:HPI	SΣ	0..1	Identifier	The currently active CPN (Common Person Name)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:dormant	SΣ	0..*	Identifier	CPN (Common Person Name) identifiers that have been deprecated for this Person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:RA	SΣ	0..*	Identifier	The RA Identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	0..1	uri	The namespace for the identifier value Binding: RaIdentifier (required) Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
name	Σ	0..*	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | old Binding: Use values for a HumanName (required)
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	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
prefix	Σ	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
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the practitioner was born
qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
additional-authorisation		0..*	(Complex)	Additional things the person is authorized to do URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
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
registration-initial-date		0..1	date	The date that the person was originally registered URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
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
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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
extension:period		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"period"
value[x]		0..1	Period	Value of extension
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice"
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..*	Identifier	The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
code		1..1	CodeableConcept	Coded representation of the Responsible Authority that issues the registration Binding: HPI Registration Type (required)
period		0..1	Period	The period of the annual practicing certificate issued by the Responsible Authority
issuer		0..1	Reference(HPI Organization)	The HPI Organisation ID of the Responsible Authority that issues the registration
communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: ISO 639-3:2007 (3-alpha language code) (required)
text	Σ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Practitioner.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Practitioner.extension:death-date.extension:source.value[x]:valueCodeableConcept	preferred	Nhi_date_of_death_source https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Practitioner.extension:educational-qualification.extension:country.value[x]	required	Hpi_country_code_iso_3166_1 https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Practitioner.identifier.use	required	Hpi_IdentfierUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.identifier:HPI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:dormant.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.system	required	Hpi_Ra_Identifier https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code
Practitioner.name.use	required	Hpi_HumanNameUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
Practitioner.name.prefix	required	Hpi_name_prefix https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.extension:scope-of-practice.extension:code.value[x]:valueCodeableConcept	preferred	PractitionerScopeOfPractice https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code|2.1.0
Practitioner.qualification.code	required	Hpi_registration_type https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
Practitioner.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Practitioner.communication.coding	required	Hpi_language_code_iso_639_3 https://nzhts.digital.health.nz/fhir/ValueSet/language-code

Differential View

This structure is derived from NzPractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
Slices for extension				Content/Rules for all slices
extension:death-date		0..1	Death_date	The date this person died
Slices for extension				Content/Rules for all slices
extension:source		0..0
extension:educational-qualification		0..*	EducationalQualification	Extension
Slices for extension				Content/Rules for all slices
extension:country		0..1	Extension	Extension
value[x]		0..1	string	Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required)
extension:ethnicity		0..6	Nz_ethnicity	NZ Ethnicity
extension:iwi		0..0
Slices for identifier		0..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open At End by value:use, value:system
identifier:All Slices				Content/Rules for all slices
use		0..1	code	official | old Binding: IdentifierUse (required)
identifier:HPI	S	0..1	Identifier	The currently active CPN (Common Person Name)
use		1..1	code	fixed to official Fixed Value: official
type		0..0
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
period		0..0
assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:dormant	S	0..*	Identifier	CPN (Common Person Name) identifiers that have been deprecated for this Person
use		1..1	code	fixed to old Fixed Value: old
type		0..0
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
period		0..0
assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:RA	S	0..*	Identifier	The RA Identifier
use		1..1	code	fixed to official Fixed Value: official
type		0..0
system		0..1	uri	The namespace for the identifier value Binding: RaIdentifier (required)
period		0..0
assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
active		0..0
name
use		0..1	code	usual | official | old Binding: Use values for a HumanName (required)
text		0..0
prefix		0..*	string	Parts that come before the name Binding: Name Prefix Codes (required)
suffix		0..0
period		0..0
telecom		0..0
address		0..0
photo		0..0
qualification
id		0..0
Slices for extension				Content/Rules for all slices
extension:additional-authorisation		0..*	AdditionalAuthorisation	Additional things the person is authorized to do
extension:condition-on-practice		0..*	ConditionOnPractice	Conditions that have been applied to the ability of the person to practice
extension:registration-initial-date		0..1	RegistrationInitialDate	The date that the person was originally registered
extension:registration-status-code		0..1	RegistrationStatusCode	Status of the registration, and the date it was set
extension:scope-of-practice		0..*	ScopeOfPractice	the health services a practitioner is authorised to perform eg Nurse Practitioner
Slices for extension				Content/Rules for all slices
extension:code		0..1	Extension	Extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
identifier		0..*	Identifier	The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
code		1..1	CodeableConcept	Coded representation of the Responsible Authority that issues the registration Binding: HPI Registration Type (required)
period		0..1	Period	The period of the annual practicing certificate issued by the Responsible Authority
issuer		0..1	Reference(HPI Organization)	The HPI Organisation ID of the Responsible Authority that issues the registration
communication
coding		0..*	Coding	Code defined by a terminology system Binding: ISO 639-3:2007 (3-alpha language code) (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Practitioner.extension:educational-qualification.extension:country.value[x]	required	Hpi_country_code_iso_3166_1 https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Practitioner.identifier.use	required	Hpi_IdentfierUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.identifier:RA.system	required	Hpi_Ra_Identifier https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code
Practitioner.name.use	required	Hpi_HumanNameUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
Practitioner.name.prefix	required	Hpi_name_prefix https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Practitioner.qualification.extension:scope-of-practice.extension:code.value[x]:valueCodeableConcept	preferred	PractitionerScopeOfPractice https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code|2.1.0
Practitioner.qualification.code	required	Hpi_registration_type https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
Practitioner.communication.coding	required	Hpi_language_code_iso_639_3 https://nzhts.digital.health.nz/fhir/ValueSet/language-code

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
death-date		0..1	(Complex)	The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:date		0..1	Extension	The date of death ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"date"
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/death-date"
educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:fullname		0..1	Extension	The full name of the educational qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"fullname"
extension:shortname		0..1	Extension	A short name of the educational qualification for when space is limited ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"shortname"
extension:year		0..1	Extension	The year in which the qualification was granted ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"year"
extension:institution		0..1	Extension	The institution that granted the qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"institution"
extension:city		0..1	Extension	The city where the institution is located ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"city"
extension:country		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"country"
value[x]		0..1	string	Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required) ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	Σ	0..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open At End by value:use, value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	official | old Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children
identifier:HPI	SΣ	0..1	Identifier	The currently active CPN (Common Person Name) ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
identifier:dormant	SΣ	0..*	Identifier	CPN (Common Person Name) identifiers that have been deprecated for this Person ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: old
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
identifier:RA	SΣ	0..*	Identifier	The RA Identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official
system	Σ	0..1	uri	The namespace for the identifier value Binding: RaIdentifier (required) ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Practitioner.extension:death-date.extension:source.value[x]:valueCodeableConcept	preferred	Nhi_date_of_death_source https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Practitioner.extension:educational-qualification.extension:country.value[x]	required	Hpi_country_code_iso_3166_1 https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Practitioner.identifier.use	required	Hpi_IdentfierUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.identifier:HPI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:dormant.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.system	required	Hpi_Ra_Identifier https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
death-date		0..1	(Complex)	The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:date		0..1	Extension	The date of death
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"date"
value[x]		0..1	dateTime	Value of extension
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/death-date"
educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:fullname		0..1	Extension	The full name of the educational qualification
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"fullname"
value[x]		0..1	string	Value of extension
extension:shortname		0..1	Extension	A short name of the educational qualification for when space is limited
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"shortname"
value[x]		0..1	string	Value of extension
extension:year		0..1	Extension	The year in which the qualification was granted
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"year"
value[x]		0..1	date	Value of extension
extension:institution		0..1	Extension	The institution that granted the qualification
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"institution"
value[x]		0..1	string	Value of extension
extension:city		0..1	Extension	The city where the institution is located
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"city"
value[x]		0..1	string	Value of extension
extension:country		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"country"
value[x]		0..1	string	Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required)
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/educational-qualification"
ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open At End by value:use, value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	official | old Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:HPI	SΣ	0..1	Identifier	The currently active CPN (Common Person Name)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:dormant	SΣ	0..*	Identifier	CPN (Common Person Name) identifiers that have been deprecated for this Person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
identifier:RA	SΣ	0..*	Identifier	The RA Identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	0..1	uri	The namespace for the identifier value Binding: RaIdentifier (required) Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
name	Σ	0..*	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | old Binding: Use values for a HumanName (required)
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	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
prefix	Σ	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
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the practitioner was born
qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
additional-authorisation		0..*	(Complex)	Additional things the person is authorized to do URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
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
registration-initial-date		0..1	date	The date that the person was originally registered URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
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
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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: PractitionerScopeOfPractice (2.1.0) (preferred)
extension:period		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"period"
value[x]		0..1	Period	Value of extension
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice"
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..*	Identifier	The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number
code		1..1	CodeableConcept	Coded representation of the Responsible Authority that issues the registration Binding: HPI Registration Type (required)
period		0..1	Period	The period of the annual practicing certificate issued by the Responsible Authority
issuer		0..1	Reference(HPI Organization)	The HPI Organisation ID of the Responsible Authority that issues the registration
communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: ISO 639-3:2007 (3-alpha language code) (required)
text	Σ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Practitioner.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Practitioner.extension:death-date.extension:source.value[x]:valueCodeableConcept	preferred	Nhi_date_of_death_source https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Practitioner.extension:educational-qualification.extension:country.value[x]	required	Hpi_country_code_iso_3166_1 https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Practitioner.identifier.use	required	Hpi_IdentfierUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.identifier:HPI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:dormant.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier:RA.system	required	Hpi_Ra_Identifier https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code
Practitioner.name.use	required	Hpi_HumanNameUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
Practitioner.name.prefix	required	Hpi_name_prefix https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.extension:scope-of-practice.extension:code.value[x]:valueCodeableConcept	preferred	PractitionerScopeOfPractice https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code|2.1.0
Practitioner.qualification.code	required	Hpi_registration_type https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
Practitioner.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Practitioner.communication.coding	required	Hpi_language_code_iso_639_3 https://nzhts.digital.health.nz/fhir/ValueSet/language-code

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:

• HPI Organization (http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization)
• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)

Slices

This structure defines the following Slices:

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