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: Healthcare provider

Defining URL:http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel
Version:0.2.0
Name:ProviderModel
Title:Healthcare provider
Status:Active as of 2021-08-31T02:39:29+00:00
Definition:

A person who delivers care

Publisher:David Hay
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 registration is represented in the Practitioner.qualification element
  • Additional Authorizations are an extension in Practitioner.qualification
  • Scope of practice are an extension in Practitioner.qualification
  • Condition on practice are an extension in Practitioner.qualification

The actual profile on Practitioner can he found here

These are defined in the New Zealand Base Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Element

Summary

Mandatory: 0 element (3 nested mandatory elements)

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProviderModel 0..*ElementHealthcare provider
... name 0..1HumanNameName of the practitioner
... hpiCPN 1..1IdentifierThe HPI Common Person Number
... dormantCPN 0..*IdentifierPreviously assigned CPN identifiers
... birthDate 0..1dateDate of Birth
... deathDate 0..1dateDate of Death
... communication 0..*CodeableConceptLanguage/s spoken by the provider
Binding: CommonLanguages (required)
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... registration 0..*BackboneElementProfessional registration
.... status 1..1CodeableConceptThe status of the registration
Binding: Registration Status of Practitioners (required)
.... identifier 0..*IdentifierAny identifiers
.... code 1..1CodeableConceptThe code representing the qualification itself
.... period 0..*PeriodThe period over which the registration is active
.... issuer 0..1Reference(Organization)The organization that issued the registration
.... initialDate 0..1dateThe date that this registration was first recorded
... additionalAuthorization 0..*BackboneElementAdditional Authorizations for this provider
.... code 0..1CodeableConceptThe code that represents the authorization
Binding: Additional activities that a Practitioner is authorised to perform (required)
.... period 0..*PeriodThe period over which the authorization is active
... scopeOfPractice 0..*BackboneElementScope of practice for this provider
.... code 0..1CodeableConceptThe code that represents the Scope of practice
Binding: Scope of practice (required)
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the Scope of practice is active
... conditionOnPractice 0..*BackboneElementConditions that affect what this provider can do
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the condition is active

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ProviderModel 0..*ElementHealthcare provider
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1HumanNameName of the practitioner
... hpiCPN 1..1IdentifierThe HPI Common Person Number
... gender 0..1codeProvider gender
Binding: AdministrativeGender (required)
... birthDate 0..1dateDate of Birth
... deathDate 0..1dateDate of Death
... communication 0..*CodeableConceptLanguage/s spoken by the provider
Binding: CommonLanguages (required)
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... registration 0..*BackboneElementProfessional registration
.... status 1..1CodeableConceptThe status of the registration
Binding: Registration Status of Practitioners (required)
.... identifier 0..*IdentifierAny identifiers
.... code 1..1CodeableConceptThe code representing the qualification itself
.... period 0..*PeriodThe period over which the registration is active
.... issuer 0..1Reference(Organization)The organization that issued the registration
.... initialDate 0..1dateThe date that this registration was first recorded
... additionalAuthorization 0..*BackboneElementAdditional Authorizations for this provider
.... code 0..1CodeableConceptThe code that represents the authorization
Binding: Additional activities that a Practitioner is authorised to perform (required)
.... period 0..*PeriodThe period over which the authorization is active
... scopeOfPractice 0..*BackboneElementScope of practice for this provider
.... code 0..1CodeableConceptThe code that represents the Scope of practice
Binding: Scope of practice (required)
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the Scope of practice is active
... conditionOnPractice 0..*BackboneElementConditions that affect what this provider can do
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the condition is active

doco Documentation for this format

This structure is derived from Element

Summary

Mandatory: 0 element (3 nested mandatory elements)

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProviderModel 0..*ElementHealthcare provider
... name 0..1HumanNameName of the practitioner
... hpiCPN 1..1IdentifierThe HPI Common Person Number
... dormantCPN 0..*IdentifierPreviously assigned CPN identifiers
... birthDate 0..1dateDate of Birth
... deathDate 0..1dateDate of Death
... communication 0..*CodeableConceptLanguage/s spoken by the provider
Binding: CommonLanguages (required)
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... registration 0..*BackboneElementProfessional registration
.... status 1..1CodeableConceptThe status of the registration
Binding: Registration Status of Practitioners (required)
.... identifier 0..*IdentifierAny identifiers
.... code 1..1CodeableConceptThe code representing the qualification itself
.... period 0..*PeriodThe period over which the registration is active
.... issuer 0..1Reference(Organization)The organization that issued the registration
.... initialDate 0..1dateThe date that this registration was first recorded
... additionalAuthorization 0..*BackboneElementAdditional Authorizations for this provider
.... code 0..1CodeableConceptThe code that represents the authorization
Binding: Additional activities that a Practitioner is authorised to perform (required)
.... period 0..*PeriodThe period over which the authorization is active
... scopeOfPractice 0..*BackboneElementScope of practice for this provider
.... code 0..1CodeableConceptThe code that represents the Scope of practice
Binding: Scope of practice (required)
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the Scope of practice is active
... conditionOnPractice 0..*BackboneElementConditions that affect what this provider can do
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the condition is active

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProviderModel 0..*ElementHealthcare provider
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1HumanNameName of the practitioner
... hpiCPN 1..1IdentifierThe HPI Common Person Number
... gender 0..1codeProvider gender
Binding: AdministrativeGender (required)
... birthDate 0..1dateDate of Birth
... deathDate 0..1dateDate of Death
... communication 0..*CodeableConceptLanguage/s spoken by the provider
Binding: CommonLanguages (required)
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... registration 0..*BackboneElementProfessional registration
.... status 1..1CodeableConceptThe status of the registration
Binding: Registration Status of Practitioners (required)
.... identifier 0..*IdentifierAny identifiers
.... code 1..1CodeableConceptThe code representing the qualification itself
.... period 0..*PeriodThe period over which the registration is active
.... issuer 0..1Reference(Organization)The organization that issued the registration
.... initialDate 0..1dateThe date that this registration was first recorded
... additionalAuthorization 0..*BackboneElementAdditional Authorizations for this provider
.... code 0..1CodeableConceptThe code that represents the authorization
Binding: Additional activities that a Practitioner is authorised to perform (required)
.... period 0..*PeriodThe period over which the authorization is active
... scopeOfPractice 0..*BackboneElementScope of practice for this provider
.... code 0..1CodeableConceptThe code that represents the Scope of practice
Binding: Scope of practice (required)
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the Scope of practice is active
... conditionOnPractice 0..*BackboneElementConditions that affect what this provider can do
.... description 0..1stringtextual description
.... period 0..*PeriodThe period over which the condition is active

doco Documentation for this format

 

Other representations of profile: CSV, Excel

Terminology Bindings

PathConformanceValueSet
ProviderModel.genderrequiredAdministrativeGender
ProviderModel.communicationrequiredCommonLanguages
ProviderModel.ethnicityrequiredEthnicity
ProviderModel.registration.statusrequiredPractitionerRegistrationStatusCode
ProviderModel.additionalAuthorization.coderequiredPractitionerAdditionalAuthorisationCode
ProviderModel.scopeOfPractice.coderequiredPractitionerScopeOfPractice