New Zealand HPI Implementation Guide, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Resource Profile: HPI Practitioner
| Defining URL: | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/HpiPractitioner |
| Version: | 0.2.0 |
| Name: | HpiPractitioner |
| Title: | HPI Practitioner |
| Status: | Active as of 2021-08-31T02:39:29+00:00 |
| Definition: | The practitioner exposed by the HPI. This is the person who delivers care - regardless of qualification. |
| Publisher: | David Hay |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/HpiPractitioner
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 Dentists, Dental hygienist and Dental and Oral health therapist, 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, Pharmacists, Physiotherapists, Psychologists, Psychotherapists.
Chiropractors, Podiatrist and Osteopaths also covered by the Act are working towards supplying their members data to the HPI also.
It is intended with the upgraded capabilities that other professional groups will also supply their members also eg Social Workers, Acupuncturists, Audiologists, Counsellors, Cardiac Physiologists, paramedics, 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’. 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.
Practitioner Qualifications
The Practitioner resource has a single qualification element that holds 2 distinct categories of information from the perspective of the HPI.
- Qualifications are regarded as recognition of a particular academic achievement. For example a medical or nursing degree
- Registrations are statements of ‘fitness to practice’ in New Zealand, and are conferred by the Registration authority. Generally - though not always - there is a degree as well, though it is at the discretion of the Registration Authority that fitness to practice is stated.
After some discussion, it was decided that only ‘registration’ information is to be included in the Practitioner resource to avoid confusion. This can be revisited if needed.
There are 2 elements within the qualification element that are related to the Registration Authority.
- qualification.issuer is a reference to the Organization resource that represents the asserter
- qualification.identifier.system is a url that represents the namespace of the Registration Authority
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
Summary
Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 4 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
- http://hl7.org.nz/fhir/StructureDefinition/death-date
- http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
- http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
- http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
- http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
- http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
- http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Slices
This structure defines the following Slices:
- The element Practitioner.identifier is sliced based on the values of value:use, value:system (Open at End)
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 | |
 nz-ethnicity | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |
| death-date | 0..1 | (Complex) | The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
  Slices for identifier | 1..* | 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 | |||
  type | 0..0 | |||
 system | 0..1 | uri | The namespace for the identifier value Binding: Use values for an identifier (required) Example HPI: https://standards.digital.health.nz/ns/hpi-provider-id | |
| identifier:HPI | S | 1..1 | Identifier | The currently active CPN (Common Person Name) |
 use | 1..1 | code | usual | official | temp | secondary | old (If known) 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-provider-id | |
 identifier:dormant | S | 0..* | Identifier | CPN (Common Person Name) identifiers that have been deprecated for this Person |
 use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: old | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-id | |
| active | 0..0 | |||
| name | S | 1..* | HumanName | The name(s) associated with the practitioner |
 use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: Use values for a HumanName (required) | |
| telecom | 0..0 | |||
 address | 0..0 | |||
| gender | 1..1 | code | male | female | other | unknown | |
| photo | 0..0 | |||
 qualification | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| additional-authorisation | 0..* | (Complex) | Additional things the person is authorized to do URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |
| scope-of-practice | 0..* | (Complex) | The overall practice scope - eg Nurse Prescriber URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| 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 | |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Professional registration the healthcare provider has (required) | |
| 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 | string | 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) Max Binding: AllLanguages: 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 | |
| nz-ethnicity | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |
| death-date | 0..1 | (Complex) | The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 0..1 | uri | The namespace for the identifier value Binding: Use values for an identifier (required) Example General: http://www.acme.com/identifiers/patient Example HPI: https://standards.digital.health.nz/ns/hpi-provider-id |
| 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Σ | 1..1 | Identifier | The currently active CPN (Common Person Name) |
| 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 | |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) 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-provider-id |
| 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: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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-id |
| 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) |
| name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| 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 | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: Use values for a HumanName (required) |
| text | Σ | 0..1 | string | Text representation of the full name |
| 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 This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| gender | Σ | 1..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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| additional-authorisation | 0..* | (Complex) | Additional things the person is authorized to do URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |
| scope-of-practice | 0..* | (Complex) | The overall practice scope - eg Nurse Prescriber URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| 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 | |
| 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: Professional registration the healthcare provider has (required) | |
| 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) Max Binding: AllLanguages: A human language. | |
| 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 | |
| identifier:HPI | Σ | 1..1 | Identifier | The currently active CPN (Common Person Name) |
| identifier:dormant | Σ | 0..* | Identifier | CPN (Common Person Name) identifiers that have been deprecated for this Person |
| name | Σ | 1..* | HumanName | The name(s) associated with the practitioner |
| Documentation for this format | ||||
This structure is derived from Practitioner
Summary
Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 4 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
- http://hl7.org.nz/fhir/StructureDefinition/death-date
- http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
- http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
- http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
- http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
- http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
- http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Slices
This structure defines the following Slices:
- The element Practitioner.identifier is sliced based on the values of value:use, value:system (Open at End)
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 | |
| nz-ethnicity | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |
| death-date | 0..1 | (Complex) | The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
| Slices for identifier | 1..* | 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 | |||
| type | 0..0 | |||
| system | 0..1 | uri | The namespace for the identifier value Binding: Use values for an identifier (required) Example HPI: https://standards.digital.health.nz/ns/hpi-provider-id | |
| identifier:HPI | S | 1..1 | Identifier | The currently active CPN (Common Person Name) |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) 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-provider-id | |
| identifier:dormant | S | 0..* | Identifier | CPN (Common Person Name) identifiers that have been deprecated for this Person |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: old | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-id | |
| active | 0..0 | |||
| name | S | 1..* | HumanName | The name(s) associated with the practitioner |
| use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: Use values for a HumanName (required) | |
| telecom | 0..0 | |||
| address | 0..0 | |||
| gender | 1..1 | code | male | female | other | unknown | |
| photo | 0..0 | |||
| qualification | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| additional-authorisation | 0..* | (Complex) | Additional things the person is authorized to do URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |
| scope-of-practice | 0..* | (Complex) | The overall practice scope - eg Nurse Prescriber URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| 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 | |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Professional registration the healthcare provider has (required) | |
| 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 | string | 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) Max Binding: AllLanguages: 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 | |
| nz-ethnicity | 0..6 | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |
| death-date | 0..1 | (Complex) | The date this person died URL: http://hl7.org.nz/fhir/StructureDefinition/death-date | |
| educational-qualification | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 0..1 | uri | The namespace for the identifier value Binding: Use values for an identifier (required) Example General: http://www.acme.com/identifiers/patient Example HPI: https://standards.digital.health.nz/ns/hpi-provider-id |
| 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Σ | 1..1 | Identifier | The currently active CPN (Common Person Name) |
| 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 | |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) 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-provider-id |
| 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: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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-provider-id |
| 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) |
| name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| 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 | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: Use values for a HumanName (required) |
| text | Σ | 0..1 | string | Text representation of the full name |
| 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 This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| gender | Σ | 1..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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| additional-authorisation | 0..* | (Complex) | Additional things the person is authorized to do URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation | |
| scope-of-practice | 0..* | (Complex) | The overall practice scope - eg Nurse Prescriber URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | |
| 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 | |
| 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: Professional registration the healthcare provider has (required) | |
| 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) Max Binding: AllLanguages: A human language. | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Practitioner.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.identifier.system | required | IdentifierUse |
| Practitioner.identifier:HPI.use | required | Fixed Value: official |
| Practitioner.identifier:dormant.use | required | Fixed Value: old |
| Practitioner.identifier:dormant.type | extensible | Identifier Type Codes |
| Practitioner.name.use | required | HumanNameUse |
| Practitioner.gender | required | AdministrativeGender |
| Practitioner.qualification.code | required | RegistrationAuthority |
| Practitioner.communication | preferred | CommonLanguages Max Binding: AllLanguages |
Notes:
FSH
//Aliases for extensions Alias: $death-date = http://hl7.org.nz/fhir/hpi/StructureDefinition/death-date Alias: $registration-status = http://hl7.org.nz/fhir/hpi/StructureDefinition/registration-status Alias: $additional-authorization = http://hl7.org.nz/fhir/hpi/StructureDefinition/additional-authorization Alias: $condition-on-practice = http://hl7.org.nz/fhir/hpi/StructureDefinition/condition-on-practice Alias: $registration-initial-date = http://hl7.org.nz/fhir/hpi/StructureDefinition/registration-initial-date Alias: $scope-of-practice = http://hl7.org.nz/fhir/hpi/StructureDefinition/scope-of-practice Profile: HpiPractitioner Parent: NzPractitioner Id: HpiPractitioner Title: "HPI Practitioner" Description: "The practitioner exposed by the HPI. This is the person who delivers care - regardless of qualification." * ^text.div = "HPI Practitioner profile" * ^text.status = #additional * ^purpose = "Describe the Practitioner that will be returned by the HPI" //elements that have been removed * active 0..0 * telecom 0..0 * address 0..0 * photo 0..0 //top level extensions * extension contains $death-date named death-date 0..1 //slice identifier to add none or more dormant NHI as Must Support * identifier ^slicing.discriminator.type = #value * identifier ^slicing.discriminator.path = "use" * identifier ^slicing.rules = #openAtEnd * identifier contains dormant 0..* MS * identifier[dormant].system = "https://standards.digital.health.nz/id/hpi-person" * identifier[dormant].use = #old * identifier[dormant] ^short = "CPN (Common Person Name) identifiers that have been deprecated for this Person" //the gender is required by the HPI * gender 1..1 //many extensions on qualification * qualification.extension contains $registration-status named registration-status 0..1 and $additional-authorization named additional-authorization 0..* and $scope-of-practice named scope-of-practice 0..* and $condition-on-practice named condition-on-practice 0..* and $registration-initial-date named registration-initial-date 0..1