Downloads

Documents and files

Circulars, templates, spreadsheets, sample bundles and other files published by the programme, in one place. The HCX DevTools builds themselves are on the DevTools page.

Specifications

The NHCX specifications as published by the National Health Authority on nhcx.abdm.gov.in.

FileTypeSizeUpdatedDownload
Implementation guideThe open protocol: message envelope, API pattern, authentication and the onward and return journey of every use case.Web pageDownload
Domain data modelsThe HL7 FHIR R4 bundles for coverage eligibility, pre-authorisation, claim, payment notice and communication.Web pageDownload
TerminologiesICD-10, SNOMED CT and the national code directories used for coded values.Web pageDownload
Transport securityTLS, JWS-signed API keys and JWE-encrypted payloads between participants and the exchange.Web pageDownload

Policies and guidelines

FileTypeSizeUpdatedDownload
Guidelines for participant onboardingWho can join, the documents required, sandbox certification and the production onboarding steps.Web pageDownload
Guidelines for beneficiary authenticationHow providers and payers authenticate a beneficiary through ABHA.Web pageDownload
Guidelines for grievance redressalWeb pageDownload
Health care operation policyWeb pageDownload
ABDM website policyWeb pageDownload
ABDM terms and conditionsWeb pageDownload

Sandbox and developer resources

FileTypeSizeUpdatedDownload
ABDM sandbox registrationRegister your organisation on the ABDM sandbox — the first step before NHCX integration.Web pageDownload
ABDM sandbox — getting startedWeb pageDownload
Milestone M1 (ABHA) integrationBeneficiary authentication through ABHA — needed for production, not for sandbox testing.Web pageDownload
Postman collectionsReady-made requests for the sandbox APIs.Web pageDownload
Sandbox test casesThe functional test cases to clear for sandbox certification.Web pageDownload
HCX sandbox documents and SwaggerAPI documentation for the claim, pre-auth, coverage-eligibility, communication and participant services.Web pageDownload
NHA-ABDM on GitHubReference implementations and sample code from the National Health Authority.RepositoryDownload
ABDM sandbox webinarsWeb pageDownload