HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner | Version: 1.0.0 | |||
| Draft as of 2024-04-19 |
Realm: 
|
Computable Name: NzPractitioner | ||
Practitioner resource for use in NZ
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 death-date |
0..1 | (Complex) | Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
| ethnicity |
0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
| iwi |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |
| messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
  qualification |
||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| additional-authorisation |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |
| condition-on-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |
| registration-initial-date |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date | |
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |
 scope-of-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| death-date |
0..1 | (Complex) | Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
| ethnicity |
0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
| iwi |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |
| messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | 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.
| |||||
| 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) | Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |||||
| educational-qualification |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |||||
| ethnicity |
0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |||||
| iwi |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |||||
| messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| telecom |
Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| address |
Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
| 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 | ||||
| photo |
0..* | Attachment | Image of the person | |||||
 qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| additional-authorisation |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |||||
| condition-on-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |||||
| registration-initial-date |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date | |||||
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |||||
| scope-of-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| 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. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
 issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
This structure is derived from Practitioner
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| death-date |
0..1 | (Complex) | Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
| ethnicity |
0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
| iwi |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |
| messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| qualification |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| additional-authorisation |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |
| condition-on-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |
| registration-initial-date |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date | |
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |
| scope-of-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| death-date |
0..1 | (Complex) | Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
| ethnicity |
0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |
| iwi |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |
| messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | 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.
| |||||
| 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) | Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |||||
| educational-qualification |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |||||
| ethnicity |
0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred) | |||||
| iwi |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |||||
| messaging-address |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| telecom |
Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| address |
Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
| 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 | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| additional-authorisation |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |||||
| condition-on-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice | |||||
| registration-initial-date |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date | |||||
| registration-status-code |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code | |||||
| scope-of-practice |
0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| 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. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
This structure is derived from Practitioner
Summary
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron