Skip to content
Get Support
  • There are no suggestions because the search field is empty.

NABIDH Guide Part 3: Map Your Data for NABIDH

NABIDH expects a handful of details that Pabau does not store natively: an Emirates ID, a nationality, a DHA specialty for each service and a Sheryan licence number for each practitioner. If you record vitals or social and family history on your medical forms, NABIDH can receive those too. This guide covers the one-off mapping that connects those dots. Do it before you run the readiness check: it is what stands between you and validation failures.

This article is part of the NABIDH guide series:

How the Mapping tab works

Open your NABIDH connection (Data Hub > Data Sync > Manage) and go to 3. Mapping. Unlike other connectors, the NABIDH mapping is fixed by the DHA NABIDH HL7 v2.5.1 specification: you cannot re-route standard fields, and that is deliberate. Standard fields (name, date of birth, contact details and so on) are applied automatically. What you can edit are three kinds of row:

  • Rows marked Custom, which Pabau fills from your client custom fields (or, in the Appointments & visits group, from appointment custom fields).
  • The rows in the Vitals, Social history and Family history groups, which read the answer to a question on one of your medical forms.
  • The VIP flag row, which reads a client label.

The Mapping tab of a NABIDH connection with the Vitals, Social history and Family history groups and the VIP flag group marked

The mapping groups; the marked ones are covered in Steps 2 and 6

Each group shows a completion bar. The groups you see follow the triggers that are switched on: for example, the Prescriptions group disappears if you switch the Prescriptions trigger off (see Part 4).

Step 1: Bind The Client Custom Fields

Expand the Client group. Rows marked Custom need a Pabau client custom field selected in the left-hand dropdown. The client fields the connector can use:

  • Emirates ID (text): sent as PID.19. Required for every Dubai-resident patient.
  • Middle name (text): PID.5.3.
  • Marital status (dropdown): PID.16.
  • Religion (dropdown): PID.17.
  • Nationality (dropdown): PID.28.
  • Resident / tourist flag (dropdown: Resident / Tourist / Visitor / Non-resident): PID.31.
  • Insurance plan ID (text): IN1.2, in the Client insurance group.
  • Insurance payer code (DHA) (text): IN1.3, in the Client insurance group.
  • Insurance plan expiry (date): IN1.13, in the Client insurance group.
  • Deceased (yes/no): PID.30. If it isn’t bound, patients are reported as not deceased.

Client custom field rows on the NABIDH Mapping tab, including Emirates ID, Nationality and Resident / tourist flag

Bind each Custom row to a client custom field

If a field does not exist in your account yet, use Create new field directly from the mapping row: it creates the client custom field and binds it in one go. Fields whose names match the list above are suggested automatically.

NOTE: Accounts that signed up from the UAE have these client custom fields created automatically. Established accounts adding NABIDH later create them once here; after that they appear on every client card like any other custom field.

IMPORTANT: Emirates ID is the single most important binding. NABIDH requires it for every patient reported as a Dubai resident (a 784-prefixed, 15-digit number). A resident patient without one fails validation and their messages are not sent. Tourists are exempt: they are sent with the standard placeholder ID automatically.

NOTE: If the insurance plan ID and payer code aren’t bound, your patients’ insurance is left out of the messages NABIDH receives. Everything else is still sent.

Step 2: Bind Vitals, Social History and Family History

These groups read answers from your medical forms, so NABIDH receives the vitals and history your clinicians record:

  • Vitals: Blood pressure, systolic; Blood pressure, diastolic; Heart rate; Respiratory rate; Body temperature; Height; Weight.
  • Social history: Social habit, Social habit quantity, Social habit category.
  • Family history: Family member, Family history diagnosis.
  1. Expand the Vitals, Social history or Family history group.
  2. On each row, open the first dropdown (Choose a form…) and pick the medical form that records the value.
  3. In the second dropdown (Then choose a question…), pick the question on that form.

The Vitals mapping group with the form and question dropdowns on the first row marked

Pick the form, then the question that holds the value

Once a question is bound, the patient’s latest answers go with every Add patient and Update patient message. To also send them whenever a form is completed or updated, switch on the Form answers trigger (it is off by default) in Part 4 once your bindings are done.

IMPORTANT: A binding points to one form. If you rename or delete that form, or remove the question from it, re-pick the binding here and save. The Clinical form bindings item in the Review tab’s setup checklist lists any binding that needs it.

Once a form has bound questions, your team can see it. In Setup > Forms, the form carries a NABIDH mark (hover it: This form is linked with NABIDH). When a clinician fills the form in on the client card, each bound question carries the same mark (This response will be securely shared with NABIDH).

The Medical forms list in Setup with the NABIDH mark next to a linked form

Forms linked with NABIDH are marked in Setup

Step 3: Set The NABIDH Specialty On Your Services

Every visit message must carry a DHA hospital service code (the NAB008 code set, sent as PV1.10). Pabau reads it from the service the appointment was booked for. The quickest way to set it is on the connection’s 1. Settings tab, in the Your services card:

  1. Pick the NABIDH specialty for a service. It saves straight away.
  2. Optionally, type the service’s CPT code and click Save. Without one, the procedure line is left off the message but the visit still sends.
  3. To set many at once, tick the services, choose a specialty in Choose a specialty and click Apply to selected.

The Your services card with a specialty dropdown, a CPT code field and the bulk bar marked

Set specialties one by one or in bulk

The list starts with Only services booked in the last 90 days ticked; untick it to see every service. You can also set both codes on a single service: go to Setup > Services, edit the service, and use NABIDH specialty and NABIDH procedure code on the General tab. Both save immediately.

The NABIDH specialty dropdown on a service in Setup, Services

The NABIDH specialty on a single service

NOTE: Set the specialty on every service that patients book appointments for. A visit whose service has no NABIDH specialty is rejected until one is set.

Step 4: Record Your Practitioners’ Sheryan Licence Numbers

Visit messages also identify the attending clinician by their individual 8-digit DHA Sheryan licence (PV1.7). These live on the connection’s 1. Settings tab, in the Your team card:

  1. Open Staff Sheryan provider IDs. If the team field does not exist yet, click Set up team field: this creates a “Sheryan provider ID” team custom field, which also appears on each team member’s Personal Details page.
  2. Enter each practitioner’s 8-digit licence number.
  3. Click Save IDs.

The Staff Sheryan provider IDs list with a licence field, Save IDs and the fallback field marked

Each practitioner needs their own 8-digit licence

IMPORTANT: On Test and Production, every practitioner who takes appointments needs their own licence number: a visit booked with a practitioner who has none fails validation. The Fallback Sheryan provider ID below the list is only used while the connection’s environment is Dummy.

Step 5: Check Your Diagnostic Codeset

NABIDH accepts problem codes in ICD-10 or SNOMED only. Problems coded any other way, or typed as free text with no code, are left off the message. If your account’s default diagnostic codeset is something else, click Set ICD-10 as default: you’ll find it in the banner on the Client problems mapping group, and under Diagnosis codeset in the Your services card on the Settings tab.

Step 6: Choose Your VIP Label

Some patients, such as public figures, need their records kept confidential. NABIDH handles them through a VIP flag, which Pabau reads from a client label:

  1. Expand the VIP flag group and pick your VIP label on the VIP / restricted flag row.

The VIP flag mapping group with the client label dropdown marked

Any client carrying this label is treated as VIP

What happens next:

  • When a patient NABIDH already knows about is given the label, Pabau sends one message marking them as VIP. After that, nothing else is sent for that patient while the label stays on.
  • A patient who already has the label when they’re first added to Pabau is never sent at all.
  • If you remove the label, the patient’s future changes are sent again. Anything held back while they were VIP is not sent later.

NOTE: A patient’s consent to share (opting out of NABIDH) is managed by DHA directly, not in Pabau.

Step 7: Save Your Mapping

Mapping edits are staged, not applied instantly: the header shows an Unsaved changes pill. Go to 4. Review and press Save in the top right to publish them. Closing the connection without saving discards the staged changes after a confirmation prompt. Specialties, CPT codes and Sheryan licence numbers are the exception: they save as you set them.

TIP: With mapping done, decide exactly which events flow to NABIDH in Part 4: Choose which events are sent to NABIDH.

What's next?

Was this guide helpful? Let us know by voting below - your feedback helps us write clearer articles.

For more guides, browse the related articles below or use the search bar at the top of the page. You can also watch our video learning series, the Pabau Academy, or visit the Support page for additional help.