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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: HpiPractitioner - Mappings

Active as of 2024-12-17

Mappings for the HPIPractitioner resource profile.

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

HpiPractitioner
Practitioner	PRD (as one example)
identifier	PRD-7 (or XCN.1)
use	N/A
type	CX.5
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
identifier (HPI)	PRD-7 (or XCN.1)
use	N/A
system	CX.4 / EI-2-4
value	CX.1 / EI.1
assigner	CX.4 / (CX.4,CX.9,CX.10)
identifier (dormant)	PRD-7 (or XCN.1)
use	N/A
system	CX.4 / EI-2-4
value	CX.1 / EI.1
assigner	CX.4 / (CX.4,CX.9,CX.10)
identifier (RA)	PRD-7 (or XCN.1)
use	N/A
system	CX.4 / EI-2-4
value	CX.1 / EI.1
assigner	CX.4 / (CX.4,CX.9,CX.10)
name	XCN Components
use	XPN.7, but often indicated by which field contains the name
family	XPN.1/FN.1
given	XPN.2 + XPN.3
prefix	XPN.5
gender	STF-5
birthDate	STF-6
qualification	CER?
communication	PID-15, NK1-20, LAN-2
coding	C*E.1-8, C*E.10-22
text	C*E.9. But note many systems use C*E.2 for this

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

HpiPractitioner
Practitioner	Entity. Role, or Act, Role
text	Act.text?
contained	N/A
extension
extension (death-date)
id	n/a
extension	n/a
extension (date)
id	n/a
url	N/A
value[x]	N/A
url	N/A
extension (educational-qualification)
id	n/a
extension	n/a
extension (fullname)
id	n/a
url	N/A
value[x]	N/A
extension (shortname)
id	n/a
url	N/A
value[x]	N/A
extension (year)
id	n/a
url	N/A
value[x]	N/A
extension (institution)
id	n/a
url	N/A
value[x]	N/A
extension (city)
id	n/a
url	N/A
value[x]	N/A
extension (country)
id	n/a
url	N/A
value[x]	N/A
url	N/A
modifierExtension	N/A
identifier	./id
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	Role.effectiveTime or implied by context
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (HPI)	./id
id	n/a
extension	n/a
use	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (dormant)	./id
id	n/a
extension	n/a
use	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (RA)	./id
id	n/a
extension	n/a
use	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
name	./name
id	n/a
extension	n/a
use	unique(./use)
family	./part[partType = FAM]
given	./part[partType = GIV]
prefix	./part[partType = PFX]
gender	./administrativeGender
birthDate	./birthTime
qualification	.playingEntity.playingRole[classCode=QUAL].code
extension
extension (additional-authorisation)
extension (condition-on-practice)
extension (registration-initial-date)
extension (registration-status-code)
extension (scope-of-practice)
id	n/a
extension	n/a
extension (code)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
extension (period)
id	n/a
url	N/A
value[x]	N/A
url	N/A
modifierExtension	N/A
identifier	.playingEntity.playingRole[classCode=QUAL].id
code	.playingEntity.playingRole[classCode=QUAL].code
period	.playingEntity.playingRole[classCode=QUAL].effectiveTime
issuer	.playingEntity.playingRole[classCode=QUAL].scoper
communication	./languageCommunication
id	n/a
extension	n/a
coding	union(., ./translation)
text	./originalText[mediaType/code="text/plain"]/data

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

HpiPractitioner
Practitioner	Provider
identifier	./Identifiers
system	./IdentifierType
value	./Value
period	./StartDate and ./EndDate
assigner	./IdentifierIssuingAuthority
identifier (HPI)	./Identifiers
system	./IdentifierType
value	./Value
assigner	./IdentifierIssuingAuthority
identifier (dormant)	./Identifiers
system	./IdentifierType
value	./Value
assigner	./IdentifierIssuingAuthority
identifier (RA)	./Identifiers
system	./IdentifierType
value	./Value
assigner	./IdentifierIssuingAuthority
name	./PreferredName (GivenNames, FamilyName, TitleCode)
use	./NamePurpose
family	./FamilyName
given	./GivenNames
prefix	./TitleCode
gender	./GenderCode
birthDate	(not represented in ServD)
qualification	./Qualifications
code	./Qualifications.Value
period	./Qualifications.StartDate and ./Qualifications.EndDate
communication	./Languages.LanguageSpokenCode

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

HpiPractitioner
Practitioner
identifier	FiveWs.identifier
identifier (HPI)	FiveWs.identifier
identifier (dormant)	FiveWs.identifier
identifier (RA)	FiveWs.identifier