--- title: HI SERVICE - Health Identifiers Service User Manual (7.10+) slug: portal-sub/hi-service-health-identifiers-service-user-manual-710 docTags: createdAt: 2026-03-04T12:03:15.410Z --- ## Background The Healthcare Identifiers Service (HI Service) is a national system for uniquely identifying healthcare providers and patients. A healthcare identifier is a unique 16-digit number which makes sure the right health information is associated with the right individual. The HI Service forms the basis of other eHealth initiatives, such as the Personally Controlled Electronic Health Record (PCEHR) now called My Health Record. The Department of Human Services (DHS) manages the allocation, maintenance anddisclosure of healthcare identifiers to healthcare providers, healthcare organisations and the public.This is legislated under the Healthcare Identifiers Act 2010 which can be found at[http://www.comlaw.gov.au/Details/C2010C0440](http://www.comlaw.gov.au/Details/C2010C0440). The purpose of this document is to guide you through changes, setup and use of the HI service in Profile (minimum Profile version required is 7.6). It is expected that your organisation has completed the external setup components with DHS such as registering your organisation and receiving PKI certificates. However, this document will touch on some of these points. :::hint{type="danger"} **Note** The AMA have a guide labeled “Getting ready for the PIP eHealth incentive and PCEHR” available at [https://ama.com.au/article/getting-ready-pip-ehealth-incentive-and-pcehr](https://ama.com.au/article/getting-ready-pip-ehealth-incentive-and-pcehr). ::: ### Healthcare Provider Organisations (HPI-O) There are two organisation types that operate within the HI Service. A seed organisation is a legal entity within Australia which provides or controls the delivery of healthcare services. A network organisation is linked to, and provides services to, the seed organisation. To register, forms can be found at [https://www.servicesaustralia.gov.au/healthcare-identifiers-hi-service-for-health-professionals](https://www.servicesaustralia.gov.au/healthcare-identifiers-hi-service-for-health-professionals) ### Healthcare Provider Individuals (HPI-I) Healthcare providers can register for a Healthcare Provider Identifier - Individual (HPI-I). To register with the HI Service, you need to complete the appropriate form(s). To register, forms can be found at [https://www.humanservices.gov.au/organisations/healthprofessionals/services/medicare/healthcare-identifiers-service-health-professionals](https://www.humanservices.gov.au/organisations/healthprofessionals/services/medicare/healthcare-identifiers-service-health-professionals) ### Accessing the HI Service electronically (via PKI certificates) Microsoft .NET Framework 4 needs to be installed on the server. You can download this via[http://www.microsoft.com/net/download](http://www.microsoft.com/net/download). Consult your IT system administrator before doing this install. If you have an existing Department of Human Services Public Key Infrastructure (PKI) certificate, you canuse this form [https://www.humanservices.gov.au/organisations/health-professionals/forms/hw045](https://www.humanservices.gov.au/organisations/health-professionals/forms/hw045) or call DHS on 1300 361 457 to update your permissions to include HI Service access. Read the Individual/Provider Certificate information on[https://www.humanservices.gov.au/organisations/health-professionals/subjects/doing-business-onlinehealth-professionals](https://www.humanservices.gov.au/organisations/health-professionals/subjects/doing-business-onlinehealth-professionals) and complete the appropriate forms if you need to apply for a PKI. You’ll need to provide evidence of your identity with these forms. The new PKI certificates need to be shared and available from your server. ## Changes in Profile for HI and Secure Message Delivery Services There are several areas in Profile where changes were made to incorporate HI Service mechanisms. 1. The Patient Register (**Patient/New Patient** or **Patient/Alter Patient**) now contains an area to enter, update and display the patient IHI details: ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/HvKmgInTI-WKoLXaJCGdX_vwomsr6ajjzivntfs9jokskhbg4f-njka.png" size="50" isUploading="false" initialPath="assets/vWOMSR6aJjZIVnTFs9JoKskhbg4_F-NJKA.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/vWOMSR6aJjZIVnTFs9JoKskhbg4_F-NJKA.png" position="flex-start" showCaption="false" indent="2"} | Field | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | **IHI Number** | Displays the 16-digit number created by the HI Service to identify the patient. | |

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/fIlzBp_Gtd_rWkcttbZw3_fn85somgjjaaveko3hcqdq2h4lpjuclteg.png" size="29" isUploading="false" initialPath="assets/FN85sOmGjjaAVeKO3HcqDQ2H4lPJucLTeg.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/FN85sOmGjjaAVeKO3HcqDQ2H4lPJucLTeg.png" position="flex-start" showCaption="false"} | Allows the HI Service to be searched for verification. | | **IHI Number Status** | Indicates the validity of the IHI Number as of a date. IHI validations will expire based on a configurable number of days and must be re-validated. | | **IHI Record Status** | Indicates whether the IHI number is provisional, unverified, or verified. | | **IHI Last Update** | Displays the date that the IHI number or any of its associated statuses have been updated. | 2. **Organisation/People & Places/Providers and Users** now contains an area to update and display a provider’s HPI-I and an area to indicate whether the provider is a **Responsible Officer for POS** or an **Organisation Maintenance Officer for POS**: **General** view in the provider/user profile ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/NSVf-NH7eJEUETYxvQiLY_1et1pwafezbbn1i2-5bvpv2hk0qpjccva.png" size="31" isUploading="false" initialPath="assets/1Et1pwaFezbbN1I2-5bvpv2HK0qp_jcCVA.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/1Et1pwaFezbbN1I2-5bvpv2HK0qp_jcCVA.png" position="flex-start" showCaption="false"} (read only) ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/IS01L43TxfUOlymEFPpoU_ddtdymmer8ufz5mudvupblvjubktmds1qq.png" size="59" isUploading="false" initialPath="assets/DdTDymmEr8ufZ5muDvuPBLvJUBktmdS1qQ.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/DdTDymmEr8ufZ5muDvuPBLvJUBktmdS1qQ.png" position="flex-start" showCaption="false"} **Reference** view in provider profile ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/4aFIlUULxclwF2hPQFNk1_leud05fcjzwgkyviiosbbnd6pdzxraoeda.png" size="44" isUploading="false" initialPath="assets/leUD05fCjZWgKYvIIOSbbND6pDZXRaoedA.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/leUD05fCjZWgKYvIIOSbbND6pDZXRaoedA.png" position="flex-start" showCaption="false"} 3. Organisation/External Providers now contains an area to display and update the external provider’s HPI-I and the HPI-O: **General** view in external provider profile ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/84LyabOFarhqVsu863KOC_v5vx6fhfjdenr08z-drttgoe4fkeutnwq.png" size="27" isUploading="false" initialPath="assets/v5VX6FHfjdenr08Z-DRt_TgoE4fkeuTnWQ.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/v5VX6FHfjdenr08Z-DRt_TgoE4fkeuTnWQ.png" position="flex-start" showCaption="false"} (read only) **Reference** view in external provider profile ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/3Q_JlIVHgtGdNcLCtSvdj_l6cnsxjrbfyudckffzeipcirfigk9cmmig.png" size="31" isUploading="false" initialPath="assets/l6CnsXjRbFyuDckffZEIPcirfIGK9CmMig.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/l6CnsXjRbFyuDckffZEIPcirfIGK9CmMig.png" position="flex-start" showCaption="false"} 4. **Organisation/Preferences/eMessages** now contains 2 new services associated with HI Service: ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/NGiBOodkzaIKTzengD_FS_voycf4rtooxvmvk3kqqlvegtdycpc4q.png" size="38" isUploading="false" initialPath="assets/VoyCf4rtooxvM__Vk3kqqLVegtDycpC_4Q.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/VoyCf4rtooxvM__Vk3kqqLVegtDycpC_4Q.png" position="flex-start" showCaption="false" indent="2"} 5. A scheduled task can be created that allows the organisation to specify when batch searching of patients’ IHI is done through **New Health Identifier Service Batch Search**. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/lZr2YpkY6kaHDF0r3bNXO_r1kjoxr44iiymxnon7nspbfvnhbenmawua.png" size="73" isUploading="false" initialPath="assets/R1kjoxr44IIYmXNoN7NSpbFvnHbeNmAwuA.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/R1kjoxr44IIYmXNoN7NSpbFvnHbeNmAwuA.png" position="flex-start" showCaption="false" indent="2"} 6. All incoming messages relating to the HI Service can be viewed in **Control Centre/Manage/Incoming HI Messages**. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/bPYBfO1KMxJq43t3m-ImA_3q0qq-jul9swhgcmfmft3vhmmzxcxcva2g.png" size="94" isUploading="false" initialPath="assets/3Q0qQ-JUl9SwhGCmfMFt3VHmMZXCxCva2g.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/3Q0qQ-JUl9SwhGCmfMFt3VHmMZXCxCva2g.png" position="flex-start" showCaption="false" indent="2"} :::hint{type="danger"} **Note** The role action must be granted. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/8igNzXe7NXOw39NB-Eq6t_irr5h8xoiyb9flxw8k4augmp3rhptzilq.png" size="53" isUploading="false" initialPath="assets/IrR5H8xoIYb9Flxw8K4Augmp_3RHpTZiLQ.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/IrR5H8xoIYb9Flxw8K4Augmp_3RHpTZiLQ.png" position="flex-start" showCaption="false"} ::: 7. All outgoing messages to the HI Service can be viewed in **Control Centre/Manage/Outgoing Messages**. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/8X2DHrSGX6ORuciVlMJEr_xncc2ds-a9h8wdsb3uihea4otqpsnjxprw.png" size="93" isUploading="false" initialPath="assets/XnCc2Ds-A9H8WdSB3UiHea4otQpsnJxPRw.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/XnCc2Ds-A9H8WdSB3UiHea4otQpsnJxPRw.png" position="flex-start" showCaption="false" indent="2"} :::hint{type="info"} **Hot Tip** A filter can be created to display only HI Services by checking the **Health Identifier Service** checkbox in the **Message types** panel. ::: 8. Any errors created by using the HI Service can be viewed in **Control Centre/Manage/Import /Export Errors**. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/jGH_lk37ZQIIsSjhGw2u5_9gx03etzjx9hdeuo-dy4mp8emsgk6natsg.png" size="93" isUploading="false" initialPath="assets/9gX03etZjX9hdeUo-dy4mP8eMsgk6natsg.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/9gX03etZjX9hdeUo-dy4mP8eMsgk6natsg.png" position="flex-start" showCaption="false" indent="2"} 9. A column for **IHI number** can be viewed in **Control Centre/Manage/Merge/Delete**. Prior to merging, a prompt will ask you if you want to search for new IHI. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/mnIc_6IMthNoEugGfX9Iw_tce0ldfefwawwkpggz1rnemypq6b4qg.png" size="99" isUploading="false" initialPath="assets/T_CE0LdfEFWawW_KPggz1rNemypQ6B4Q_g.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/T_CE0LdfEFWawW_KPggz1rNemypQ6B4Q_g.png" position="flex-start" showCaption="false" indent="2"} ## Configuration ### Installing Medicare Certificates These instructions should be performed on the server machine logged in as Administrator with full privileges to install certificates. It is expected that you know the Medicare certificates’ Passphrases. This process only needs to be done once and only on the server machine where IHServer is running. Typically, there are 2 Medicare certificates: - fac sign.p12 - fac encrypt.p12 These both need to be installed into the trusted certificate stores for Windows on the server. :::hint{type="danger"} **Note** If IH Server.exe services run under a service account, the certificates need to be imported into the personal certificate store for the user’s login. The same steps below can be followed but in step 2, instead of selecting **Trusted Root Certification Authorities**, select **Personal**. ::: 1. Click Start/Run and enter **certmgr.msc** to launch the Certificate Manager application. 2. In the certmgr window, select **Trusted Root Certification Authorities**. 3. In the toolbar menu, select Action/All Tasks/Import… to launch the Certificate Import Wizard. 4. Press Next and browse to where the Medicare certificates are located on the server and select the fac sign.p12 certificate. :::hint{type="danger"} **Note** You may need to choose the Personal Information Exchange .p12 extension from the dropdown list next to the **File name** field. ::: 5. Press Next and enter the Medicare certificate Passphrase into the **Password** field. 6. Press Next, select the **Place all certificates in the following store** radio button and press Browse. 7. Check the **Show physical stores** checkbox, expand the **Trusted Root Certification Authorities** folder and select **Local Computer**. Press OK. 8. Press Next and Finish. :::hint{type="danger"} **Note** If a security warning confirming that you want to import the certificate appears at any point during this process, press Yes. ::: 9. For the fac encrypt.p12 certificate, follow the same steps as above, except you will import it into the **Intermediate Certification Authorities** folder in the certmgr window. ### Profile Setup ### Responsible Officer (RO) and the Organisation Maintenance Officer (OMO) An individual can be both RO and OMO, but Profile will only allow one RO to be checked per organisation, though multiple OMOs are allowed. Only the RO can perform verification of the HPI-O foran organisation and the OMO can perform verification of HPI-I number of a Provider and HPI-O and HPI-I numbers of an External Provider. 1. Go to **Organisations/People & Places**. 2. Open the provider/user’s profile and, in the **General** view, check the **Responsible Officer for POS** checkbox and/or the **Organisation Maintenance Officer for POS** checkbox. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/ym7t0GGKERPiB6cGUFZ-d_kdrqo3xx1obckgao1boqqk5mdg1qvxrxw.png" size="94" isUploading="false" initialPath="assets/KDRQO3Xx1ObCkGAO1BO_qqK5MDG1Qvxrxw.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/KDRQO3Xx1ObCkGAO1BO_qqK5MDG1Qvxrxw.png" position="flex-start" showCaption="false" indent="2"} 3. In the **Roles** view, grant the role action for this provider/user. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/juqdDtQdfPUyU6WbSdqk5_tug4fuzgq9nun6cvoma58dgq5277c3jog.png" size="53" isUploading="false" initialPath="assets/TuG4fuZgQ9n_Un6CvOmA58dGQ5277C3JOg.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/TuG4fuZgQ9n_Un6CvOmA58dGQ5277C3JOg.png" position="flex-start" showCaption="false" indent="2"} 4. Press **OK**. ### Verifying HPI-O 1. Login as the RO. 2. Go to **Organisation/People & Places**. 3. Double-click the Organisation profile. 4. Verify the **Name** and **Address** of the organisation. This will be used to verify that the HPI-O is accurate. If the HPI-O does not match the Organisation **Name** or is not found, the HPI-O will be invalid. ### Installing eMessage Services for HI and Secure Message Delivery Health Identifier and Secure Message Delivery (SMD) services can be set up at the same time in Profile even if the practice is not yet using SMD. For SMD, the practice must have installed the NASH certificate for its HPI-O – this is the same certificate used for My Health Record (The certificate will have a subjectname similar to: general.8003623233351435.id.electronichealth.net.au). Prior to creating the new SMD eMessage service, set up Outgoing and Incoming Directories on the practice hard drive for message storage and note the path name to these folders. ### Set up of Health Identifier Service 1. Go to **Organisation/Preferences/eMessages**. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/FHRCuY1GmzSLPdbIZAwFd_zxzut3z0e39hblnf0clokqqkq0jdlzlgcq.png" size="88" isUploading="false" initialPath="assets/zxzut3z0E39Hblnf0ClOkQQkQ0JDLzLgCQ.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/zxzut3z0E39Hblnf0ClOkQQkQ0JDLzLgCQ.png" position="flex-start" showCaption="false" indent="2"} 2. Drag and drop **Health Identifier Service** from the **Available Services** panel to the **Installed Services** panel. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/9d-IppaHmPDqD3rBaADwa_gfp6rxfuenp8huzrp2fhccjww5b8la8gfq.png" size="52" isUploading="false" initialPath="assets/gfP6RxfuEnp8hUzRp2fHCCJWW5B8la8GFQ.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/gfP6RxfuEnp8hUzRp2fHCCJWW5B8la8GFQ.png" position="flex-start" showCaption="false" indent="2"} 3. In the **Name** field, ensure **Health Identifier Service** is entered. 4. Ensure that the **Base URL** is [https://www3.medicareaustralia.gov.au/pcert/soap/services/](https://www3.medicareaustralia.gov.au/pcert/soap/services/) 5. In the **Certificate** panel, enter your organisation’s certificate passphrase into the **Passphrase** field and press **Import**. 6. Profile will prompt you to browse to and select your PKI certificate (fac\_sign.P12). Press **OK** to import the certificate. 7. Press **Test** to see if the certificate is valid. 8. In the **Troubleshooting** panel, set the number of days that the IHI number validation will be in effect. For example, after 100 days, access to a patient’s My Health Record will not be permitted unless the patient’s IHI is validated on the Alter Patient screen. 9. Press **OK**. ### Set up of Health Identifier Service Batch Search 1. Drag and drop **Health Identifier Service Batch Search** from the **Available Services** panel to the **Installed Services** panel. This opens the Health Identifier Service Batch SearchProperties window. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/40YXXtu1HloHLlHJA7pQs_ozdsetu3s0q1g1zftbmlcphg1a7unsdtrw.png" size="61" isUploading="false" initialPath="assets/ozDSetU3S0Q1G1ZfTbmLcphg1a7unsdtRw.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/ozDSetU3S0Q1G1ZfTbmLcphg1a7unsdtRw.png" position="flex-start" showCaption="false" indent="2"} 2. In the **Name** field, ensure **Health Identifier Service Batch Search** is entered. 3. Ensure that the **Base URL** is [https://www3.medicareaustralia.gov.au/pcert/soap/services/](https://www3.medicareaustralia.gov.au/pcert/soap/services/) 4. Check the **Perform Batch search of HI Service for patients without IHI number and update matching records** checkbox. The default HI Service limit is 100, but this can be edited. 5. In the **Notify (for error and status reports)** field, enter the RO or the OMO login name.This individual will be sent status updates on the batch IHI search via email. 6. Press **OK**. ### Set up My Health Record or Secure Message Delivery (SMD) for eReferrals 1. Drag and drop **eHealth Access** from the **Available Services** panel to the **Installed Services** panel. This opens the eHealth Access Properties window. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/nqQ0U2Epe2s7FVHoDSfvP_mtimanjozkx7vkcdrg-4cmh4zbf5boz9g.png" size="66" isUploading="false" initialPath="assets/MTiMANjOZkX7VkCdRG_-4CMH4zbf5bOZ9g.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/MTiMANjOZkX7VkCdRG_-4CMH4zbf5bOZ9g.png" position="flex-start" showCaption="false" indent="2"} 2. In the **Specific** panel/**General** tab, enter your organisation’s **HPI-O** number. 3. In the **Certificate** panel, enter your organisation’s certificate passphrase into the **Passphrase** field and press **Import**. 4. Profile will prompt you to browse to and select your NASH HPI-O certificate (fac\_sign.P12). Press **OK** to import the certificate. 5. Press **Test** to see if the certificate is valid. 6. Even if your practice is not using SMD, create an **Outgoing Directory** and **Incoming Directory** for message storage in the **Specific** panel/**eReferral** tab. 7. Enter the **HPI-O** number and press **Verify with HI Service** (which can only be done by the user with the\*\* Responsible Officer for POS\*\* checkbox checked, as mentioned previously). If the HI Service verifies the HPI-O and Organisation name, then **HPI-O Verified** will be displayed. If the HI Service deems the HPI-O to be invalid, then a tooltip with information will appear and an error log will becreated in **Control Centre/Manage/Import/Export Error**s. ### Verify Provider HPI-I 1. Login as the OMO. 2. Go to **Organisation/People & Places**. 3. Open the provider’s profile. 4. Verify the **Full Name** and **Address** of the provider. This will be used to verify that the HPI-I is accurate. If the HPI-I does not match the provider’s **Full Name** or is not found, the HPI-I will be invalid. :::hint{type="danger"} **Note** To verify a provider’s HPI-I, you will need to have registered and know their HPI-I already. Profile can only verify your provider’s HPI-I if they are registered with DHS and their details match what has been submitted to DHS. If the provider is registered with a middle name, for example, this must match what is in Profile under their full name. ::: 5. Go to the **Reference** view and enter the **HPI-I** number. 6. Press **Verify with HI Service**. If the HI Service verifies the HPI-I, then it will display in the **General** view. If the HI Service deems the HPI-I to be invalid, then a tooltip with information will appear and an error log will be created in **Control Centre/Manage/Import/Export Errors**. ### Verifying External Provider HPI To use Secure Message Delivery, external provider HPIs (Organisation or Providers) need to be verified and stored in Profile. An External Provider record can store either a HPI-I or HPI-O or both. 1. Log in as the OMO. 2. Go to **Organisation/External Providers**. 3. Search for and open the desired external provider’s profile. 4. Check the **Full Name** and **Address**. The **Full Name** will be used to verify that the HPI-I is accurate.If the HPI-I does not match the **Full Name** or is not found, the HPI-I will be invalid. 5. Check the **Org Name**. The External Provider’s **Org Name** will be used to verify that the HPI-O is accurate. If the HPI-O does not match the **Org Name** or is not found, the HPI-O will be invalid. 6. In the **Reference** view, enter the External Provider’s HPI-I and/or HPI-O number in the relevant field. 7. Press **Verify with HI Service**. If the HI service verifies the HPI, then it will display in the **General** view. If the HI Service deems the HPI to be invalid, then a tooltip with information will appear and an error log will be created in **Control Centre/Manage/Import/Export Errors**. ## Verifying and Searching Patients’ IHIs Profile will ask you to verify or search for IHI details when a new patient is created or when an already existing patient’s details are altered. - If a patient’s Name, Date of Birth, Gender and Medicare or DVA numbers are recorded, then Profile will prompt you to search the HI service for the patient’s IHI number - If a patient’s Name, Date of Birth, Gender and IHI number are recorded, then Profile will prompt you to verify the patient’s IHI number ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/4V4c4xHPvsLxAY5ekDX3j_hiqegrm9uevjgyym3xottcjltd9lfuwqg.png" size="66" isUploading="false" initialPath="assets/HiqEgrM9uEVjgyy_M3XOtTcJlTd9lfuWQg.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/HiqEgrM9uEVjgyy_M3XOtTcJlTd9lfuWQg.png" position="flex-start" showCaption="false" indent="2"} - If **Yes** is pressed, then Profile will search and verify the patient’s IHI - If **No** is pressed, then Profile will continue saving the patient’s record without an IHI even if recorded ### Searching IHIs IHIs have been assigned to patients with Medicare or DVA numbers. It is highly likely that a search using these numbers will return the patient’s IHI.If the patient’s Medicare or DVA card number is recorded along with Name, Gender and Date of Birth, then Profile can search for the patient’s IHI number. 1. Go to **Patient/Alter Patient**. 2. Search for and select the patient. 3. Check the patient’s Name, Date of Birth and Gender. 4. Update or enter the patient’s Medicare or DVA card number. :::hint{type="danger"} **Note** If the IHI does not match the patient’s details, or is not found, the IHI will not be recorded. ::: 5. Press **Search HI Service** (search may take a few seconds). - If the HI Service verifies the IHI, it will display in **IHI Number** field. The **IHI Number Status**, **IHI Record Status** and **IHI Last update** fields will automatically populate. These can beaudited by pressing **Show Versions ** and scrolling through the dropdown options. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/Tk7uRhowx15OeNroMEb_P_5p6rg4hj5fbmwhsytgwfivmlqf5xlxk8w.png" size="30" isUploading="false" initialPath="assets/5p6rG4Hj5FbMwhsytgwfivmlqf5XL_XK8w.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/5p6rG4Hj5FbMwhsytgwfivmlqf5XL_XK8w.png" position="flex-start" showCaption="false" indent="2"} - If the HI Service deems the IHI to be invalid, then a tooltip with information will appear and an error log will be created in **Control Centre/Manage/Import/Export Errors** ### Verifying IHIs If the patient’s IHI number is known and recorded then Profile can search for and verify the record in combination with their Name, Date of Birth and Gender. 1. Go to **Patient/Alter Patient**. 2. Search for and select the patient. 3. Check the patient’s Name, Date of Birth and Gender. 4. Enter the patient’s IHI number. :::hint{type="danger"} **Note** If the IHI does not match the patient’s details, or is not found, the IHI will not be recorded. ::: 5. Press **Search HI Service** (search may take a few seconds). - If the HI Service verifies the IHI, it will display in **IHI Number** field. The **IHI Number Status**, **IHI Record Status** and **IHI Last update** fields will automatically populate. These can beaudited by pressing **Show Versions ** and scrolling through the dropdown options. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/KYzQV-RP_NG-4-2mgYg78_zrndzlbbipzrhrbdw0llr2ekvgpyuyfga.png" size="30" isUploading="false" initialPath="assets/zrndZLBbIpzR_hrBdW0lLR2EKVGpyUyfGA.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/zrndZLBbIpzR_hrBdW0lLR2EKVGpyUyfGA.png" position="flex-start" showCaption="false" indent="2"} - If the HI Service deems the IHI to be invalid, then a tooltip with information will appear and an error log will be created in **Control Centre/Manage/Import/Export Errors** :::hint{type="danger"} **Note** IHI validation will expire based on the number of days set up in the HI Service eMessage. If it expires, My Health Record access will be denied until it is re-validated. ::: ### Batch Updating of IHI details The HI Service has the option of submitting batch searches to be carried out in the background without user interference – for example, overnight. These searches can be used to updatepatients’ records and report on any errors encountered. As mentioned in the Installing eMessage Services for HI and Secure Message Delivery section, there is currently a limit of 100 requests per batch as set out by the HI Service. 1. Go to **Organisation/Preferences/eMessages** and double-click to open **Health Identifier Service Batch Search**. 2. Go to the **Schedule** tab, and check the **Use task schedule** checkbox. 3. Press **New** and create desired the task schedule. The **Start time** and **End time** fields should typically be set to your clinic’s opening and closing times respectively. In this case, as we recommend scheduling the daily task during the night to avoid conflicts with other tasks, the **Start time** should be set to a late hour and the **End time** set accordingly. Ensure that the year in the **End Before** field is set to the year 2099. The time field next to it can stay at the defaulted time (time of task schedule creation). Please see the screenshot in Changes in Profile HI and Secure Message Delivery Services, for an example. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/cOZDkf4y8eKhTsqWBSl2k_icebne7owjicknm49szvw1somk0dlpmkg.png" size="38" isUploading="false" initialPath="assets/IcEBNe7OwJ_iCkNm49sZVW1somK0DlPMkg.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/IcEBNe7OwJ_iCkNm49sZVW1somK0DlPMkg.png" position="flex-start" showCaption="false" indent="2"} 4. Press **OK**. Once the task has successfully run, an email will be sent to the individual designated in the **Notify** field of the **Health Identifier Service Batch Search** window. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/3sSf9O67OWFZepEgRARhp_zzjfqdez6uanbr-neud3u-b6assyik7a.png" size="49" isUploading="false" initialPath="assets/zZjfqDeZ6UANbr-nEUd3_U-b6Assyi_k7A.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/zZjfqDeZ6UANbr-nEUd3_U-b6Assyi_k7A.png" position="flex-start" showCaption="false" indent="2"} :::hint{type="info"} **Hot Tip** The schedule can be accessed for disabling and altering via **Organisation/System Tasks Explorer** under **eMessage Service “Health Identifier Service Batch Search”**. ::: The Audit Logs of the Batch Search can be found in **Control Centre/Manage/Incoming HI Messages**. They are identified by the HI Service operation column. ![](https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/zViNjzDNzpK6pls9_iJid_erc7g4halbtgg4uxovtrulzvmydgkyxqyg.png) ## Merging Patients The patient records that are being merged may or may not have IHI numbers and if these numbers are present, they may or may not be the same. In any case, the HI Service will be searched for the master patient record. At the end of the merge process (after the server processing of all the merges has completed and control is returned to the client), the IHI lookup process will start. When a merge is initiated, a dialog box pops up to confirm that you want to search the HI Service. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/M9TyM4tBZo3p1QdivBoG7_0qbd5x85n2uxeke58jqzoxljj0vyntwm3w.png" size="44" isUploading="false" initialPath="assets/0QBD5x85n2UXeke58jqzOXlJJ0VYNtWM3w.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/0QBD5x85n2UXeke58jqzOXlJJ0VYNtWM3w.png" position="flex-start" showCaption="false"} - If **Yes** is pressed, Profile will merge the patients and then search the HI Service for the merged recordIf an IHI is found, then Profile will prompt you to save the details. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/gQzGPo7zcV5QnejirCCxb_bn6biux85qgjlz7u8fq1vudynqgbxqvpg.png" size="36" isUploading="false" initialPath="assets/Bn6biux85qgJlz7u8Fq1VudyNQGbxq_vpg.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/Bn6biux85qgJlz7u8Fq1VudyNQGbxq_vpg.png" position="flex-start" showCaption="false" indent="2"} If an IHI is not found, no IHI will be stored and an error log will be created in **Control Centre/Manage/Import/Export Errors**. - If **No** is pressed, Profile will merge the patients and not search the HI Service for the patients IHI details. The existing IHI details will remain ## Print variables Print variables have been created in Profile to accommodate the new HI Service numbers. These can be used in letters, appointments, forms, typing templates, patient and clinical information panels. - «Letter.Patient.IHI» - «Letter.Patient.IHILastUpdate» - «Letter.Patient.IHINumStatus» - «Letter.Patient.IHIRecStatus» - «Letter.Patient.CareTeam("XXX").HPII» - «Letter.Patient.CareTeam("XXX").HPIO» - «Letter.Patient.DoctorAlt.HPII» - «Letter.Patient.DoctorUsual.HPII» - «Letter.Patient.LeadMaternityProvider.HPII» - «Letter.Patient.LeadMaternityProvider.HPIO» - «Letter.Doctor.HPII» - «Letter.POS.HPIO» - «Letter.POS.OMO» - «Letter.POS.RO» - «Letter.Encounter.Provider.HPII» - «Letter.Encounter.POS.HPIO» - «Letter.Encounter.POS.OMO» - «Letter.Encounter.POS.RO» - «Letter.Organisation.HPIO» - «Letter.Organisation.OMO» - «Letter.Organisation.RO» - «Letter.Recipient.IHI» - «Letter.Recipient.IHILastUpdate» - «Letter.Recipient.IHINumStatus» - «Letter.Recipient.IHIRecStatus» - «Letter.LoggedOnUser.HPII» - «Letter.LoggedOnPOS.HPIO» - «Letter.LoggedOnPOS.OMO» - «Letter.LoggedOnPOS.RO» - «Letter.Context.Case.Patient.IHI» - «Letter.Context.Case.Patient.IHILastUpdate» - «Letter.Context.Case.Patient.IHINumStatus» - «Letter.Context.Case.Patient.IHIRecStatus» - «Letter.Context.Whiteboard.Patient.IHI» - «Letter.Context.Whiteboard.Patient.IHILastUpdate» - «Letter.Context.Whiteboard.Patient.IHINumStatus» - «Letter.Context.Whiteboard.Patient.IHIRecStatus» - «Letter.Context.Whiteboard.FromProvider.HPII» - «Letter.Context.Whiteboard.ToProvider.HPII» - «Letter.Context.Whiteboard.FromPOS.HPIO» - «Letter.Context.Whiteboard.FromPOS.OMO» - «Letter.Context.Whiteboard.FromPOS.RO» - «Letter.Context.Whiteboard.ToPOS.HPIO» - «Letter.Context.Whiteboard.ToPOS.OMO» - «Letter.Context.Whiteboard.ToPOS.RO» - «Letter.Context.Waitlist.Patient.IHI» - «Letter.Context.Waitlist.Patient.IHILastUpdate» - «Letter.Context.Waitlist.Patient.IHINumStatus» - «Letter.Context.Waitlist.Patient.IHIRecStatus» - «Letter.Context.Waitlist.Provider.HPII» - «Letter.Context.Waitlist.POS.HPIO» - «Letter.Context.Waitlist.POS.OMO» - «Letter.Context.Waitlist.POS.RO» - «Letter.Context.Invoice.Provider.HPII» - «Letter.Context.Invoice.POS.HPIO» - «Letter.Context.Invoice.POS.OMO» - «Letter.Context.Invoice.POS.RO» - «Letter.Context.Appointment.POS.RO» - «Letter.Context.Appointment.POS.OMO» ## Find Objects In 8.1, the following properties are added to Find Objects: - Under the **Letters** object, there is the **My Health Record** property, with various attributes. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/H-TdkDYMIiDr5XHvzdyYw_jqox5scxtdonw5qkzeqzaslzdyuojhksw.png" size="33" isUploading="false" initialPath="assets/jQOX_5ScXTdoNW5qKzEqZASlzdYUoJhkSw.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/jQOX_5ScXTdoNW5qKzEqZASlzdYUoJhkSw.png" position="flex-start" showCaption="false" indent="2"} - Under the **Patient** object and the **Letter** property, there are attributes for **Consent Withdraw Status**, **Last Check Date** and **My Health Record Status**. ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/Dwkz-u1QR0RAf-raee_0R_fuq8ls-ieenmbpj8oecxuhde0jbk4u9a7q.png" size="34" isUploading="false" initialPath="assets/fUq8lS-IEenmbpj8oecxuhdE0JBk4U9a7Q.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/fUq8lS-IEenmbpj8oecxuhdE0JBk4U9a7Q.png" position="flex-start" showCaption="false" indent="2"} These attributes are mapped to the **My Health Record** panel fields in **Alter Patient/Internet**: ::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/FtURrNxh9ZtGv2D2LlngJ_yvdqu6jptvrz-wifem9n573tsfux9pe41g.png" size="66" isUploading="false" initialPath="assets/yVdQu6JptVRZ-WiFEm9N573tsfUX9PE41g.png" githubPath="en/General Settings and Configuration/Organisational Management - New Zealand/assets/yVdQu6JptVRZ-WiFEm9N573tsfUX9PE41g.png" position="flex-start" showCaption="false"} ## HI Service Log Messages There are three views in the **Control Centre/Manage** segment that record HI related messages in Profile. These views can be filtered, refreshed, and sorted (by date, for example). 1. **Control Centre/Manage/Import/Export Errors**: This is a generic log of all Profile import/export error messages. If there is an error message or if the HI Service is unavailable, messages will be stored here. To view the details, select an error line and press  ::Image[]{src="https://files.document360.io/2da745be-2e9b-44a6-8476-b12b46bda2f6/Images/Documentation/image%28601%29.png" size="100" alt="image.png" isUploading="false" showCaption="false" indent="2"} :::Paragraph{indent="1"} . ::: 2. **Control Centre/Manage/Outgoing Messages**: This is a generic log of all Profile outgoing messages. This log contains details about the type of HI message, the outcome and the actual UUID (Universally Unique IDentifier) of the HI message. :::hint{type="danger"} **Note** If UUID is required, you can accurately cut and paste these UUIDs (to avoid typing errors) by printing the report to a PDF and then “cutting and pasting” from the PDF. ::: 3. **Control Centre/Manage/Incoming HI Messages**: This is the audit log for all HI Service messages only. It has been set up to meet the conformance requirements. *** ## Attachments ::File{src="https://api.qa.archbee.co/api/presign/zICxj0dnLereb6UUrBA3-/9OSHk3t3dLSFP7Mql1xMy_6000237511-hi-health-identifiers-service-user-manual-v1.pdf" label="HI Health Identifiers Service - User Manual v1.pdf" initialPath="../../../attachments-export/6000237511-HI%20Health%20Identifiers%20Service%20-%20User%20Manual%20v1.pdf" githubPath="attachments-export/6000237511-HI Health Identifiers Service - User Manual v1.pdf"}