Name Flags Card. Type Description & Constraints doco
. . ProviderRoleModel 0 .. * Element Provider role
. . . provider 1..1 http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel The provider
. . . organization 0..1 http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel The organization that the provide is working for
. . . facility 0..1 http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel The facility where the provider provides care
. . . code 0..1 CodeableConcept The role that this provider may perform for the Organization
Binding: PractitonerRole code (required)
. . . status 0..1 BackboneElement The current status of this role
. . . . active 0..1 boolean True if the role is currently active
. . . . statusReason 0..1 CodeableConcept The reason for the role being in this status
Binding: PractitionerRole status reason (required)
. . . contactDetails 0..* ContactPoint How to contact the provider
. . . period 0..1 Period The period over which the provider is working for the organization
. . . identifier 0..* Identifier Identifiers assigned to this role
. . . creator 0..1 BackboneElement The person who created or updated this resource
. . . . person 1..1 http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel The person making the change
. . . . organization 0..1 http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel The organization they are working on behalf on

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="The role of a provider in a care delivery setting" /> <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/ProviderRoleModel" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element" /> <derivation value="specialization" /> <snapshot> <element id="ProviderRoleModel"> <path value="ProviderRoleModel" /> <short value="Provider role" /> <definition value="The role of a provider in a care delivery setting" /> <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="ProviderRoleModel.id"> <path value="ProviderRoleModel.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="ProviderRoleModel.extension"> <path value="ProviderRoleModel.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="ProviderRoleModel.provider"> <path value="ProviderRoleModel.provider" /> <short value="The provider" /> <definition value="The provider" /> <min value="1" /> <max value="1" /> <base> <path value="ProviderRoleModel.provider" /> <min value="1" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel" /> </type> </element> <element id="ProviderRoleModel.organization"> <path value="ProviderRoleModel.organization" /> <short value="The organization that the provide is working for" /> <definition value="The organization that the provide is working for" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.organization" /> <min value="0" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel" /> </type> </element> <element id="ProviderRoleModel.facility"> <path value="ProviderRoleModel.facility" /> <short value="The facility where the provider provides care" /> <definition value="The facility where the provider provides care" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.facility" /> <min value="0" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel" /> </type> </element> <element id="ProviderRoleModel.code"> <path value="ProviderRoleModel.code" /> <short value="The role that this provider may perform for the Organization" /> <definition value="The role that this provider may perform for the Organization" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.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-role-code" /> </binding> </element> <element id="ProviderRoleModel.status"> <path value="ProviderRoleModel.status" /> <short value="The current status of this role" /> <definition value="The current status of this role" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.status" /> <min value="0" /> <max value="1" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderRoleModel.status.active"> <path value="ProviderRoleModel.status.active" /> <short value="True if the role is currently active" /> <definition value="True if the role is currently active" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.status.active" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> </element> <element id="ProviderRoleModel.status.statusReason"> <path value="ProviderRoleModel.status.statusReason" /> <short value="The reason for the role being in this status" /> <definition value="The reason for the role being in this status" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.status.statusReason" /> <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/hpi-practitioner-role-status-reason-code" /> </binding> </element> <element id="ProviderRoleModel.contactDetails"> <path value="ProviderRoleModel.contactDetails" /> <short value="How to contact the provider" /> <definition value="How to contact the provider" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderRoleModel.contactDetails" /> <min value="0" /> <max value="*" /> </base> <type> <code value="ContactPoint" /> </type> </element> <element id="ProviderRoleModel.period"> <path value="ProviderRoleModel.period" /> <short value="The period over which the provider is working for the organization" /> <definition value="The period over which the provider is working for the organization" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.period" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> </element> <element id="ProviderRoleModel.identifier"> <path value="ProviderRoleModel.identifier" /> <short value="Identifiers assigned to this role" /> <definition value="Identifiers assigned to this role" /> <min value="0" /> <max value="*" /> <base> <path value="ProviderRoleModel.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="ProviderRoleModel.creator"> <path value="ProviderRoleModel.creator" /> <short value="The person who created or updated this resource" /> <definition value="The person who created or updated this resource" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.creator" /> <min value="0" /> <max value="1" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderRoleModel.creator.person"> <path value="ProviderRoleModel.creator.person" /> <short value="The person making the change" /> <definition value="The person making the change" /> <min value="1" /> <max value="1" /> <base> <path value="ProviderRoleModel.creator.person" /> <min value="1" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel" /> </type> </element> <element id="ProviderRoleModel.creator.organization"> <path value="ProviderRoleModel.creator.organization" /> <short value="The organization they are working on behalf on" /> <definition value="The organization they are working on behalf on" /> <min value="0" /> <max value="1" /> <base> <path value="ProviderRoleModel.creator.organization" /> <min value="0" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel" /> </type> </element> </snapshot> <differential> <element id="ProviderRoleModel"> <path value="ProviderRoleModel" /> <short value="Provider role" /> <definition value="The role of a provider in a care delivery setting" /> </element> <element id="ProviderRoleModel.provider"> <path value="ProviderRoleModel.provider" /> <short value="The provider" /> <definition value="The provider" /> <min value="1" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel" /> </type> </element> <element id="ProviderRoleModel.organization"> <path value="ProviderRoleModel.organization" /> <short value="The organization that the provide is working for" /> <definition value="The organization that the provide is working for" /> <min value="0" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel" /> </type> </element> <element id="ProviderRoleModel.facility"> <path value="ProviderRoleModel.facility" /> <short value="The facility where the provider provides care" /> <definition value="The facility where the provider provides care" /> <min value="0" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel" /> </type> </element> <element id="ProviderRoleModel.code"> <path value="ProviderRoleModel.code" /> <short value="The role that this provider may perform for the Organization" /> <definition value="The role that this provider may perform for the Organization" /> <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-role-code" /> </binding> </element> <element id="ProviderRoleModel.status"> <path value="ProviderRoleModel.status" /> <short value="The current status of this role" /> <definition value="The current status of this role" /> <min value="0" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderRoleModel.status.active"> <path value="ProviderRoleModel.status.active" /> <short value="True if the role is currently active" /> <definition value="True if the role is currently active" /> <min value="0" /> <max value="1" /> <type> <code value="boolean" /> </type> </element> <element id="ProviderRoleModel.status.statusReason"> <path value="ProviderRoleModel.status.statusReason" /> <short value="The reason for the role being in this status" /> <definition value="The reason for the role being in this status" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code" /> </binding> </element> <element id="ProviderRoleModel.contactDetails"> <path value="ProviderRoleModel.contactDetails" /> <short value="How to contact the provider" /> <definition value="How to contact the provider" /> <min value="0" /> <max value="*" /> <type> <code value="ContactPoint" /> </type> </element> <element id="ProviderRoleModel.period"> <path value="ProviderRoleModel.period" /> <short value="The period over which the provider is working for the organization" /> <definition value="The period over which the provider is working for the organization" /> <min value="0" /> <max value="1" /> <type> <code value="Period" /> </type> </element> <element id="ProviderRoleModel.identifier"> <path value="ProviderRoleModel.identifier" /> <short value="Identifiers assigned to this role" /> <definition value="Identifiers assigned to this role" /> <min value="0" /> <max value="*" /> <type> <code value="Identifier" /> </type> </element> <element id="ProviderRoleModel.creator"> <path value="ProviderRoleModel.creator" /> <short value="The person who created or updated this resource" /> <definition value="The person who created or updated this resource" /> <min value="0" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> </element> <element id="ProviderRoleModel.creator.person"> <path value="ProviderRoleModel.creator.person" /> <short value="The person making the change" /> <definition value="The person making the change" /> <min value="1" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel" /> </type> </element> <element id="ProviderRoleModel.creator.organization"> <path value="ProviderRoleModel.creator.organization" /> <short value="The organization they are working on behalf on" /> <definition value="The organization they are working on behalf on" /> <min value="0" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel" /> </type> </element> </differential> </StructureDefinition>