Skip to main content

Insurance plan request

One Task asking a payer for the plan behind a policy. There is no patient and no clinical content, because the plan belongs to the policy and the hospital, not to an admission. Sent once per policy and cached.

Sent on /v1/insuranceplan/request, answered on /v1/insuranceplan/on_request.

The bundle​

#ResourceProfile
1TaskTask

Elements​

Task​

NRCeS profile: Task.

ElementExample
statusrequested
intentorder
code.coding[]poll in http://terminology.hl7.org/CodeSystem/financialtaskcode
input[]valueString POL7UMU001
valueString IN1910000151
input[].type.coding[]policyNumber in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code
providerId in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code

Rules​

The Task code system​

poll under http://terminology.hl7.org/CodeSystem/financialtaskcode, not the older https://nhcx.abdm.gov.in/api.

Intent​

order. Some element tables say original-order; the bundle sends order.

Inputs​

valueString, typed policyNumber and providerId under ndhm-task-input-type-code. Both are required, one of each: the policy number and the hospital's HFR ID (facilityId in the data elements below). Together they narrow the answer to the packages this hospital is empanelled for.

No case yet​

No case exists, so the bundle carries no case number. The callback is the only link between request and answer.

Task codes differ by system across the exchange​

poll, cancel, reprocess, release and status in financialtaskcode; deliver in ndhm-task-codes; approve in http://hl7.org/fhir/CodeSystem/task-code. Switch on system and code together.

When to send it​

Once per policy, not per patient. Refresh on a policychange communication and on your own schedule.

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​

The PMJAY bundle has the same resources, elements and systems as the generic one.

What PMJAY specifies​

  • policyNumber is the beneficiary's own policy code from the policy lookup, of the form PMJAY/<state>/S/G.
  • providerId is the hospital's HFR ID, the same value as on its participant record.

What PMJAY requires​

  • A policy the hospital is not empanelled under is refused with PAYR-1401.
  • Refresh weekly per the FRD, or every fifteen days per the scenario sheet, and at once on renewal, amendment or a policychange communication.

Use cases, APIs and data elements​

B2 Request insurance plan (provider)​

A Task with code poll, keyed on policy number and provider id. The answer is the policy as a benefit structure: packages, rates, documents, questionnaires.

API/v1/insuranceplan/request apis/09-insurance-plan/v1-insuranceplan-request.bru
Callback/v1/insuranceplan/on_request apis/09-insurance-plan/v1-insuranceplan-on-request.bru
Carries JWEyes
Focal resourceTask

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

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskCodeTask CodeTaskcode1..1Task.code.coding[0].codepoll
policyNumberPolicy NumberTask Inputstring1..1Task.input[type=PolicyNumber].valueStringPMJAY/HP/S/G
facilityIdProvider HFR IDTask Inputstring1..1Task.input[type=ProviderId].valueStringIN1910000151

NRCeS profiles: Task.

D1 Fetch the insurance plan (pmjay)​

Keyed on provider id, policy code and participant id. The answer is the scheme configuration for this hospital: specialities, packages, rates, Claim-Condition flags, mandatory documents and questionnaires. Over twenty megabytes; store it queryable, version it, refresh weekly and on any policychange communication.

API/v1/insuranceplan/request apis/09-insurance-plan/v1-insuranceplan-request.bru
Callback/v1/insuranceplan/on_request apis/09-insurance-plan/v1-insuranceplan-on-request.bru
Carries JWEyes
Focal resourceTask

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

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskCodeTask CodeTaskcode1..1Task.code.coding[0].codepoll
schemeIdScheme Policy IdentifierTask Inputstring1..1Task.input[type=PolicyNumber].valueStringPMJAY/HP/S/G

NRCeS profiles: Task.