Changelog
What changed in the HIE documentation and the APIs it describes — newest first. Each entry links to the page or reference section that covers it in full.
Entries are dated by the day the change reached this site, not the day it was written.
14 Aug 2026
Status callbacks replace polling for claim, preauth and authorization updates
eClaims ConsentRegister an endpoint and an operation against it, and the HIE posts every state change to you as it happens — with a documented payload and worked samples for all three entity types. Setting up status callbacks
The eligibility endpoints now document what they return
eClaimsBenefits, sub-benefits and intervention coverage each gained a worked sample response and a
field-by-field table, including the accessPoint value that decides whether a sub-benefit applies to
the visit type in front of you.
Intervention Coverage
The EMT claim endpoint has been withdrawn
eClaimsCreate emergency claims through POST /claims/emergency instead, and resend doctor consent with the
emergency request shape.
Create Emergency Claim
11 Aug 2026
Query a patient's clinical record with FHIR searches
SHRGET /shr/Observation and GET /shr/ServiceRequest return searchset bundles with a stable
pagination token, so you can ask for observations or referrals instead of pulling whole resource
types.
Shared Health Record reference
Consent works for a patient who cannot give it, and for a minor
SHRSend emergency with an incapacity_reason and the consent is approved at once; send
representative_cr_id with a relationship and it routes to the representative instead.
Introduction to the Shared Health Record
A refusal can be recorded, and closing a visit is normally a two-step
SHRVerifying a consent accepts a decision and a rejection reason, so a declined consent settles with an audit trail rather than sitting as pending; a visit close usually returns a one-time password record and ends only once that is verified.
Bundle submission is asynchronous, and the security labels are published as a catalogue
SHRA success response means your bundle was accepted and queued rather than stored, so confirm the
resources afterwards; GET /shr/security-labels lists every confidentiality and sensitivity code the
record recognises.
Scenario and guide links point at reference pages that still exist
The walkthroughs had accumulated links to operations that earlier syncs renamed or retired, and every one was repointed. Common scenarios
7 Aug 2026
A minor can consent with their own fingerprint
ConsentPrints are enrolled at the point of care one finger at a time, then a capture dispatched to a workstation returns a match you pass to start a visit or authorize a claim. Minors Biometrics Consent
The six SHA special benefit rule sets are published as guides
eClaimsMaternity, medical imaging, surgical, critical care, inpatient and substance-abuse rehabilitation each get a page covering the global periods, case rates and thresholds that govern them. Special Benefit Rules
Clinical review is the payer's step, not the HIE's
eClaimsThe HIE helps you build a claim and transmits it; the payer reviews it, decides the outcome and moves the status, which you read back rather than being told at submission time. Preview Payer Claim
Document requirements and doctor authorization are read off the intervention
eClaimsBranch on the intervention's own fields — applicableDocumentTypes,
requiredPreauthDocumentTypes and needsDoctorAuthorization — because those are live data where a
guide page is not.
Adding Attachments
3 Aug 2026
Biometrics hardware guidance corrected
ConsentThe Hardware Server installer source and the ownership of biometrics agent accounts are now stated accurately. Biometrics integration
30 Jul 2026
The Shared Health Record is published as its own API
SHRNine /shr/* endpoints cover consent, the visit lifecycle and record submission, replacing the draft
/clinical/* FHIR endpoints, which have been retired.
Introduction to the Shared Health Record
Claim submission is four distinct request shapes, and a discharge can be partial
eClaimsPick the shape that matches what you are submitting — standard, identified emergency, unidentified emergency, or the finalisation of an earlier partial discharge — instead of one merged body that mixed fields never used together. Partial and full discharge
Choose which scheme to bill an authorized visit against
eClaimsPOST /authorizations/covers sets the effective coverage for a patient eligible under more than one
scheme.
Set Coverage
The generic file-upload endpoints are withdrawn, and authorization lookup moves to Consent
eClaims ConsentAttach files through the endpoint they belong to, such as POST /claims/attachments; looking up and
rejecting an authorization are documented under Consent Services now, at unchanged paths.
Reject Authorization
Corrections across the claims documentation
eClaimsDiagnosis coding is ICD-11 throughout, payer claim preview takes exactly one of its two identifiers and only after the claim has reached the payer, and every API operation now links to the process doc that explains it. Preview Payer Claim
15 Jul 2026
Check a facility's bed occupancy
eClaimsReturns the current occupancy summary per ward with operational status, alongside the other eligibility checks. Bed Occupancy
The benefit matrix is documented, and a preauthorization's diagnoses and doctors can be removed
eClaimsThe matrix guide explains how a benefit resolves to the interventions you can claim; two new process docs cover undoing a diagnosis or a doctor on a preauth. Benefit Matrix
13 Jul 2026
Every service's process docs were rewritten against the live payloads
eClaims Consent Registries TerminologyEligibility, billing, claim dispatch, preauthorization, consent, registry and terminology docs now match the fields the API actually accepts, with corrected diagrams and statuses. Claims introduction
The eligibility chain is documented end to end
eClaimsNew pages for sub-benefits coverage, patient utilization, POMSF balance and pre-visit authorization, and the overview now names which field of each response becomes the next call's parameter. Eligibility Process
Five new guides for the awkward parts of a claim
eClaims ConsentAdding attachments, adding a claim doctor, resubmitting a rejected claim, the deceased-patient workflow, and an in-depth biometrics integration walkthrough. Claim resubmission
The API reference shows worked examples and real enum values
Parameters and request bodies across every service were enriched, so a valid request can be read straight off the reference page.
30 Jun 2026
Emergency claims are documented
eClaimsNine process docs cover creating a claim for an identified or an unidentified patient, emergency protocols, adding and removing doctors, and submission. Emergency Process
Two ECCIF emergency walkthroughs
eClaimsEnd-to-end scenarios for an identified emergency patient and for one who arrives unidentified and is named later. ECCIF emergency, unidentified patient
22 Jun 2026
Every endpoint's reference URL changed
eClaims Consent SHR Registries Auth TerminologyThe specifications were re-baselined to basePath-relative paths, so a reference link you had
bookmarked as api_v1_claims_submit is now claims_submit.
API Catalog
Schema examples render across the whole reference
Every request and response example on the site became visible on this release; before it, they were present in the specifications but not shown.
POMSF tariffs can be resolved for your facility
eClaimsTwo endpoints evaluate POMSF rates for a facility and resolve bundle-aware tariffs for the interventions you name. PMF tariffs
Service-account integrations can scope a request to one facility
AuthFacility-consuming endpoints document the optional X-Facility-Id and X-Facility-Id-Type headers.
Facility identification
Adding a claim line documents its two shapes, and the attending doctor can be attached
eClaimsSend a single line item as JSON, or combined billing with diagnoses and attachments as multipart form data; supply the three practitioner identification fields together to record who attended. Combined billing details
Discharge OTP moved to Consent, and the next-of-kin endpoint was retired
eClaims ConsentSending a discharge one-time password now sits with the other OTP operation; patient contacts are
available from GET /patients/contacts instead.
Send Discharge OTP
18 May 2026
Reject a claim authorization with its consent token
ConsentReturns the reject outcome and the affected authorization record. Reject Authorization
Preauthorization cancellation moved to the plural path
eClaimsPOST /api/v1/preauth/cancel became POST /api/v1/preauths/cancel — update any client still calling
the singular URL.
Cancel Preauthorization
Response shapes changed on benefits, preauths and payer previews
eClaimsBenefits return the payload one level shallower, creating a preauthorization answers 200 rather than
201, the single-level tariff field is spelled kephLevelTarriff, and 403 Forbidden is documented
wherever a request can arrive without a valid tenant context.
Error handling
11 May 2026
The Terminology Service is back, with Clinical Concepts
TerminologySearch concepts inside a source such as WHO ICD-11, and fetch parent concepts together with their mapped children. Terminology Service
10 May 2026
The Shared Health Record reference was withdrawn pending re-specification
SHRIt returned on 30 July 2026 as the nine /shr/* endpoints.
30 Apr 2026
Six worked scenarios, from eligibility through to payment
eClaimsInpatient per-diem, inpatient and outpatient fee-for-service under both normal and elective preauthorization, and UHC outpatient capitation. Common scenarios
Start a visit or authorize a claim with OTP or with biometrics
eClaims ConsentBoth operations document the two consent strategies as separate request shapes rather than one body with mutually exclusive fields. Start Visit workflow
Biometric consent has a process doc
ConsentCovers fingerprint capture through a registered hardware agent and what to do when a capture fails. Biometrics Consent
Patient search accepts a Client Registry ID
RegistriesAdded as an identification type, and professional search gained a regulator filter. Patient Search
24 Apr 2026
The API reference is generated from the HIE Middleware specification
The hand-maintained legacy reference was retired, so the documented surface tracks the service that actually serves your calls. Reference URLs changed with it. API Catalog
17 Apr 2026
Claim and preauthorization document-type lists corrected
eClaimsSeveral preauthorization forms listed document types that did not apply to them. Normal Preauthorizations
10 Apr 2026
Authorizations, balances and sub-benefit coverage are documented
eClaimsAlong with switching an active intervention, reading a patient's contacts, and fund utilization for a beneficiary. Switch Intervention
A draft clinical-record and ePrescription surface was published
SHRBoth were early drafts; the clinical endpoints were replaced by the /shr/* API in July 2026.
6 Feb 2026
Shared Health Record and ePrescription operations appear in the reference
SHRDocumented ahead of the service being ready to integrate against.
4 Feb 2026
The reference points at the HIE Middleware APIs
The switch rolled back on 1 February was reapplied against a corrected server mapping, and this time it held. API Catalog
1 Feb 2026
The switch to the HIE Middleware reference was rolled back
For three days the reference returned to the legacy adapter APIs while the server mapping was corrected — so anything read here between 28 January and 1 February described the middleware surface, and anything read after it did not.
30 Jan 2026
One preauthorization endpoint serves all seven preauth types
eClaimsNormal, surgical, renal, oncology, optical, imaging and dental each get their own documented request shape on the same operation. Preauthorizations
28 Jan 2026
The reference was re-pointed from the legacy adapter to the HIE Middleware APIs
Rolled back four days later — see 1 February.
A user journey walkthrough, with diagrams
The homepage gained an end-to-end explanation of how eligibility, consent, billing and dispatch fit together. User journey
8 Jan 2026
Deep links into the docs stopped returning 403
Single-page-app routing was corrected, so a bookmarked or shared page now loads directly instead of only working when reached by navigation.
10 Dec 2025
Emergency claims get a process overview
eClaimsPublished alongside a rewrite of the benefit and intervention codes guide. Benefit and intervention codes
1 Dec 2025
Preauthorization statuses are explained
eClaimsWhat each status means, which are terminal, and which you can still act on. Understanding preauth statuses
27 Nov 2025
Guides for claims, preauthorizations and going live
eClaimsUnderstanding claims and their statuses, understanding preauthorizations, the benefit and intervention codes, the intervention combination rules, and a go-live checklist. Going live
5 Nov 2025
Request an OTP whitelist for a patient
ConsentFor a patient whose registered contact cannot receive a one-time password, with process docs for raising the request and reading its state. Create OTP Whitelist Request
The Terminology Service joins the API catalogue
TerminologySources, collections and concepts, for resolving clinical codes against a published code system. Terminology Service
Add or remove a doctor on an emergency claim, and what the consent token is for
eClaims ConsentTwo emergency-claim doctor operations were documented, and the consent token description now explains how it links a visit to the claim built against it. Add Emergency Doctor
24 Oct 2025
The docs are reorganised by service
Claims, Consent, Registries, Auth and Terminology each get their own getting-started, process and guides sections, with an API catalogue listing every service. Introduction
Authentication is documented
AuthThe OAuth flow, API keys, best practices and troubleshooting. OAuth flow
The national registries are documented
RegistriesPatient, facility and professional search. Registries Process
Emergency claim operations and POMSF balances
eClaimsCreating an emergency claim, fetching emergency protocols, and reading a beneficiary's POMSF balance. POMSF Balance
19 Sep 2025
The billing lifecycle is documented
eClaimsPreviewing a claim, removing a line, a diagnosis or an attachment, and the discharge operations. Billing Process
Preauthorization operations are documented
eClaimsCancelling, previewing, requesting doctor consent, switching an intervention, and the specialised preauthorization types. Preauthorizations
20 Aug 2025
Preauthorizations, claim attachments and error responses are documented
eClaimsWith response examples and corrected request payload schemas.
13 Aug 2025
The HIE documentation site goes live
Process guides for eligibility, interventions, preauthorizations, billing and claim dispatch, alongside a generated API reference. Introduction
A changelog records deltas. For the current shape of any request or response, read the API Catalog — it is generated from the specification the services run on and is always authoritative over an entry here.