Skip to main content
POST
Preview Claim Bundle (Full Request)

Authorizations

Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id
string

Eka User ID (OID)

X-Partner-Pt-Id
string

Partner User ID

X-Hip-Id
string

Partner HIP ID

Query Parameters

claim_id
integer

Optional. Applies the claim's catalogue to the items

Required range: x >= 0

Body

application/json
member_id
string
required
payer_id
string
required
abha_number
string
accident_info
object
admission_date
null | string<date-time>
api_call_id
string
auth_type
string

AuthType "consent" (default) sends the Authentication Consent Questionnaire response and OMITS the biometric X-Token; "biometric" sends UserToken as the X-Token.

bank_details
object
care_team_members
object[]

Index 0 → primary/responsible (e.g. operating surgeon) Index 1 → assisting role (e.g. anaesthesiologist)

claim_type
string
claimed_amount
number
clinical_notes
string
diagnosis
object[] | null
discharge_date
null | string<date-time>
discharge_stage
string

DIS valueString: "After surgery"(default) | "Before surgery" | "During surgery"

discharge_type
string

"home"(default) | "mortuary" | "lama" | "dama"

documents
object[]

Legacy document list (kept for backward compat; prefer SupportingDocs)

hfr_facility_id
string

HFR/registry id → provider Organization NPI

hospital_address
string
hospital_name
string
itemized_billing
object[]
patient_details
object
policy_number
string

Coverage.identifier.value

policy_period_end
string

"YYYY-MM-DD"

policy_period_start
string

"YYYY-MM-DD"

policy_scheme_name
string

Coverage.class.name e.g. "PM-JAY Health Insurance Scheme"

preauth_claim_number
string
preauth_number
string

preauth_number: PMJAY ref ("PMJAY/HP/S/...") → insurance[].preAuthRef[] preauth_claim_number: CLN UUID from parsed preauth → Claim.related[].claim.identifier api_call_id: x-hcx-api_call_id from preauth submission → reuse in claim to link sessions

procedure_codes
string[]
provider_id
string
questionnaire_answers
object[]

STG questionnaire responses carried over onto the claim (same shape as pre-auth). Each becomes a QuestionnaireResponse resource referenced from Claim.supportingInfo (category STG).

remarks
string
service_codes
string[]

fallback if no ItemizedBilling

subscriber_id
string
supporting_docs
object[]

Embedded as supportingInfo.valueAttachment (NDHM HDS/INV/ATT category codes).

user_token
string

Response

OK

{key}
any