---
title: eSpecial Authority Configuration
slug: portal-sub/especial-authority-configuration
docTags: 
createdAt: 2026-03-04T12:03:18.455Z
---

## Setup

The minimum required build is 8.3.0.772.

The required Health System is New Zealand.

The required database is NZ.

The functionality works with both MIMS-NE and NZULM formularies.

The URL and Practice ID code are provided by the Ministry of Health. Please contact the Ministry of Health atonlinehelpdesk\@moh.govt.nz or phone 0800 505 125 option 5 for more information.

## Configuration

1. Go to **Organization/Preferences/Script and Instruction**, select the **Interface** tab and confirm the **Pop up Special Authority Window** checkbox is checked.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/DFBJ3jxiUgvsDcFY8Gwkf_f03vqa41ioao581zi2peys9mdchb4zdiw.png" size="96" isUploading="false" initialPath="assets/f03Vqa41iOAO581Zi2pEYS9MDChB4zD_iw.png" githubPath="en/Medication Management/Prescriptions - New Zealand/assets/f03Vqa41iOAO581Zi2pEYS9MDChB4zD_iw.png" position="flex-start" showCaption="false" indent="2"}

2. Go to **Organization/Preferences/eMessages** and drag and drop the e-Special Authority service from the **Available Services** panel to the **Installed Services** panel and check the **e-Special Authority service** checkbox.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/Du8pJN-zDKg1X7RZ5-T0U_p8u81vf4uswuq3erkfqkaxvhfzfibvpma.png" size="100" isUploading="false" initialPath="assets/-P8u81Vf4UswuQ3eRkFqKAXVHfzFiBvPmA.png" githubPath="en/Medication Management/Prescriptions - New Zealand/assets/-P8u81Vf4UswuQ3eRkFqKAXVHfzFiBvPmA.png" position="flex-start" showCaption="false" indent="2"}

:::hint{type="danger"}
**Note**

To use the Manual Special Authority form, the **e-Special Authority service** checkbox must be unchecked.
:::

3. Double-click the e-Special Authority service to open the e-Special Authority Properties window. In the **Specific** panel, fill in the **Communication** and **Location** information.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/cXq7Z5SNhiAiMPX0rqrDj_wi7epuazu4ajg3f8v0ngbtb8mlx0zobxmw.png" size="83" isUploading="false" initialPath="assets/Wi7epuazu4ajG3f8v0ngbtB8mLx0ZoBxmw.png" githubPath="en/Medication Management/Prescriptions - New Zealand/assets/Wi7epuazu4ajG3f8v0ngbtB8mLx0ZoBxmw.png" position="flex-start" showCaption="false" indent="2"}

:::Paragraph{indent="1"}
The **Communication** panel contains the information required to connect to the e-Special Authority service.
:::

| Field name   | Entry                                                                                    |
| ------------ | ---------------------------------------------------------------------------------------- |
| **Url**      | [http://localhost:5099/SubmissionGatewayRPC](http://localhost:5099/SubmissionGatewayRPC) |
| **User**     | Practice ID (e.g., 6-digit number)                                                       |
| **Password** | Healthlink Connection password                                                           |

:::hint{type="danger"}
**Note**

The eSpecial Authority Practice ID code is provided by the Ministry of Health. Please contact the Ministry of Health at onlinehelpdesk\@moh.govt.nz or phone 0800 505 125 option 5 for more information.
:::

The **Location** panel contains the directories for storing sent and received eSpecial Authority messages. The Location information in the screenshot is an example only. Browse to your folders to set values (typically in the Healthlink folders).

4. Press **OK** to save the information and close the window.
5. Go to **Organisation/People & Places** and double-click the Organisation in the **Organisational Structure** panel. This opens the Organisation window.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/9LNEOUSlntN30ON33XLJj_htk58rfm8-vtjisnup6gm8ndtvcc-ekkyw.png" size="100" isUploading="false" initialPath="assets/hTK58RFm8-vTjisnup6gm8NDTvcc-EkkYw.png" githubPath="en/Medication Management/Prescriptions - New Zealand/assets/hTK58RFm8-vTjisnup6gm8NDTvcc-EkkYw.png" position="flex-start" showCaption="false" indent="2"}

6. Select the **Registry** view.
7. Double-click the **eSpecial Authority ID** key to open its Registry Edit window.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/PQaYFoo3HPZEDIzJaOzTI_h3ub8ajgp35tataunhp3d5kvirxszm9vg.png" size="100" isUploading="false" initialPath="assets/H3ub8A_JGp35TaTaUnHP3d5KvIrxSZM9vg.png" githubPath="en/Medication Management/Prescriptions - New Zealand/assets/H3ub8A_JGp35TaTaUnHP3d5KvIrxSZM9vg.png" position="flex-start" showCaption="false" indent="2"}

8. Enter the ID value in the **Value** field and press **OK** to save the information and close the window.

:::hint{type="danger"}
**Note**

The eSpecial Authority Practice ID code is provided by the Ministry of Health. Please contact the Ministry of Health at onlinehelpdesk\@moh.govt.nz or phone 0800 505 125 option 5 for more information.
:::

9. Press **OK** to save the information and close the window.

***

## Attachments

::File{src="https://api.qa.archbee.co/api/presign/zICxj0dnLereb6UUrBA3-/GX7VMBY_HSPoBn2IO-Hlz_6000237250-especial-authority-configuration-v2.pdf" label="eSpecial Authority Configuration V2.pdf" initialPath="../../../attachments-export/6000237250-eSpecial%20Authority%20Configuration%20V2.pdf" githubPath="attachments-export/6000237250-eSpecial Authority Configuration V2.pdf"}