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
Definitions for the ProviderModel logical model.
| 1. ProviderModel | |
| Definition | A person who delivers care |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. ProviderModel.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 3. ProviderModel.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ProviderModel.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. ProviderModel.name | |
| Definition | Name of the practitioner |
| Control | 0..1 |
| Type | HumanName |
| 5. ProviderModel.hpiCPN | |
| Definition | The HPI Common Person Number |
| Control | 1..1 |
| Type | Identifier |
| 6. ProviderModel.dormantCPN | |
| Definition | Previously assigned CPN identifiers |
| Control | 0..* |
| Type | Identifier |
| 7. ProviderModel.gender | |
| Definition | Provider gender |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrativeGender |
| Type | code |
| 8. ProviderModel.birthDate | |
| Definition | Date of Birth |
| Control | 0..1 |
| Type | date |
| 9. ProviderModel.deathDate | |
| Definition | Date of Death |
| Control | 0..1 |
| Type | date |
| 10. ProviderModel.communication | |
| Definition | Language/s spoken by the provider |
| Control | 0..* |
| Binding | The codes SHALL be taken from CommonLanguages |
| Type | CodeableConcept |
| 11. ProviderModel.ethnicity | |
| Definition | Ethnicity of the provider |
| Control | 0..6 |
| Binding | The codes SHALL be taken from Ethnicity of a person |
| Type | CodeableConcept |
| 12. ProviderModel.registration | |
| Definition | Professional registration |
| Control | 0..* |
| Type | BackboneElement |
| 13. ProviderModel.registration.status | |
| Definition | The status of the registration |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Registration Status of Practitioners |
| Type | CodeableConcept |
| 14. ProviderModel.registration.identifier | |
| Definition | Any identifiers |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 15. ProviderModel.registration.code | |
| Definition | The code representing the qualification itself |
| Control | 1..1 |
| Type | CodeableConcept |
| 16. ProviderModel.registration.period | |
| Definition | The period over which the registration is active (otherwise called the APC) |
| Control | 0..* |
| Type | Period |
| 17. ProviderModel.registration.issuer | |
| Definition | The organization that issued the registration |
| Control | 0..1 |
| Type | Reference(Organization) |
| 18. ProviderModel.registration.initialDate | |
| Definition | The date that this registration was first recorded |
| Control | 0..1 |
| Type | date |
| 19. ProviderModel.registration.additionalAuthorization | |
| Definition | Additional Authorizations for this provider |
| Control | 0..* |
| Type | BackboneElement |
| 20. ProviderModel.registration.additionalAuthorization.code | |
| Definition | The code that represents the authorization |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Additional activities that a Practitioner is authorised to perform |
| Type | CodeableConcept |
| 21. ProviderModel.registration.additionalAuthorization.period | |
| Definition | The period over which the authorization is active |
| Control | 0..* |
| Type | Period |
| 22. ProviderModel.registration.scopeOfPractice | |
| Definition | Scope of practice for this provider |
| Control | 0..* |
| Type | BackboneElement |
| 23. ProviderModel.registration.scopeOfPractice.code | |
| Definition | The code that represents the Scope of practice |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Scope of practice |
| Type | CodeableConcept |
| 24. ProviderModel.registration.scopeOfPractice.description | |
| Definition | textual description |
| Control | 0..1 |
| Type | string |
| 25. ProviderModel.registration.scopeOfPractice.period | |
| Definition | The period over which the Scope of practice is active |
| Control | 0..* |
| Type | Period |
| 26. ProviderModel.registration.conditionOnPractice | |
| Definition | Conditions that affect what this provider can do |
| Control | 0..* |
| Type | BackboneElement |
| 27. ProviderModel.registration.conditionOnPractice.description | |
| Definition | textual description |
| Control | 0..1 |
| Type | string |
| 28. ProviderModel.registration.conditionOnPractice.period | |
| Definition | The period over which the condition is active |
| Control | 0..* |
| Type | Period |