Aotearoa National Health Index Input

AotearoaNationalHealthIndexInput is a headless input for entering New Zealand's National Health Index (NHI) Number, New Zealand's government-issued personal identifier. It renders as <input type="text"> with autocomplete="off" to protect sensitive identifiers. It is the editable companion to AotearoaNationalHealthIndexView.

Status: beta — implemented and unit-tested in all seven frameworks; not yet exercised in a composed flow.

Implementation Notes

• Renders as <input type="text">
• Format: Seven-character identifier (three letters, four digits). The legacy AAANNNC format uses a Modulus-11 check digit over the six preceding characters; an expanded AAANNAX format (issued from July 2026) uses a Modulus-23 check digit instead, to extend the identifier space.
• autocomplete="off" to protect sensitive identifiers
• Supports two-way binding on the value prop
• Companion to AotearoaNationalHealthIndexView

Props

• label: string (required) — accessible label via aria-label
• value: string (default: "") — bindable input value
• required: boolean (default: false) — form validation
• disabled: boolean (default: false) — disabled state
• ...restProps: any — additional HTML attributes spread onto the <input>

Usage

<Field label="National Health Index (NHI) Number" required>
  <AotearoaNationalHealthIndexInput label="National Health Index (NHI) Number" value={value} required />
  <Hint>Seven-character identifier (three letters, four digits). The legacy AAANNNC format uses a Modulus-11 check digit over the six preceding characters; an expanded AAANNAX format (issued from July 2026) uses a Modulus-23 check digit instead, to extend the identifier space.</Hint>
  <ErrorMessage>Please enter a valid National Health Index</ErrorMessage>
</Field>

ARIA

• aria-label={label} — provides accessible name

When to Use

• Use in forms collecting New Zealand's National Health Index (NHI) Number.
• Use in administrative or national-id workflows where the identifier is required.

When Not to Use

• Do not use for displaying read-only identifiers — use aotearoa-national-health-index-view instead.
• Do not use for general text input — use text-input instead.
• Do not use for other countries' identifiers — use the corresponding country-specific input.

Headless

This headless component ships zero CSS. The consumer provides all styling targeting the .aotearoa-national-health-index-input class hook.

Testing

• Verify renders an <input> with the correct class and type="text"
• Verify aria-label is set from the label prop
• Verify autocomplete="off"
• Verify value binding works

Domain Knowledge

Seven-character identifier (three letters, four digits). The legacy AAANNNC format uses a Modulus-11 check digit over the six preceding characters; an expanded AAANNAX format (issued from July 2026) uses a Modulus-23 check digit instead, to extend the identifier space.

Where to find it: Printed on prescriptions, hospital and GP correspondence, and visible in patient portals such as Manage My Health.

Related components

• aotearoa-national-health-index-view — a read-only display of New Zealand's National Health Index (NHI) Number
• text-input — a single-line text input field <input type="text">

References

• Wikipedia: NHI Number

Lily™ and Lily Design System™ are trademarks.