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

Table of Contents

..0 Table of Contents
...1 Home
...2 Api
...3 Capability Statement
...4 Capstmt
...5 Companion
...6 Extensions
...7 Faq
...8 General
...9 Models
...10 Naming Systems
...11 Profiles
...12 Profiles DEP
...13 Terminology
...14 Usecases
...15 Artifacts Summary
....15.1 CapabilityStatement
....15.2 Search on birthdate
....15.3 Search on Registration Authority identifier
....15.4 HpiEndpointLM
....15.5 HpiLocationLM
....15.6 HpiOrganizationLM
....15.7 HpiPractitionerLM
....15.8 HpiPractitionerRoleLM
....15.9 HPI Location
....15.10 HPI Organization
....15.11 HPI Practitioner
....15.12 HPI Practitioner role
....15.13 AdditionalAuthorization
....15.14 AliasType
....15.15 ConditionOnPractice
....15.16 DeathDate
....15.17 Dhb
....15.18 EducationalQualification
....15.19 LocationEstablished
....15.20 OrganizationEstablished
....15.21 PractitionerRoleCreator
....15.22 PractitionerRoleStatus
....15.23 RegistrationInitialDate
....15.24 RegistrationStatusCode
....15.25 ScopeOfPractice
....15.26 AddressType
....15.27 AddressUse
....15.28 AdministrativeGender
....15.29 ContactPointSystem
....15.30 ContactPointUse
....15.31 District Health Board HPI Organisation Identifer
....15.32 District Health Board Code
....15.33 Domicile Code
....15.34 Gender
....15.35 Use values for a ContactPoint
....15.36 HPI Additional Authorisation
....15.37 Contact Type
....15.38 Contact Usage
....15.39 ISO 3166-1:2013 (2-alpha country code)
....15.40 HPI Disestablishment Reason
....15.41 Ethnicity New Zealand Standard Classification 2005 (level 4)
....15.42 HPI 3 digit ethnicity codes
....15.43 Address Purpose (Qualifier) for Facility
....15.44 Address Type for Facility
....15.45 Name qualifier for Facility
....15.46 Facility Type
....15.47 ISO 639-3:2007 (3-alpha language code)
....15.48 Old HPI two alpha language codes
....15.49 HPI Legacy Name Type
....15.50 Legal Entity Type
....15.51 Legal Entity Type
....15.52 Address Use for Location
....15.53 HPI Alias Type (Location)
....15.54 HPI Location Type
....15.55 HPI Name Prefix
....15.56 NZSCC4N99 four digit country code
....15.57 Address Purpose (Qualifier) for Organisation
....15.58 Address Type for Organisation
....15.59 Address Use for Organisation
....15.60 Name qualifier for Organisation
....15.61 Organisation Type
....15.62 Organisation Type
....15.63 HPI Alias Type (Organization)
....15.64 PractitonerRole code
....15.65 PractitonerRole status reason
....15.66 HPI Registration Status
....15.67 HPI Registration Status
....15.68 HPI Registration Type
....15.69 HPI Registration Type
....15.70 HPI Scope of Practice
....15.71 Use values for a HumanName
....15.72 IdentifierUse
....15.73 IdentifierUse
....15.74 IdentifierType
....15.75 Location alias types
....15.76 Status of Location - is it still in use
....15.77 Type of location
....15.78 NameUse
....15.79 Address Not Validated Reason
....15.80 Address Type for Patient
....15.81 NZ Citizenship Information Source
....15.82 Citizenship or Residency Status
....15.83 Country of Birth Information Source
....15.84 Date of Birth Information Source
....15.85 Date of Death Information Source
....15.86 Name Information Source
....15.87 NZ Residency Information Source
....15.88 Organization alias types
....15.89 Additional Authorisation for functions that a Practitioner can perform
....15.90 Registration Status of Practitioners
....15.91 PractitionerRoleCodes
....15.92 PractitonerRole status reason
....15.93 Scope of practice
....15.94 Professional registration the healthcare provider has
....15.95 Additional Authorisation
....15.96 AddressType
....15.97 AddressUse
....15.98 Type of Alias
....15.99 ContactPointSystem
....15.100 ContactPointUse
....15.101 District Health Board Code
....15.102 Domicile Code
....15.103 Ethnicity New Zealand Standard Classification 2005 (level 4)
....15.104 Ethnicity lvl 2
....15.105 Ethnicity lvl 3
....15.106 Gender
....15.107 Gender
....15.108 HPI Additional Authorisation
....15.109 OrgFac Address Purpose
....15.110 OrgFac Address Type
....15.111 OrgFac Address Use
....15.112 HPI Alias Type
....15.113 OrgFac Contact Type
....15.114 OrgFac Contact Usage
....15.115 HPI Country Code
....15.116 HPI Disestablishment Reason
....15.117 HPI Disestablishment Reason
....15.118 Facility Type
....15.119 Legacy HPI 2 alpha language codes
....15.120 HPI Name Prefix
....15.121 HPI Legacy Name Type
....15.122 Legal Entity Type
....15.123 Location Type
....15.124 OrgFac Name Qualifier
....15.125 Organisation Type
....15.126 HPI PractitionerRole status reason
....15.127 HPI Registration Status
....15.128 HPI Registration Status
....15.129 HPI Registration Type
....15.130 IdentifierUse
....15.131 ISO3166-1 two character country code
....15.132 ISO 639-3:2007 (3-alpha language code)
....15.133 Type of Location
....15.134 Name Prefix
....15.135 Address Not Validated Reason
....15.136 Patient Address Type
....15.137 Citizenship or Residency Status
....15.138 Official Information Source
....15.139 NZSCC4N99 four digit country code
....15.140 Professional registration the healthcare provider has
....15.141 Registration Status of Practitioners
....15.142 PractitionerRoleCodes
....15.143 PractitonerRole status reason
....15.144 Scope of practice
....15.145 SNOMED Health occupation subset (New Zealand Ministry of Health)
....15.146 administrative-gender
....15.147 id-1
....15.148 id-33
....15.149 id-34
....15.150 id-4
....15.151 id-9
....15.152 name-use
....15.153 v2-0203
....15.154 hpiFacility
....15.155 hpiOrganization
....15.156 hpiProvider
....15.157 hpipractitionerrole
....15.158 nzFacilitylegacy
....15.159 nzOrganizationlegacy
....15.160 nzbn
....15.161 nzchrir
....15.162 nzdental
....15.163 nzdiet
....15.164 nzmc
....15.165 nzmwife
....15.166 nznc
....15.167 nzocc
....15.168 nzopt
....15.169 nzost
....15.170 nzparamed
....15.171 nzpharm
....15.172 nzphysio
....15.173 nzpod
....15.174 nzpsycho
....15.175 nzpsyhc
....15.176 nzrad
....15.177 nzscience
....15.178 id-43
....15.179 id-44
....15.180 id-45
....15.181 id-46
....15.182 id-47
....15.183 id-48
....15.184 id-49
....15.185 id-50
....15.186 id-51
....15.187 id-52
....15.188 id-53
....15.189 id-54
....15.190 id-55
....15.191 id-56
....15.192 id-57
....15.193 id-58
....15.194 id-59
....15.195 id-60
....15.196 id-61
....15.197 id-62
....15.198 id-63
....15.199 id-64
....15.200 id-65
....15.201 id-66
....15.202 hltest