New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel |
Version: | 0.9.0 |
Name: | ProviderModel |
Title: | Healthcare provider |
Status: | Active as of 12/3/21, 2:22 AM |
Definition: | A person who delivers care |
Publisher: | Ministry of Health |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel
This is the logical model that represents the business data that id exposed for a Provider of healthcare such as a Doctor, Nurse or Allied Health provider.
It does not represent the actual format of the exposed resource (which is a Practitioner), rather the data within it.
Specific notes:
The actual profile on Practitioner can he found here
These are defined in the New Zealand Base Implementation Guide
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Element
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProviderModel | 0..* | Element | Healthcare provider | |
name | 0..1 | HumanName | Name of the practitioner | |
hpiCPN | 1..1 | Identifier | The HPI Common Person Number | |
dormantCPN | 0..* | Identifier | Previously assigned CPN identifiers | |
gender | 0..1 | code | Provider gender Binding: AdministrativeGender (required) | |
birthDate | 0..1 | date | Date of Birth | |
deathDate | 0..1 | date | Date of Death | |
communication | 0..* | CodeableConcept | Language/s spoken by the provider Binding: CommonLanguages (required) | |
ethnicity | 0..6 | CodeableConcept | Ethnicity of the provider Binding: Ethnicity of a person (required) | |
registration | 0..* | BackboneElement | Professional registration | |
status | 1..1 | CodeableConcept | The status of the registration Binding: Registration Status of Practitioners (required) | |
identifier | 0..* | Identifier | Any identifiers | |
code | 1..1 | CodeableConcept | The code representing the qualification itself | |
period | 0..* | Period | The period over which the registration is active (otherwise called the APC) | |
issuer | 0..1 | Reference(Organization) | The organization that issued the registration | |
initialDate | 0..1 | date | The date that this registration was first recorded | |
additionalAuthorization | 0..* | BackboneElement | Additional Authorizations for this provider | |
code | 0..1 | CodeableConcept | The code that represents the authorization Binding: Additional activities that a Practitioner is authorised to perform (required) | |
period | 0..* | Period | The period over which the authorization is active | |
scopeOfPractice | 0..* | BackboneElement | Scope of practice for this provider | |
code | 0..1 | CodeableConcept | The code that represents the Scope of practice Binding: Scope of practice (required) | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the Scope of practice is active | |
conditionOnPractice | 0..* | BackboneElement | Conditions that affect what this provider can do | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the condition is active | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProviderModel | 0..* | Element | Healthcare provider | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
name | 0..1 | HumanName | Name of the practitioner | |
hpiCPN | 1..1 | Identifier | The HPI Common Person Number | |
dormantCPN | 0..* | Identifier | Previously assigned CPN identifiers | |
gender | 0..1 | code | Provider gender Binding: AdministrativeGender (required) | |
birthDate | 0..1 | date | Date of Birth | |
deathDate | 0..1 | date | Date of Death | |
communication | 0..* | CodeableConcept | Language/s spoken by the provider Binding: CommonLanguages (required) | |
ethnicity | 0..6 | CodeableConcept | Ethnicity of the provider Binding: Ethnicity of a person (required) | |
registration | 0..* | BackboneElement | Professional registration | |
status | 1..1 | CodeableConcept | The status of the registration Binding: Registration Status of Practitioners (required) | |
identifier | 0..* | Identifier | Any identifiers | |
code | 1..1 | CodeableConcept | The code representing the qualification itself | |
period | 0..* | Period | The period over which the registration is active (otherwise called the APC) | |
issuer | 0..1 | Reference(Organization) | The organization that issued the registration | |
initialDate | 0..1 | date | The date that this registration was first recorded | |
additionalAuthorization | 0..* | BackboneElement | Additional Authorizations for this provider | |
code | 0..1 | CodeableConcept | The code that represents the authorization Binding: Additional activities that a Practitioner is authorised to perform (required) | |
period | 0..* | Period | The period over which the authorization is active | |
scopeOfPractice | 0..* | BackboneElement | Scope of practice for this provider | |
code | 0..1 | CodeableConcept | The code that represents the Scope of practice Binding: Scope of practice (required) | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the Scope of practice is active | |
conditionOnPractice | 0..* | BackboneElement | Conditions that affect what this provider can do | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the condition is active | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProviderModel | 0..* | Element | Healthcare provider | |
Documentation for this format |
This structure is derived from Element
Differential View
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProviderModel | 0..* | Element | Healthcare provider | |
name | 0..1 | HumanName | Name of the practitioner | |
hpiCPN | 1..1 | Identifier | The HPI Common Person Number | |
dormantCPN | 0..* | Identifier | Previously assigned CPN identifiers | |
gender | 0..1 | code | Provider gender Binding: AdministrativeGender (required) | |
birthDate | 0..1 | date | Date of Birth | |
deathDate | 0..1 | date | Date of Death | |
communication | 0..* | CodeableConcept | Language/s spoken by the provider Binding: CommonLanguages (required) | |
ethnicity | 0..6 | CodeableConcept | Ethnicity of the provider Binding: Ethnicity of a person (required) | |
registration | 0..* | BackboneElement | Professional registration | |
status | 1..1 | CodeableConcept | The status of the registration Binding: Registration Status of Practitioners (required) | |
identifier | 0..* | Identifier | Any identifiers | |
code | 1..1 | CodeableConcept | The code representing the qualification itself | |
period | 0..* | Period | The period over which the registration is active (otherwise called the APC) | |
issuer | 0..1 | Reference(Organization) | The organization that issued the registration | |
initialDate | 0..1 | date | The date that this registration was first recorded | |
additionalAuthorization | 0..* | BackboneElement | Additional Authorizations for this provider | |
code | 0..1 | CodeableConcept | The code that represents the authorization Binding: Additional activities that a Practitioner is authorised to perform (required) | |
period | 0..* | Period | The period over which the authorization is active | |
scopeOfPractice | 0..* | BackboneElement | Scope of practice for this provider | |
code | 0..1 | CodeableConcept | The code that represents the Scope of practice Binding: Scope of practice (required) | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the Scope of practice is active | |
conditionOnPractice | 0..* | BackboneElement | Conditions that affect what this provider can do | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the condition is active | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProviderModel | 0..* | Element | Healthcare provider | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
name | 0..1 | HumanName | Name of the practitioner | |
hpiCPN | 1..1 | Identifier | The HPI Common Person Number | |
dormantCPN | 0..* | Identifier | Previously assigned CPN identifiers | |
gender | 0..1 | code | Provider gender Binding: AdministrativeGender (required) | |
birthDate | 0..1 | date | Date of Birth | |
deathDate | 0..1 | date | Date of Death | |
communication | 0..* | CodeableConcept | Language/s spoken by the provider Binding: CommonLanguages (required) | |
ethnicity | 0..6 | CodeableConcept | Ethnicity of the provider Binding: Ethnicity of a person (required) | |
registration | 0..* | BackboneElement | Professional registration | |
status | 1..1 | CodeableConcept | The status of the registration Binding: Registration Status of Practitioners (required) | |
identifier | 0..* | Identifier | Any identifiers | |
code | 1..1 | CodeableConcept | The code representing the qualification itself | |
period | 0..* | Period | The period over which the registration is active (otherwise called the APC) | |
issuer | 0..1 | Reference(Organization) | The organization that issued the registration | |
initialDate | 0..1 | date | The date that this registration was first recorded | |
additionalAuthorization | 0..* | BackboneElement | Additional Authorizations for this provider | |
code | 0..1 | CodeableConcept | The code that represents the authorization Binding: Additional activities that a Practitioner is authorised to perform (required) | |
period | 0..* | Period | The period over which the authorization is active | |
scopeOfPractice | 0..* | BackboneElement | Scope of practice for this provider | |
code | 0..1 | CodeableConcept | The code that represents the Scope of practice Binding: Scope of practice (required) | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the Scope of practice is active | |
conditionOnPractice | 0..* | BackboneElement | Conditions that affect what this provider can do | |
description | 0..1 | string | textual description | |
period | 0..* | Period | The period over which the condition is active | |
Documentation for this format |
Other representations of profile: CSV, Excel
Path | Conformance | ValueSet |
ProviderModel.gender | required | AdministrativeGender |
ProviderModel.communication | required | CommonLanguages |
ProviderModel.ethnicity | required | Ethnicity |
ProviderModel.registration.status | required | PractitionerRegistrationStatusCode |
ProviderModel.registration.additionalAuthorization.code | required | PractitionerAdditionalAuthorisationCode |
ProviderModel.registration.scopeOfPractice.code | required | PractitionerScopeOfPractice |