Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.29.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.29.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AIR Practitioner Profile

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner Version: 1.29.0-SNAPSHOT
Active as of 2026-10-12 Computable Name: AIRPractitioner

This profile derived from NZPractitioner implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).

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 C 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: nz-prac-1
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) Date of death
URL: 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:ethnicity 0..* CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.Slices for extension.extension:iwi 0..* CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nz-prac-1 warning Practitioner The practitioner identifier SHOULD be either the HPI CPN (https://standards.digital.health.nz/ns/hpi-person-id) which is preferred, the Salesforce Vaccinating Health Worker ID (https://standards.digital.health.nz/ns/air-vhw-id), the NZ Medical Council ID (https://standards.digital.health.nz/ns/medical-council-id), the NZ Nursing Council ID (https://standards.digital.health.nz/ns/nursing-council-id, the NZ Pharmacy Council ID (https://standards.digital.health.nz/ns/pharmacy-council-id), the NZ Paramedic Council ID (https://standards.digital.health.nz/ns/paramedic-council-id), the NZ Midwifery Council ID (https://standards.digital.health.nz/ns/midwifery-council-id), Healthcare Assistants ID (https://HCA), or the CIR Vaccinator ID (https://standards.digital.health.nz/ns/air-cir-id)). If another identifier sent to ImmSOT, it will result in a data quality issue and be flagged for follow-up. Practitioner.identifier.where(system='https://standards.digital.health.nz/ns/hpi-person-id' or system='https://standards.digital.health.nz/ns/air-vhw-id' or system='https://standards.digital.health.nz/ns/medical-council-id' or system='https://standards.digital.health.nz/ns/nursing-council-id' or system='https://standards.digital.health.nz/ns/pharmacy-council-id' or system='https://standards.digital.health.nz/ns/paramedic-council-id' or system='https://standards.digital.health.nz/ns/midwifery-council-id' or system='https://HCA' or system='https://standards.digital.health.nz/ns/air-cir-id')

This structure is derived from NzPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: nz-prac-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
nz-prac-1 warning Practitioner The practitioner identifier SHOULD be either the HPI CPN (https://standards.digital.health.nz/ns/hpi-person-id) which is preferred, the Salesforce Vaccinating Health Worker ID (https://standards.digital.health.nz/ns/air-vhw-id), the NZ Medical Council ID (https://standards.digital.health.nz/ns/medical-council-id), the NZ Nursing Council ID (https://standards.digital.health.nz/ns/nursing-council-id, the NZ Pharmacy Council ID (https://standards.digital.health.nz/ns/pharmacy-council-id), the NZ Paramedic Council ID (https://standards.digital.health.nz/ns/paramedic-council-id), the NZ Midwifery Council ID (https://standards.digital.health.nz/ns/midwifery-council-id), Healthcare Assistants ID (https://HCA), or the CIR Vaccinator ID (https://standards.digital.health.nz/ns/air-cir-id)). If another identifier sent to ImmSOT, it will result in a data quality issue and be flagged for follow-up. Practitioner.identifier.where(system='https://standards.digital.health.nz/ns/hpi-person-id' or system='https://standards.digital.health.nz/ns/air-vhw-id' or system='https://standards.digital.health.nz/ns/medical-council-id' or system='https://standards.digital.health.nz/ns/nursing-council-id' or system='https://standards.digital.health.nz/ns/pharmacy-council-id' or system='https://standards.digital.health.nz/ns/paramedic-council-id' or system='https://standards.digital.health.nz/ns/midwifery-council-id' or system='https://HCA' or system='https://standards.digital.health.nz/ns/air-cir-id')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: nz-prac-1
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) Date of death
URL: 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:ethnicity 0..* CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.Slices for extension.extension:iwi 0..* CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name This element is included in summaries. 0..* HumanName The name(s) associated with the practitioner
Practitioner.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.address This element is included in summaries. 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
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.photo 0..* Attachment Image of the person
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification.Slices for extension.extension:condition-on-practice 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date 0..1 date Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification.Slices for extension.extension:registration-status-code 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification.Slices for extension.extension:scope-of-practice 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
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 An identifier for this qualification for the practitioner
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding


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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nz-prac-1 warning Practitioner The practitioner identifier SHOULD be either the HPI CPN (https://standards.digital.health.nz/ns/hpi-person-id) which is preferred, the Salesforce Vaccinating Health Worker ID (https://standards.digital.health.nz/ns/air-vhw-id), the NZ Medical Council ID (https://standards.digital.health.nz/ns/medical-council-id), the NZ Nursing Council ID (https://standards.digital.health.nz/ns/nursing-council-id, the NZ Pharmacy Council ID (https://standards.digital.health.nz/ns/pharmacy-council-id), the NZ Paramedic Council ID (https://standards.digital.health.nz/ns/paramedic-council-id), the NZ Midwifery Council ID (https://standards.digital.health.nz/ns/midwifery-council-id), Healthcare Assistants ID (https://HCA), or the CIR Vaccinator ID (https://standards.digital.health.nz/ns/air-cir-id)). If another identifier sent to ImmSOT, it will result in a data quality issue and be flagged for follow-up. Practitioner.identifier.where(system='https://standards.digital.health.nz/ns/hpi-person-id' or system='https://standards.digital.health.nz/ns/air-vhw-id' or system='https://standards.digital.health.nz/ns/medical-council-id' or system='https://standards.digital.health.nz/ns/nursing-council-id' or system='https://standards.digital.health.nz/ns/pharmacy-council-id' or system='https://standards.digital.health.nz/ns/paramedic-council-id' or system='https://standards.digital.health.nz/ns/midwifery-council-id' or system='https://HCA' or system='https://standards.digital.health.nz/ns/air-cir-id')

This structure is derived from NzPractitioner

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: nz-prac-1
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) Date of death
URL: 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:ethnicity 0..* CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.Slices for extension.extension:iwi 0..* CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nz-prac-1 warning Practitioner The practitioner identifier SHOULD be either the HPI CPN (https://standards.digital.health.nz/ns/hpi-person-id) which is preferred, the Salesforce Vaccinating Health Worker ID (https://standards.digital.health.nz/ns/air-vhw-id), the NZ Medical Council ID (https://standards.digital.health.nz/ns/medical-council-id), the NZ Nursing Council ID (https://standards.digital.health.nz/ns/nursing-council-id, the NZ Pharmacy Council ID (https://standards.digital.health.nz/ns/pharmacy-council-id), the NZ Paramedic Council ID (https://standards.digital.health.nz/ns/paramedic-council-id), the NZ Midwifery Council ID (https://standards.digital.health.nz/ns/midwifery-council-id), Healthcare Assistants ID (https://HCA), or the CIR Vaccinator ID (https://standards.digital.health.nz/ns/air-cir-id)). If another identifier sent to ImmSOT, it will result in a data quality issue and be flagged for follow-up. Practitioner.identifier.where(system='https://standards.digital.health.nz/ns/hpi-person-id' or system='https://standards.digital.health.nz/ns/air-vhw-id' or system='https://standards.digital.health.nz/ns/medical-council-id' or system='https://standards.digital.health.nz/ns/nursing-council-id' or system='https://standards.digital.health.nz/ns/pharmacy-council-id' or system='https://standards.digital.health.nz/ns/paramedic-council-id' or system='https://standards.digital.health.nz/ns/midwifery-council-id' or system='https://HCA' or system='https://standards.digital.health.nz/ns/air-cir-id')

Differential View

This structure is derived from NzPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: nz-prac-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
nz-prac-1 warning Practitioner The practitioner identifier SHOULD be either the HPI CPN (https://standards.digital.health.nz/ns/hpi-person-id) which is preferred, the Salesforce Vaccinating Health Worker ID (https://standards.digital.health.nz/ns/air-vhw-id), the NZ Medical Council ID (https://standards.digital.health.nz/ns/medical-council-id), the NZ Nursing Council ID (https://standards.digital.health.nz/ns/nursing-council-id, the NZ Pharmacy Council ID (https://standards.digital.health.nz/ns/pharmacy-council-id), the NZ Paramedic Council ID (https://standards.digital.health.nz/ns/paramedic-council-id), the NZ Midwifery Council ID (https://standards.digital.health.nz/ns/midwifery-council-id), Healthcare Assistants ID (https://HCA), or the CIR Vaccinator ID (https://standards.digital.health.nz/ns/air-cir-id)). If another identifier sent to ImmSOT, it will result in a data quality issue and be flagged for follow-up. Practitioner.identifier.where(system='https://standards.digital.health.nz/ns/hpi-person-id' or system='https://standards.digital.health.nz/ns/air-vhw-id' or system='https://standards.digital.health.nz/ns/medical-council-id' or system='https://standards.digital.health.nz/ns/nursing-council-id' or system='https://standards.digital.health.nz/ns/pharmacy-council-id' or system='https://standards.digital.health.nz/ns/paramedic-council-id' or system='https://standards.digital.health.nz/ns/midwifery-council-id' or system='https://HCA' or system='https://standards.digital.health.nz/ns/air-cir-id')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* NzPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: nz-prac-1
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) Date of death
URL: 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:ethnicity 0..* CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
Practitioner.Slices for extension.extension:iwi 0..* CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name This element is included in summaries. 0..* HumanName The name(s) associated with the practitioner
Practitioner.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.address This element is included in summaries. 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
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.photo 0..* Attachment Image of the person
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification.Slices for extension.extension:condition-on-practice 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date 0..1 date Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification.Slices for extension.extension:registration-status-code 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification.Slices for extension.extension:scope-of-practice 0..* (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
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 An identifier for this qualification for the practitioner
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding


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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nz-prac-1 warning Practitioner The practitioner identifier SHOULD be either the HPI CPN (https://standards.digital.health.nz/ns/hpi-person-id) which is preferred, the Salesforce Vaccinating Health Worker ID (https://standards.digital.health.nz/ns/air-vhw-id), the NZ Medical Council ID (https://standards.digital.health.nz/ns/medical-council-id), the NZ Nursing Council ID (https://standards.digital.health.nz/ns/nursing-council-id, the NZ Pharmacy Council ID (https://standards.digital.health.nz/ns/pharmacy-council-id), the NZ Paramedic Council ID (https://standards.digital.health.nz/ns/paramedic-council-id), the NZ Midwifery Council ID (https://standards.digital.health.nz/ns/midwifery-council-id), Healthcare Assistants ID (https://HCA), or the CIR Vaccinator ID (https://standards.digital.health.nz/ns/air-cir-id)). If another identifier sent to ImmSOT, it will result in a data quality issue and be flagged for follow-up. Practitioner.identifier.where(system='https://standards.digital.health.nz/ns/hpi-person-id' or system='https://standards.digital.health.nz/ns/air-vhw-id' or system='https://standards.digital.health.nz/ns/medical-council-id' or system='https://standards.digital.health.nz/ns/nursing-council-id' or system='https://standards.digital.health.nz/ns/pharmacy-council-id' or system='https://standards.digital.health.nz/ns/paramedic-council-id' or system='https://standards.digital.health.nz/ns/midwifery-council-id' or system='https://HCA' or system='https://standards.digital.health.nz/ns/air-cir-id')

This structure is derived from NzPractitioner

Summary

 

Other representations of profile: CSV, Excel, Schematron