New Zealand HPI Implementation Guide
0.2.0 - CI Build

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

Logical Model: ProviderModel - Detailed Descriptions

Definitions for the ProviderModel logical model.

1. ProviderModel
Definition

A person who delivers care

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

InvariantsDefined 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())
SlicingThis element introduces a set of slices on ProviderModel.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. ProviderModel.name
Definition

Name of the practitioner

Control0..1
TypeHumanName
5. ProviderModel.hpiCPN
Definition

The HPI Common Person Number

Control1..1
TypeIdentifier
6. ProviderModel.dormantCPN
Definition

Previously assigned CPN identifiers

Control0..*
TypeIdentifier
7. ProviderModel.gender
Definition

Provider gender

Control0..1
BindingThe codes SHALL be taken from AdministrativeGender
Typecode
8. ProviderModel.birthDate
Definition

Date of Birth

Control0..1
Typedate
9. ProviderModel.deathDate
Definition

Date of Death

Control0..1
Typedate
10. ProviderModel.communication
Definition

Language/s spoken by the provider

Control0..*
BindingThe codes SHALL be taken from CommonLanguages
TypeCodeableConcept
11. ProviderModel.ethnicity
Definition

Ethnicity of the provider

Control0..6
BindingThe codes SHALL be taken from Ethnicity of a person
TypeCodeableConcept
12. ProviderModel.registration
Definition

Professional registration

Control0..*
TypeBackboneElement
13. ProviderModel.registration.status
Definition

The status of the registration

Control1..1
BindingThe codes SHALL be taken from Registration Status of Practitioners
TypeCodeableConcept
14. ProviderModel.registration.identifier
Definition

Any identifiers

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
15. ProviderModel.registration.code
Definition

The code representing the qualification itself

Control1..1
TypeCodeableConcept
16. ProviderModel.registration.period
Definition

The period over which the registration is active

Control0..*
TypePeriod
17. ProviderModel.registration.issuer
Definition

The organization that issued the registration

Control0..1
TypeReference(Organization)
18. ProviderModel.registration.initialDate
Definition

The date that this registration was first recorded

Control0..1
Typedate
19. ProviderModel.additionalAuthorization
Definition

Additional Authorizations for this provider

Control0..*
TypeBackboneElement
20. ProviderModel.additionalAuthorization.code
Definition

The code that represents the authorization

Control0..1
BindingThe codes SHALL be taken from Additional activities that a Practitioner is authorised to perform
TypeCodeableConcept
21. ProviderModel.additionalAuthorization.period
Definition

The period over which the authorization is active

Control0..*
TypePeriod
22. ProviderModel.scopeOfPractice
Definition

Scope of practice for this provider

Control0..*
TypeBackboneElement
23. ProviderModel.scopeOfPractice.code
Definition

The code that represents the Scope of practice

Control0..1
BindingThe codes SHALL be taken from Scope of practice
TypeCodeableConcept
24. ProviderModel.scopeOfPractice.description
Definition

textual description

Control0..1
Typestring
25. ProviderModel.scopeOfPractice.period
Definition

The period over which the Scope of practice is active

Control0..*
TypePeriod
26. ProviderModel.conditionOnPractice
Definition

Conditions that affect what this provider can do

Control0..*
TypeBackboneElement
27. ProviderModel.conditionOnPractice.description
Definition

textual description

Control0..1
Typestring
28. ProviderModel.conditionOnPractice.period
Definition

The period over which the condition is active

Control0..*
TypePeriod