LinksSpecifications, policies and guides
Everything the programme publishes about NHCX, in one place: the open specification and its data models, the policies and guidelines that govern participation, and the guides for getting onto the sandbox.
Specifications
The NHCX specifications as published by the National Health Authority on nhcx.abdm.gov.in.
- Implementation guideThe open protocol: message envelope, API pattern, authentication and the onward and return journey of every use case.Web page
- Domain data modelsThe HL7 FHIR R4 bundles for coverage eligibility, pre-authorisation, claim, payment notice and communication.Web page
- TerminologiesICD-10, SNOMED CT and the national code directories used for coded values.Web page
- Transport securityTLS, JWS-signed API keys and JWE-encrypted payloads between participants and the exchange.Web page
Policies and guidelines
- Guidelines for participant onboardingWho can join, the documents required, sandbox certification and the production onboarding steps.Web page
- Guidelines for beneficiary authenticationHow providers and payers authenticate a beneficiary through ABHA.Web page
- Guidelines for grievance redressalWeb page
- Health care operation policyWeb page
- ABDM website policyWeb page
- ABDM terms and conditionsWeb page
Sandbox and developer resources
- ABDM sandbox registrationRegister your organisation on the ABDM sandbox: the first step before NHCX integration.Web page
- ABDM sandbox: getting startedWeb page
- Milestone M1 (ABHA) integrationBeneficiary authentication through ABHA: needed for production, not for sandbox testing.Web page
- Postman collectionsReady-made requests for the sandbox APIs.Web page
- Sandbox test casesThe functional test cases to clear for sandbox certification.Web page
- HCX sandbox documents and SwaggerAPI documentation for the claim, pre-auth, coverage-eligibility, communication and participant services.Web page
- NHA-ABDM on GitHubReference implementations and sample code from the National Health Authority.Repository
- ABDM sandbox webinarsWeb page