New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Resource Profile: HpiOrganization - Mappings

Active as of 2024-12-17

Mappings for the HpiOrganization resource profile.

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

HpiOrganization
Organization(also see master files messages)
   identifierXON.10 / XON.3
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (orgId)XON.10 / XON.3
      useN/A
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (legacyOrgId)XON.10 / XON.3
      useN/A
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (nzbn)XON.10 / XON.3
      useN/A
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (dormant)XON.10 / XON.3
      useN/A
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      assignerCX.4 / (CX.4,CX.9,CX.10)
   activeNo equivalent in HL7 v2
   typeNo equivalent in v2
   nameXON.1
   telecomORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   partOfNo equivalent in HL7 v2

Mappings for RIM Mapping (http://hl7.org/v3)

HpiOrganization
OrganizationEntity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
   textAct.text?
   containedN/A
   modifierExtensionN/A
   identifier.scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (orgId).scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (legacyOrgId).scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (nzbn).scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (dormant).scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   active.status
   type.code
   name.name
   alias.name
      extension
      extension (alias-type)
         idn/a
         urlN/A
         value[x]N/A
         value[x] (valueCodeableConcept)N/A
   telecom.telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   partOf.playedBy[classCode=Part].scoper

Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)

HpiOrganization
OrganizationOrganization
   identifier./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (orgId)./Identifiers
      system./IdentifierType
      value./Value
      assigner./IdentifierIssuingAuthority
   identifier (legacyOrgId)./Identifiers
      system./IdentifierType
      value./Value
      assigner./IdentifierIssuingAuthority
   identifier (nzbn)./Identifiers
      system./IdentifierType
      value./Value
      assigner./IdentifierIssuingAuthority
   identifier (dormant)./Identifiers
      system./IdentifierType
      value./Value
      assigner./IdentifierIssuingAuthority
   active./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
   typen/a
   name.PreferredName/Name
   telecom./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   partOfn/a

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

HpiOrganization
Organization
   identifierFiveWs.identifier
   identifier (orgId)FiveWs.identifier
   identifier (legacyOrgId)FiveWs.identifier
   identifier (nzbn)FiveWs.identifier
   identifier (dormant)FiveWs.identifier
   activeFiveWs.status
   typeFiveWs.class