Name Flags Card. Type Description & Constraints doco
. . 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 New Zealand Standard Classification 2005 (level 4) (required)
. . . registration 0..* BackboneElement Professional registration
. . . . status 1..1 CodeableConcept The status of the registration
Binding: HPI Registration Status (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

doco Documentation for this format
<status value="active" /> <date value="2022-04-12T04:02:48+00:00" /> <publisher value="Ministry of Health" /> <contact> <name value="Ministry of Health" /> <telecom> <system value="email" /> <value value="mailto:integration@health.govt.nz" /> </telecom> </contact> <description value="A person who delivers care" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="logical" /> <abstract value="false" /> <type value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element" /> <derivation value="specialization" /> <snapshot> <element id="ProviderModel"> <path value="ProviderModel" /> <short value="Healthcare provider" /> <definition value="A person who delivers care" /> <min value="0" /> <max value="*" /> <base> <path value="Element" /> <min value="0" /> <max value="*" /> </base> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="ProviderModel.id"> <path value="ProviderModel.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="ProviderModel.extension"> <path value="ProviderModel.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="ProviderModel.name"> <path value="ProviderModel.name" /> <short value="Name of the practitioner" /> <definition value="Name of the practitioner" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.name" /> <min value="0" /> <max value="1" /> </base> <type> <code value="HumanName" /> </type> </element> <element id="ProviderModel.hpiCPN"> <path value="ProviderModel.hpiCPN" /> <short value="The HPI Common Person Number" /> <definition value="The HPI Common Person Number" /> <min value="1" /> <max value="1" /> <base> <path value="ProviderModel.hpiCPN" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="ProviderModel.dormantCPN"> <path value="ProviderModel.dormantCPN" /> <short value="Previously assigned CPN identifiers" /> <definition value="Previously assigned CPN identifiers" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.dormantCPN" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="ProviderModel.gender"> <path value="ProviderModel.gender" /> <short value="Provider gender" /> <definition value="Provider gender" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.gender" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" /> </binding> </element> <element id="ProviderModel.birthDate"> <path value="ProviderModel.birthDate" /> <short value="Date of Birth" /> <definition value="Date of Birth" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.birthDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="date" /> </type> </element> <element id="ProviderModel.deathDate"> <path value="ProviderModel.deathDate" /> <short value="Date of Death" /> <definition value="Date of Death" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.deathDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="date" /> </type> </element> <element id="ProviderModel.communication"> <path value="ProviderModel.communication" /> <short value="Language/s spoken by the provider" /> <definition value="Language/s spoken by the provider" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.communication" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="ProviderModel.ethnicity"> <path value="ProviderModel.ethnicity" /> <short value="Ethnicity of the provider" /> <definition value="Ethnicity of the provider" /> <min value="0" /> <max value="6" /> <base> <path value="ProviderModel.ethnicity" /> <min value="0" /> <max value="6" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code" /> </binding> </element> <element id="ProviderModel.registration"> <path value="ProviderModel.registration" /> <short value="Professional registration" /> <definition value="Professional registration" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.status"> <path value="ProviderModel.registration.status" /> <short value="The status of the registration" /> <definition value="The status of the registration" /> <min value="1" /> <max value="1" /> <base> <path value="ProviderModel.registration.status" /> <min value="1" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code" /> </binding> </element> <element id="ProviderModel.registration.identifier"> <path value="ProviderModel.registration.identifier" /> <short value="Any identifiers" /> <definition value="Any identifiers" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="ProviderModel.registration.code"> <path value="ProviderModel.registration.code" /> <short value="The code representing the qualification itself" /> <definition value="The code representing the qualification itself" /> <min value="1" /> <max value="1" /> <base> <path value="ProviderModel.registration.code" /> <min value="1" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> </element> <element id="ProviderModel.registration.period"> <path value="ProviderModel.registration.period" /> <short value="The period over which the registration is active (otherwise called the APC)" /> <definition value="The period over which the registration is active (otherwise called the APC)" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.period" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Period" /> </type> </element> <element id="ProviderModel.registration.issuer"> <path value="ProviderModel.registration.issuer" /> <short value="The organization that issued the registration" /> <definition value="The organization that issued the registration" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.registration.issuer" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> </type> </element> <element id="ProviderModel.registration.initialDate"> <path value="ProviderModel.registration.initialDate" /> <short value="The date that this registration was first recorded" /> <definition value="The date that this registration was first recorded" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.registration.initialDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="date" /> </type> </element> <element id="ProviderModel.registration.additionalAuthorization"> <path value="ProviderModel.registration.additionalAuthorization" /> <short value="Additional Authorizations for this provider" /> <definition value="Additional Authorizations for this provider" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.additionalAuthorization" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.additionalAuthorization.code"> <path value="ProviderModel.registration.additionalAuthorization.code" /> <short value="The code that represents the authorization" /> <definition value="The code that represents the authorization" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.registration.additionalAuthorization.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code" /> </binding> </element> <element id="ProviderModel.registration.additionalAuthorization.period"> <path value="ProviderModel.registration.additionalAuthorization.period" /> <short value="The period over which the authorization is active" /> <definition value="The period over which the authorization is active" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.additionalAuthorization.period" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Period" /> </type> </element> <element id="ProviderModel.registration.scopeOfPractice"> <path value="ProviderModel.registration.scopeOfPractice" /> <short value="Scope of practice for this provider" /> <definition value="Scope of practice for this provider" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.scopeOfPractice" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.scopeOfPractice.code"> <path value="ProviderModel.registration.scopeOfPractice.code" /> <short value="The code that represents the Scope of practice" /> <definition value="The code that represents the Scope of practice" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.registration.scopeOfPractice.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code" /> </binding> </element> <element id="ProviderModel.registration.scopeOfPractice.description"> <path value="ProviderModel.registration.scopeOfPractice.description" /> <short value="textual description" /> <definition value="textual description" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.registration.scopeOfPractice.description" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> </element> <element id="ProviderModel.registration.scopeOfPractice.period"> <path value="ProviderModel.registration.scopeOfPractice.period" /> <short value="The period over which the Scope of practice is active" /> <definition value="The period over which the Scope of practice is active" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.scopeOfPractice.period" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Period" /> </type> </element> <element id="ProviderModel.registration.conditionOnPractice"> <path value="ProviderModel.registration.conditionOnPractice" /> <short value="Conditions that affect what this provider can do" /> <definition value="Conditions that affect what this provider can do" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.conditionOnPractice" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.conditionOnPractice.description"> <path value="ProviderModel.registration.conditionOnPractice.description" /> <short value="textual description" /> <definition value="textual description" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderModel.registration.conditionOnPractice.description" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> </element> <element id="ProviderModel.registration.conditionOnPractice.period"> <path value="ProviderModel.registration.conditionOnPractice.period" /> <short value="The period over which the condition is active" /> <definition value="The period over which the condition is active" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderModel.registration.conditionOnPractice.period" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Period" /> </type> </element> </snapshot> <differential> <element id="ProviderModel"> <path value="ProviderModel" /> <short value="Healthcare provider" /> <definition value="A person who delivers care" /> </element> <element id="ProviderModel.name"> <path value="ProviderModel.name" /> <short value="Name of the practitioner" /> <definition value="Name of the practitioner" /> <min value="0" /> <max value="1" /> <type> <code value="HumanName" /> </type> </element> <element id="ProviderModel.hpiCPN"> <path value="ProviderModel.hpiCPN" /> <short value="The HPI Common Person Number" /> <definition value="The HPI Common Person Number" /> <min value="1" /> <max value="1" /> <type> <code value="Identifier" /> </type> </element> <element id="ProviderModel.dormantCPN"> <path value="ProviderModel.dormantCPN" /> <short value="Previously assigned CPN identifiers" /> <definition value="Previously assigned CPN identifiers" /> <min value="0" /> <max value="*" /> <type> <code value="Identifier" /> </type> </element> <element id="ProviderModel.gender"> <path value="ProviderModel.gender" /> <short value="Provider gender" /> <definition value="Provider gender" /> <min value="0" /> <max value="1" /> <type> <code value="code" /> </type> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" /> </binding> </element> <element id="ProviderModel.birthDate"> <path value="ProviderModel.birthDate" /> <short value="Date of Birth" /> <definition value="Date of Birth" /> <min value="0" /> <max value="1" /> <type> <code value="date" /> </type> </element> <element id="ProviderModel.deathDate"> <path value="ProviderModel.deathDate" /> <short value="Date of Death" /> <definition value="Date of Death" /> <min value="0" /> <max value="1" /> <type> <code value="date" /> </type> </element> <element id="ProviderModel.communication"> <path value="ProviderModel.communication" /> <short value="Language/s spoken by the provider" /> <definition value="Language/s spoken by the provider" /> <min value="0" /> <max value="*" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="ProviderModel.ethnicity"> <path value="ProviderModel.ethnicity" /> <short value="Ethnicity of the provider" /> <definition value="Ethnicity of the provider" /> <min value="0" /> <max value="6" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code" /> </binding> </element> <element id="ProviderModel.registration"> <path value="ProviderModel.registration" /> <short value="Professional registration" /> <definition value="Professional registration" /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.status"> <path value="ProviderModel.registration.status" /> <short value="The status of the registration" /> <definition value="The status of the registration" /> <min value="1" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code" /> </binding> </element> <element id="ProviderModel.registration.identifier"> <path value="ProviderModel.registration.identifier" /> <short value="Any identifiers" /> <definition value="Any identifiers" /> <min value="0" /> <max value="*" /> <type> <code value="Identifier" /> </type> </element> <element id="ProviderModel.registration.code"> <path value="ProviderModel.registration.code" /> <short value="The code representing the qualification itself" /> <definition value="The code representing the qualification itself" /> <min value="1" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="ProviderModel.registration.period"> <path value="ProviderModel.registration.period" /> <short value="The period over which the registration is active (otherwise called the APC)" /> <definition value="The period over which the registration is active (otherwise called the APC)" /> <min value="0" /> <max value="*" /> <type> <code value="Period" /> </type> </element> <element id="ProviderModel.registration.issuer"> <path value="ProviderModel.registration.issuer" /> <short value="The organization that issued the registration" /> <definition value="The organization that issued the registration" /> <min value="0" /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> </type> </element> <element id="ProviderModel.registration.initialDate"> <path value="ProviderModel.registration.initialDate" /> <short value="The date that this registration was first recorded" /> <definition value="The date that this registration was first recorded" /> <min value="0" /> <max value="1" /> <type> <code value="date" /> </type> </element> <element id="ProviderModel.registration.additionalAuthorization"> <path value="ProviderModel.registration.additionalAuthorization" /> <short value="Additional Authorizations for this provider" /> <definition value="Additional Authorizations for this provider" /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.additionalAuthorization.code"> <path value="ProviderModel.registration.additionalAuthorization.code" /> <short value="The code that represents the authorization" /> <definition value="The code that represents the authorization" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code" /> </binding> </element> <element id="ProviderModel.registration.additionalAuthorization.period"> <path value="ProviderModel.registration.additionalAuthorization.period" /> <short value="The period over which the authorization is active" /> <definition value="The period over which the authorization is active" /> <min value="0" /> <max value="*" /> <type> <code value="Period" /> </type> </element> <element id="ProviderModel.registration.scopeOfPractice"> <path value="ProviderModel.registration.scopeOfPractice" /> <short value="Scope of practice for this provider" /> <definition value="Scope of practice for this provider" /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.scopeOfPractice.code"> <path value="ProviderModel.registration.scopeOfPractice.code" /> <short value="The code that represents the Scope of practice" /> <definition value="The code that represents the Scope of practice" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code" /> </binding> </element> <element id="ProviderModel.registration.scopeOfPractice.description"> <path value="ProviderModel.registration.scopeOfPractice.description" /> <short value="textual description" /> <definition value="textual description" /> <min value="0" /> <max value="1" /> <type> <code value="string" /> </type> </element> <element id="ProviderModel.registration.scopeOfPractice.period"> <path value="ProviderModel.registration.scopeOfPractice.period" /> <short value="The period over which the Scope of practice is active" /> <definition value="The period over which the Scope of practice is active" /> <min value="0" /> <max value="*" /> <type> <code value="Period" /> </type> </element> <element id="ProviderModel.registration.conditionOnPractice"> <path value="ProviderModel.registration.conditionOnPractice" /> <short value="Conditions that affect what this provider can do" /> <definition value="Conditions that affect what this provider can do" /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderModel.registration.conditionOnPractice.description"> <path value="ProviderModel.registration.conditionOnPractice.description" /> <short value="textual description" /> <definition value="textual description" /> <min value="0" /> <max value="1" /> <type> <code value="string" /> </type> </element> <element id="ProviderModel.registration.conditionOnPractice.period"> <path value="ProviderModel.registration.conditionOnPractice.period" /> <short value="The period over which the condition is active" /> <definition value="The period over which the condition is active" /> <min value="0" /> <max value="*" /> <type> <code value="Period" /> </type> </element> </differential> </StructureDefinition>