Skip to main content

Claim request

The request for payment once treatment is done. The same Claim as the preauthorisation with use set to claim, carrying the finalised dates, bill and documents.

Sent on /v1/claim/submit, answered on /v1/claim/on_submit, workflow 15.

The bundle

#ResourceProfile
1ClaimClaim
2PatientPatient
3Organization (prov)Organization
4Organization (pay)Organization
5CoverageCoverage
6PractitionerPractitioner
7ProcedureProcedure

Elements

1. Claim

NRCeS profile: Claim.

ElementExample
identifier[]system https://nhcx.abdm.gov.in, value NM-26-0SE00002L
identifier[].type.coding[]CLN Claim number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
statusactive
type.coding[]737481003 Inpatient care management (procedure) in http://snomed.info/sct
useclaim
patientreference https://nhcx.abdm.gov.in/patient
billablePeriodstart 2026-09-10T00:00:00+05:30, end 2026-09-10T00:00:00+05:30
created2026-09-10T23:53:21+05:30
insurerreference https://nhcx.abdm.gov.in/payer
providerreference https://nhcx.abdm.gov.in/provider
priority.coding[]normal Normal in http://terminology.hl7.org/CodeSystem/processpriority
careTeam[]sequence 1
careTeam[].providerreference https://nhcx.abdm.gov.in/practitioner
careTeam[].role.coding[]primary Primary provider in http://terminology.hl7.org/CodeSystem/claimcareteamrole
careTeam[].qualification.coding[]394802001 General medicine in http://snomed.info/sct
supportingInfo[]id SupportingInformation/1, sequence 1
id SupportingInformation/2, sequence 2
id SupportingInformation/3, sequence 3
and 7 more
supportingInfo[].category.coding[]INV Document Type - Investigation in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-supportinginfo-category
HDS Hospital discharge summary in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-supportinginfo-category
ONS Period, start or end dates of aspects of the Condition. (e.g. admission, discha… in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-supportinginfo-category
and 2 more
supportingInfo[].code.coding[]MB Medical & Pharmacy Bills Itemized in https://nhcx.abdm.gov.in/document-code
IMP Medical Implant Invoice & Barcode Sticker in https://nhcx.abdm.gov.in/document-code
FCF Filled NHCX Claim Form (Signed) in https://nhcx.abdm.gov.in/document-code
and 7 more
supportingInfo[].valueAttachmentcontentType application/pdf, title Medical & Pharmacy Bills Itemized
contentType application/pdf, title Medical Implant Invoice & Barcode Sticker
contentType application/pdf, title Filled NHCX Claim Form (Signed)
and 2 more
diagnosis[]sequence 1
diagnosis[].diagnosisCodeableConcept.coding[]E11.9 Type 2 diabetes mellitus without complications in http://hl7.org/fhir/sid/icd-10
diagnosis[].type[].coding[]admitting Admitting Diagnosis in http://terminology.hl7.org/CodeSystem/ex-diagnosistype
diagnosis[].onAdmission.coding[]yes Yes in http://terminology.hl7.org/CodeSystem/ex-diagnosis-on-admission
procedure[]id Procedure/1, sequence 1, date 2026-09-10T00:00:00+05:30
procedure[].type[].coding[]surgical Surgical in https://nhcx.abdm.gov.in/procedure-type
procedure[].procedureReferencereference https://nhcx.abdm.gov.in/procedure/1, display Total Knee Replacement (Unilateral)
insurance[]sequence 1, focal true, preAuthRef CL/26/0SE000107
insurance[].coveragereference https://nhcx.abdm.gov.in/coverage
item[]id Item/1, sequence 1, factor 1, careTeamSequence 1, diagnosisSequence 1, procedureSequence 1, informationSequence 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
item[].productOrService.coding[]PROC-KNEE-01 Total Knee Replacement (Unilateral) in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-procedure-code
item[].servicedPeriodstart 2026-09-10, end 2026-09-10
item[].quantityvalue 1
item[].unitPricevalue 150000, currency INR
item[].netvalue 150000, currency INR
item[].category.coding[]Surgical Surgical in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-benefit-category
totalvalue 150000, currency INR

2. Patient

NRCeS profile: Patient.

ElementExample
identifier[]value MRAV1985001
value 91-1234-1234-1234
identifier[].type.coding[]PMJAY Pradhan Mantri Jan Aarogya Yojana (PMJAY) ID in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
ABHA Ayushman Bharat Health Account (ABHA) ID in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
MB Member Number in http://terminology.hl7.org/CodeSystem/v2-0203
name[]text <patient name>
telecom[]system phone, value 9876543210
gendermale
birthDate1985-06-15

3. Organization (prov)

NRCeS profile: Organization.

ElementExample
identifier[]system https://nhcx.abdm.gov.in, value IN1910000151
identifier[].type.coding[]NPI National provider identifier in http://terminology.hl7.org/CodeSystem/v2-0203
type[].coding[]prov Healthcare Provider in http://terminology.hl7.org/CodeSystem/organization-type
nameKyroCare Multispeciality Hospital

4. Organization (pay)

NRCeS profile: Organization.

ElementExample
identifier[]system https://nhcx.abdm.gov.in, value 1000004805
identifier[].type.coding[]NIIP National Insurance Payor Identifier (Payor) in http://terminology.hl7.org/CodeSystem/v2-0203
type[].coding[]pay Payer in http://terminology.hl7.org/CodeSystem/organization-type
nameSandbox Payer

5. Coverage

NRCeS profile: Coverage.

ElementExample
identifier[]value POL7UMU001
identifier[].type.coding[]NH National Health Plan Identifier in http://terminology.hl7.org/CodeSystem/v2-0203
statusactive
type.coding[]HIP health insurance plan policy in http://terminology.hl7.org/CodeSystem/v3-ActCode
subscriberreference https://nhcx.abdm.gov.in/patient
subscriberIdMRAV1985001
beneficiaryreference https://nhcx.abdm.gov.in/patient
relationship.coding[]self in http://terminology.hl7.org/CodeSystem/subscriber-relationship
payor[]reference https://nhcx.abdm.gov.in/payer

6. Practitioner

NRCeS profile: Practitioner.

ElementExample
identifier[]system https://nhcx.abdm.gov.in, value 71-8422-5818-7201
system https://hpr.abdm.gov.in, value 71-8422-5818-7201
identifier[].type.coding[]HPID Healthcare Professional ID (HPID) in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
HPIN Health Practitioner ID issued by NDHM in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
name[]text Dr. Ananya Rao
qualification[].code.coding[]MD Doctor of Medicine in http://terminology.hl7.org/CodeSystem/v2-0360

7. Procedure

NRCeS profile: Procedure.

ElementExample
statuscompleted
codetext Total Knee Replacement (Unilateral)
code.coding[]71388002 Procedure (procedure) in http://snomed.info/sct
subjectreference https://nhcx.abdm.gov.in/patient
performedDateTime2026-09-10T00:00:00+05:30

Rules

1. What a claim adds

The final bill under MB and the discharge summary under HDS, with the implant invoice, the operation notes and the signed claim form where the plan asks for them.

2. The stay

billablePeriod carries the admission and the discharge.

3. Sequences may have gaps

Map supporting information by sequence and resolve item.informationSequence through the map.

4. The amount

May not exceed what the preauthorisation approved.

5. Cyclic treatment

One supporting-info entry per cycle, with timingPeriod, listed in the item's informationSequence, its record referenced from valueReference.

6. Newborn

The parent stays the primary Patient; the child is a second Patient linked with link.type refer, with gender and birth date, and a proof of birth under category DOB, code BCF or DCB.

PMJAY

The generic bundle above is what every payer takes, IRDAI-regulated insurers and TPAs included. PMJAY takes it with the changes and requirements below.

What changes in the bundle

Resources

  • PMJAY adds 4 QuestionnaireResponse.
QuestionnaireResponse
ElementExample
questionnairehttps://payer.gov.in/policy/questionnaire/100025
statuscompleted
subjectreference https://nhcx.abdm.gov.in/patient
authored2026-09-11T00:25:00+05:30
item[]linkId 100011, text Death Stage
linkId 100098, text Death Date
linkId 100099, text Death Certificate
and 2 more
item[].answer[]valueString Before Surgery/Treatment
valueDateTime 2026-09-10T18:54:00+05:30
item[].answer[].valueAttachmentcontentType application/pdf, title Death Certificate
contentType application/pdf, title Clinical Note/Death Summary
contentType application/pdf, title Mortality audit report

Elements PMJAY adds

ElementExample
Claim.supportingInfo[].valueReferencereference https://nhcx.abdm.gov.in/questionnaireresponse/1, display Death
reference https://nhcx.abdm.gov.in/questionnaireresponse/2, display Discharge Consent
reference https://nhcx.abdm.gov.in/questionnaireresponse/3, display Discharge Information
and 1 more
Claim.item[].modifier[].coding[]STRAT006a Routine Ward
Claim.item[].programCode[].coding[]AB-PMJAY Ayushman Bharat Pradhan Mantri Jan Arogya Yojana (AB-PMJAY) in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-program-code

What PMJAY specifies

  • Dates ride as supporting information: the stay under category ONS, code ADDD, the encounter under OTH, code EDT, and the surgery under code PSP, each as a valueString in +05:30.
  • Discharge types DTH, DTM, LAMA and DAMA under category DIS, with the stage, before, during or after surgery, as the valueString.
  • LAMA or DAMA before or during surgery voids the approved packages: one item LM100, quantity the days admitted, capped by the package's los. After surgery the package stays billable.
  • A death records its date under category ONS, code DTM.
  • The discharge consent and the other policy questionnaires ride as QuestionnaireResponse resources, each referenced from a supportingInfo entry.

What PMJAY requires

  • Send the claim under the preauthorisation's own number. Refused with ERR-PYR-CLM-007 otherwise.
  • The discharge status under DIS and the admission and discharge dates. The claim is refused without them.
  • Bill the package alone, at the whole amount. Room rent, consultations and investigations are not items.
  • A fresh biometric token at discharge, or the plan's Discharge Consent questionnaire answered. Refused with PAYR-1363 otherwise.
  • LM100 as the single procedure on LAMA or DAMA before or during surgery (PAYR-1362), and the death date under ONS / DTM (PAYR-1096).
  • Each cycle's timingPeriod matches the biometric capture for that cycle.

Use cases, APIs and data elements

B5 Submit claim (provider)

Reimbursement after discharge. The amount may not exceed what the pre-authorisation approved. The acknowledgement on 25 brings the payer's case number. PMJAY takes a claim query answer on 161 only; 151, 19 and 16 are refused with PAYR-1321.

API/v1/claim/submit apis/05-claim/v1-claim-submit.bru
Callback/v1/claim/on_submit apis/05-claim/v1-claim-on-submit.bru
Workflow15 claim, 161 query answer under PMJAY, 14 provisional discharge where a payer supports one
Carries JWEyes
Focal resourceClaim

Request headers

HeaderExample value
x-hcx-sender_code1000004446@hcx
x-hcx-recipient_code1518@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id15
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890
x-hcx-use_caseNew

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
15Claim Request Initiatedproviderrequest.initiatedFinal claim submission
161Claim Doc Query Responsestatus sheet onlyresponse.complete
14Discharge Submittedproviderrequest.initiatedDischarge summary submitted
151Claim Query Response Submittedproviderresponse.completeResponse to claim query, as published; the PMJAY sandbox refuses it with PAYR-1321 and takes 161 (Claim Doc Query Response)

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
claimNumberFinal Claim NumberCasestring1..1Claim.identifier[0].valueCL0000000001also at Bundle.id
useClaim UseCasecode1..1Claim.useclaim
preAuthRefApproved Pre-auth ReferenceCasestring1..1Claim.insurance[0].preAuthRef[0]APPR-2026-HP-00891
patientNamePatient Full NameBeneficiarystring1..1Patient.name[0].textRamesh Chandra Sharma
memberIdScheme / Insurer Member IDBeneficiarystring1..1Patient.identifier[type=PMJAY].valuePMJAY-HP-2024-998811also at Coverage.subscriberId
abhaNumberABHA NumberBeneficiarystring0..1Patient.identifier[type=ABHA].value91234567890123
genderGenderBeneficiarycode1..1Patient.gendermalecode system http://hl7.org/fhir/administrative-gender
birthDateDate of BirthBeneficiarydate1..1Patient.birthDate1982-06-15
patientPhoneMobile PhoneBeneficiarystring0..1Patient.telecom[system=phone].value9876543210
policyNumberPolicy NumberCoveragestring1..1Coverage.identifier[0].valuePMJAY/HP/S/G
facilityIdHospital Facility ID (HFR/NPI)Providerstring1..1Organization[type=prov].identifier[system=https://facility.abdm.gov.in].valueIN1910000151
providerNameHospital NameProviderstring1..1Organization[type=prov].nameApex Multispeciality Hospital
payerIdPayer Identifier (NIIP)Payerstring1..1Organization[type=pay].identifier[system=https://irdai.gov.in].value1000003538
payerNamePayer NamePayerstring1..1Organization[type=pay].nameNational Health Authority - PMJAY
practitionerIdPractitioner ID (HPID/HPIN)Practitionerstring1..1Practitioner.identifier[system=https://hpr.abdm.gov.in].value21-8899-4455-6677
practitionerNameDoctor NamePractitionerstring1..1Practitioner.name[0].textDr. Arvind Kumar
admissionDateAdmission DateStaydateTime1..1Claim.billablePeriod.start2026-02-26T10:00:00+05:30
dischargeDateDischarge DateStaydateTime1..1Claim.billablePeriod.end2026-03-02T14:30:00+05:30
careSettingCare SettingStaycode1..1Claim.type.coding[0].codeinstitutionalcode system http://terminology.hl7.org/CodeSystem/claim-type
primaryDiagnosisCodePrimary Diagnosis (ICD-10)Clinicalstring1..1Claim.diagnosis[0].diagnosisCodeableConcept.coding[0].codeA97.0code system http://hl7.org/fhir/sid/icd-10
procedureCodePackage / Procedure CodeClinicalstring1..1Claim.procedure[0].procedureCodeableConcept.coding[0].codeMG004A
finalBilledAmountTotal Claim AmountBillingdecimal1..1Claim.total.value15500.00

NRCeS profiles: Claim, Patient, Coverage, Organization, Practitioner.

D9 Submit claim (pmjay)

There is no discharge submission: the claim asserts the discharge and carries its details. Four dates, the discharge type under category DIS with the stage as its value, a fresh biometric token, and LM100 as the single procedure in place of the approved items on a LAMA or DAMA discharge before or during surgery. The amount may not exceed what was approved.

API/v1/claim/submit apis/05-claim/v1-claim-submit.bru
Callback/v1/claim/on_submit apis/05-claim/v1-claim-on-submit.bru
Workflow15
Carries JWEyes
Focal resourceClaim
Simulator console/builder?family=claim&usecase=submit

Request headers

HeaderExample value
x-hcx-sender_code1000004446@hcx
x-hcx-recipient_code1518@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id15
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890
x-hcx-use_caseNew

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
15Claim Request Initiatedproviderrequest.initiatedFinal claim submission

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
claimNumberPMJAY Claim NumberCasestring1..1Claim.identifier[0].valueCL26AA2600001
dischargeSummaryHospital Discharge Summary (HDS)Documentsbase64Binary1..1Claim.supportingInfo[category=HDS].valueAttachment.dataJVBERi0xLjQK...
patientNamePatient Full NameBeneficiarystring1..1Patient.name[0].textRamesh Chandra Sharma
memberIdScheme / Insurer Member IDBeneficiarystring1..1Patient.identifier[type=PMJAY].valuePMJAY-HP-2024-998811also at Coverage.subscriberId
abhaNumberABHA NumberBeneficiarystring0..1Patient.identifier[type=ABHA].value91234567890123
genderGenderBeneficiarycode1..1Patient.gendermalecode system http://hl7.org/fhir/administrative-gender
birthDateDate of BirthBeneficiarydate1..1Patient.birthDate1982-06-15
patientPhoneMobile PhoneBeneficiarystring0..1Patient.telecom[system=phone].value9876543210
facilityIdHospital Facility ID (HFR/NPI)Providerstring1..1Organization[type=prov].identifier[system=https://facility.abdm.gov.in].valueIN1910000151
providerNameHospital NameProviderstring1..1Organization[type=prov].nameApex Multispeciality Hospital
payerIdPayer Identifier (NIIP)Payerstring1..1Organization[type=pay].identifier[system=https://irdai.gov.in].value1000003538
payerNamePayer NamePayerstring1..1Organization[type=pay].nameNational Health Authority - PMJAY
practitionerIdPractitioner ID (HPID/HPIN)Practitionerstring1..1Practitioner.identifier[system=https://hpr.abdm.gov.in].value21-8899-4455-6677
practitionerNameDoctor NamePractitionerstring1..1Practitioner.name[0].textDr. Arvind Kumar

NRCeS profiles: Claim, Patient, Organization, Practitioner.