Skip to main content

Preauthorisation request

The first bundle with clinical content. The provider asks the payer to approve a treatment before it is given. The spine is a Claim with use set to preauthorization.

Sent on /v1/preauth/submit, answered on /v1/preauth/on_submit, workflow 12 new, 121 resubmission.

The bundle

#ResourceProfile
1ClaimClaim
2PatientPatient
3Organization (prov)Organization
4Organization (pay)Organization
5CoverageCoverage
6PractitionerPractitioner
7ProcedureProcedure
8QuestionnaireResponseQuestionnaireResponse, which NRCeS does not publish; base FHIR QuestionnaireResponse

Elements

1. Claim

NRCeS profile: Claim.

ElementExample
identifier[]system https://nhcx.abdm.gov.in, value NM-26-0SE00002M
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
usepreauthorization
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:57+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 9 more
supportingInfo[].category.coding[]INV Document Type - Investigation 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
OTH Other in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-supportinginfo-category
and 1 more
supportingInfo[].code.coding[]POI Proof of Identity (Aadhaar / Passport / Voter ID) in https://nhcx.abdm.gov.in/document-code
CER Medical Certificate / Doctor Referral in https://nhcx.abdm.gov.in/document-code
RAD Radiology / X-Ray / CT / MRI Scan Reports in https://nhcx.abdm.gov.in/document-code
and 9 more
supportingInfo[].valueAttachmentcontentType application/pdf, title Proof of Identity (Aadhaar / Passport / Voter ID)
contentType application/pdf, title Medical Certificate / Doctor Referral
contentType application/pdf, title Radiology / X-Ray / CT / MRI Scan Reports
and 6 more
supportingInfo[].valueReferencereference https://nhcx.abdm.gov.in/questionnaireresponse/1, display Total Knee Replacement (Unilateral), Standard Treatment Guidelines
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
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, 11, 12
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
statuspreparation
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

8. QuestionnaireResponse

ElementExample
questionnaire<participant-defined>
statuscompleted
subjectreference https://nhcx.abdm.gov.in/patient
authored2026-09-10T23:53:57+05:30
item[]linkId PROC-KNEE-01/stg/1, text Duration of symptoms and the conservative treatment tried (months of physiother…
linkId PROC-KNEE-01/stg/2, text Kellgren-Lawrence grade of osteoarthritis on the standing X-ray
linkId PROC-KNEE-01/stg/3, text Range of motion and deformity of the knee (flexion contracture, varus/valgus)
and 2 more
item[].answer[]valueString Recorded.

Rules

1. The case number

Claim.identifier, typed CLN, carries the provider's case number. Every later message on the case, the payer's included, names it.

2. One focal insurance

Exactly one Claim.insurance[] entry carries focal: true.

3. Items

Each item links to the care team, diagnosis and procedure by sequence. net is unitPrice times quantity; do not compute with factor. Claim.total equals the sum of the item nets.

4. Documents

The mandatory document codes are the ones the auth-requirements answer returned. Send each code and display exactly as given.

5. The STG answers

Each package's STG questionnaire is answered as a QuestionnaireResponse in the bundle, with the linkIds the plan gives.

6. Claim.type

SNOMED 737481003, Inpatient care management. Payers echo it, some under the ndhm-claim-type ValueSet URL.

7. References to records

A valueReference may point at the Composition heading an embedded record rather than at a DocumentReference. Follow the reference, then walk the record.

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 1 QuestionnaireResponse.

Elements PMJAY adds

ElementExample
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
QuestionnaireResponse.item[].answer[].valueAttachmentcontentType application/pdf, title Medical Superintendent Declaration Form (During Admission)

What PMJAY specifies

  • item.programCode carries AB-PMJAY under ndhm-program-code.
  • item.modifier carries the ward tier from the master's stratification codes, and item.category the master's specialty code.
  • The Authentication Consent answer is a second QuestionnaireResponse beside the STG answers, with its attachments as valueAttachment and its dates as valueDateTime.
  • Document codes are the MAND codes the auth-requirements answer returned.

What PMJAY requires

  • The biometric user token on the request, or the plan's Authentication Consent questionnaire answered as a QuestionnaireResponse. Refused with PAYR-1256 otherwise.
  • The STG questionnaire answered for every package that needs one. Refused with PAYR-1254 otherwise.
  • Not more than one day before admission, with the registration and admission dates as supporting information.
  • One live preauthorisation per beneficiary per hospital. Refused with PAYR-1238 while another is open.
  • LM100 is not allowed on a preauthorisation. Refused with PAYR-1270.
  • Auto-approval only when this is the first preauthorisation on the case and every package carries ApprovalNotRequired Y.

Use cases, APIs and data elements

B3 Submit pre-authorisation (provider)

Permission to treat. A resubmission, an enhancement and a query answer all reuse the same bundle with a new correlation id and the original reference; only the workflow code tells them apart. The acknowledgement on 20 brings the payer's own case number, and the desk files everything under it.

API/v1/preauth/submit apis/03-preauth/v1-preauth-submit.bru
Callback/v1/preauth/on_submit apis/03-preauth/v1-preauth-on-submit.bru
Workflow12 new, 121 resubmission, 13 enhancement; under PMJAY 19 answers a query and 131 an enhancement query
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_id12
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890
x-hcx-use_caseNew

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
12Preauth Request Initiatedproviderrequest.initiatedNew preauth submission
121Preauth Request Resubmittedproviderrequest.initiatedResubmission after query/rejection
13Enhancement Request Initiatedproviderrequest.initiatedEnhancement (additional amount) request
19Preauth Query Response Submittedproviderresponse.completeResponse to payer's query on preauth
131Enhancement Query Response Submittedproviderresponse.partial, response.error, response.completeResponse to enhancement query

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
claimNumberPre-auth Case NumberCasestring1..1Claim.identifier[0].valuePA20260226001also at Bundle.id
useClaim UseCasecode1..1Claim.usepreauthorization
preAuthRefApproval Reference (if enhancement)Casestring0..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
estimatedTotalEstimated Package AmountBillingdecimal1..1Claim.total.value15500.00

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

D4 Submit pre-authorisation (pmjay)

Not more than one day before admission, with the biometric token or the consent response, the documents the auth-requirements answer asked for, the STG questionnaire for each package, and the registration and admission dates as supporting info. Auto-approved only if it is the first pre-authorisation for the case and every package allows it.

API/v1/preauth/submit apis/03-preauth/v1-preauth-submit.bru
Callback/v1/preauth/on_submit apis/03-preauth/v1-preauth-on-submit.bru
Workflow12
Carries JWEyes
Focal resourceClaim
Simulator console/builder?family=preauth&usecase=initiate

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_id12
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890
x-hcx-use_caseNew

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
12Preauth Request Initiatedproviderrequest.initiatedNew preauth submission

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
claimNumberPMJAY Case NumberCasestring1..1Claim.identifier[0].valueVB26AA2600001
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
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
patientPhotoPatient Photo on Bed (POI)Documentsbase64Binary1..1Claim.supportingInfo[category=POI].valueAttachment.dataJVBERi0xLjQK...

NRCeS profiles: Claim, Patient, Organization, Practitioner.

D5 Resubmit pre-authorisation (pmjay)

Revises an approved or rejected case for a different amount or package. Nullifies every earlier instance; the payer treats it as the new base request.

API/v1/preauth/submit apis/03-preauth/v1-preauth-submit.bru
Callback/v1/preauth/on_submit apis/03-preauth/v1-preauth-on-submit.bru
Workflow121
Carries JWEyes
Focal resourceClaim
Simulator console/builder?family=preauth&usecase=resubmit

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_id121
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890
x-hcx-use_caseResubmit

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
121Preauth Request Resubmittedproviderrequest.initiatedResubmission after query/rejection

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
claimNumberExisting Case NumberCasestring1..1Claim.identifier[0].valueVB26AA2600001
workflowIdWorkflow CodeHeaderstring1..1Header.x-hcx-workflow_id121

NRCeS profiles: Claim.