Skip to main content

Cancel, reprocess and shortfall

The post-decision exchanges. All are Task bundles on /v1/task/submit, answered on /v1/task/on_submit, and Task.code with its reason is the only thing that tells them apart.

Cancel

Sent on /v1/task/submit, workflow PC01.

The bundle

#ResourceProfile
1TaskTask
2Organization (prov)Organization
3Organization (pay)Organization

Elements

1. Task

NRCeS profile: Task.

ElementExample
statusrequested
intentorder
code.coding[]cancel in http://terminology.hl7.org/CodeSystem/financialtaskcode
authoredOn2026-09-10T23:52:03+05:30
requesterreference https://nhcx.abdm.gov.in/provider
ownerreference https://nhcx.abdm.gov.in/payer
descriptionTreatment plan changed; withdrawn.
reasonCode.coding[]treatmentplanchanged Treatment plan changed during hospitalization in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-reason-code
input[]valueString NM-26-0SE00002I
input[].type.coding[]claimNumber ClaimNumber in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code
intimationNumber Intimation Number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code

2. 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

3. 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

Reprocess

Sent on /v1/task/submit, workflow 36.

The bundle

#ResourceProfile
1TaskTask
2Organization (prov)Organization
3Organization (pay)Organization

Elements

1. Task

NRCeS profile: Task.

ElementExample
statusrequested
intentorder
code.coding[]reprocess in http://terminology.hl7.org/CodeSystem/financialtaskcode
authoredOn2026-09-10T23:53:27+05:30
requesterreference https://nhcx.abdm.gov.in/provider
ownerreference https://nhcx.abdm.gov.in/payer
descriptionPackage rate revised; please reassess the approved amount.
reasonCode.coding[]claimrejected Reprocess request due to claim rejected by payer in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-reason-code
basedOn[]display Claim NM-26-0SE00002L
basedOn[].identifiersystem https://nhcx.abdm.gov.in, value NM-26-0SE00002L
basedOn[].identifier.type.coding[]CLN Claim number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
input[]valueString NM-26-0SE00002L
input[].type.coding[]claimNumber ClaimNumber in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code
intimationNumber Intimation Number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code
for.identifiervalue MRAV1985001
for.identifier.type.coding[]MB Member Number in http://terminology.hl7.org/CodeSystem/v2-0203

2. 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

3. 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

Release

Sent on /v1/task/submit.

The bundle

#ResourceProfile
1TaskTask
2Organization (prov)Organization
3Organization (pay)Organization

Elements

1. Task

NRCeS profile: Task.

ElementExample
statusrequested
intentorder
code.coding[]release in http://terminology.hl7.org/CodeSystem/financialtaskcode
descriptionRelease the balance amount for claim EO26AA2700001
authoredOn2026-03-05T11:20:00+05:30
requesterreference https://nhcx.abdm.gov.in/provider
ownerreference https://nhcx.abdm.gov.in/payer
reasonCode.coding[]partialpayment Reprocess request due to partial payment by payer in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-reason-code
basedOn[]display Claim EO26AA2700001
basedOn[].identifiersystem https://nhcx.abdm.gov.in, value EO26AA2700001
basedOn[].identifier.type.coding[]CLN Claim number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
input[]valueString EO26AA2700001
input[].type.coding[]claimNumber ClaimNumber in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code
amount Amount in https://nhcx.abdm.gov.in/task-input-type
input[].valueMoneyvalue 1650, currency INR

2. 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
nameFacility Name

3. Organization (pay)

NRCeS profile: Organization.

ElementExample
identifier[]system https://nhcx.abdm.gov.in, value 1518
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
nameInsurance Company

Cancellation done

Sent on /v1/task/on_submit, workflow PC02.

The bundle

#ResourceProfile
1Tasknone declared; NRCeS Task
2ClaimResponsenone declared; NRCeS ClaimResponse
3Patientnone declared; NRCeS Patient
4Organization (pay)none declared; NRCeS Organization
5Organization (prov)none declared; NRCeS Organization
6Coveragenone declared; NRCeS Coverage

Elements

1. Task

NRCeS profile: Task.

ElementExample
statuscompleted
intentorder
code.coding[]approve Activate/approve the focal resource in http://hl7.org/fhir/CodeSystem/task-code
descriptionPre-authorisation withdrawn by 1000003463@hcx: Treatment plan changed; withdraw…
authoredOn2026-09-10T23:52:05+05:30
requesterreference <participant-defined>
ownerreference <participant-defined>
output[].type.coding[]include Include in http://terminology.hl7.org/CodeSystem/financialtaskinputtype
output[].valueReferencereference <participant-defined>

2. ClaimResponse

NRCeS profile: ClaimResponse.

ElementExample
identifier[]system <participant-defined>, value NM-26-0SE00002I
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 https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-claim-type
usepreauthorization
patientreference <participant-defined>
created2026-09-10T23:52:05+05:30
insurerreference <participant-defined>
requestorreference <participant-defined>
outcomecomplete
dispositionPre-authorisation withdrawn by 1000003463@hcx: Treatment plan changed; withdraw…
payeeType.coding[]provider Provider in http://terminology.hl7.org/CodeSystem/payeetype
adjudication[].category.coding[]status Status
adjudication[].reason.coding[]cancelled Cancelled
total[].category.coding[]benefit Benefit Amount in https://hl7.org/fhir/R4/valueset-adjudication.html
submitted Submitted Amount in https://hl7.org/fhir/R4/valueset-adjudication.html
total[].amountvalue 150000

The Patient, Organization, Coverage entries are shaped as in the chapters that introduce them.

Reprocess acknowledged

Sent on /v1/task/on_submit, workflow 37.

The bundle

#ResourceProfile
1Tasknone declared; NRCeS Task
2ClaimResponsenone declared; NRCeS ClaimResponse
3Patientnone declared; NRCeS Patient
4Organization (pay)none declared; NRCeS Organization
5Organization (prov)none declared; NRCeS Organization
6Coveragenone declared; NRCeS Coverage

Elements

1. Task

NRCeS profile: Task.

ElementExample
statusaccepted
intentorder
code.coding[]approve Activate/approve the focal resource in http://hl7.org/fhir/CodeSystem/task-code
descriptionClaim reopened for reprocessing (round 1) at the request of 1000003463@hcx: Pac…
authoredOn2026-09-10T23:53:28+05:30
requesterreference <participant-defined>
ownerreference <participant-defined>
output[].type.coding[]include Include in http://terminology.hl7.org/CodeSystem/financialtaskinputtype
output[].valueReferencereference <participant-defined>

2. ClaimResponse

NRCeS profile: ClaimResponse.

ElementExample
identifier[]system <participant-defined>, 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 https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-claim-type
useclaim
patientreference <participant-defined>
created2026-09-10T23:53:28+05:30
insurerreference <participant-defined>
requestorreference <participant-defined>
outcomequeued
dispositionClaim reopened for reprocessing (round 1) at the request of 1000003463@hcx: Pac…
payeeType.coding[]provider Provider in http://terminology.hl7.org/CodeSystem/payeetype
adjudication[].category.coding[]status Status
adjudication[].reason.coding[]submitted Submitted
total[].category.coding[]benefit Benefit Amount in https://hl7.org/fhir/R4/valueset-adjudication.html
submitted Submitted Amount in https://hl7.org/fhir/R4/valueset-adjudication.html
total[].amountvalue 0
value 150000

The Patient, Organization, Coverage entries are shaped as in the chapters that introduce them.

Rules

1. Cancel

Task.code cancel, a reason from ndhm-reason-code (treatmentplanchanged, patientrequest, financialconstraints, alternativetreatment, duplicateclaim, administrativeerror, other), and the inputs claimNumber and intimationNumber.

2. Reprocess

Task.code reprocess, reason claimrejected for a rejected claim or partialpayment for one paid short, basedOn naming the claim by its CLN identifier, for the member, and the inputs claimNumber and intimationNumber, spelled so.

3. Release

Task.code release, reason partialpayment, with the claim number and the amount sought as a valueMoney input.

4. Nullify

The Reprocess sheet of the requests-and-responses workbook gives Task.code on /v1/task/submit as reprocess, cancel, release or nullify, as the use case needs, each with a ClaimNumber input carrying the claim number and Task.status requested; the answer is a Task whose output is the ClaimResponse. The provider sandbox exit checklist names the same four codes. The value sets describe nullify as closing a claim the provider submitted. No sample bundle, reason code or workflow code is published for it.

5. Suspend

suspend appears only as a code. The value sets list it, glossed "suspend the preauthorization or claim that was submitted by provider", beside the task output claimsuspended. No exchange carries it: no request shape, answer or workflow code is published.

6. The answer

A Task whose output of type include references a ClaimResponse in the same bundle. Read the result from that ClaimResponse's adjudication reason, not from outcome and not from Task.code. A cancellation is completed with reason cancelled; a reprocess is accepted with the ClaimResponse queued, and the new verdict follows on the claim's own thread.

7. Switch on system and code together

The Task code systems differ between request and response.

8. A cancelled case still reports money

Zero the figure yourself once the reason reads cancelled.

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

Cancel

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

Reprocess

Elements PMJAY adds
ElementExample
Task.input[].valueAttachmentcontentType application/pdf, title Medical Superintendent Declaration Form (During Admission)
Systems PMJAY binds differently
ElementGenericPMJAY
Task.for.identifier.type.coding[]http://terminology.hl7.org/CodeSystem/v2-0203https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code

What PMJAY specifies

  • A shortfall is the reprocess Task with reason partialpayment and an amount capped at the difference.
  • The reprocess carries the supporting document as a document input with a valueAttachment, and names the member by the PMJAY identifier.
  • The reprocess is acknowledged on 37; the new verdict then arrives on the claim's own thread.

What PMJAY requires

  • Cancel is allowed until the claim is raised, and refused once payment has been initiated (PAYR-1257).
  • Reprocess once, the moment the rejection arrives, with a supporting document. The Claim Review Committee is final.
  • Shortfall only after payment notice 33 has arrived and been acknowledged on 17, once, and never after a reprocess.
  • A Task coded status is not taken (PAYR-1018, PAYR-1008). Read where a case stands from the payer service instead.

Use cases, APIs and data elements

B8 Reprocess or cancel (provider)

One endpoint, several jobs, told apart by the Task's code and reason: reprocess with claimrejected, shortfall with partialpayment, cancel. A reprocess goes on 36 and is acknowledged on 37; a cancel goes on PC01 and is done on PC02. Both carry the input intimationNumber. A supporting document is mandatory on a reprocess.

API/v1/task/submit apis/13-other/v1-task-submit.bru
Callback/v1/task/on_submit apis/13-other/v1-task-on-submit.bru
WorkflowPC01 cancel, 36 reprocess or shortfall
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_idPC01
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
PC01Preauth Cancel Initiatedproviderrequest.initiatedCancel an existing preauth
36Claim Arbitration Request Submittedproviderrequest.initiatedReprocess/Erroneous request, with input intimationNumber; acknowledged on 37

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskCodeAction CodeTaskcode1..1Task.code.coding[0].codereprocess
taskReasonAppeal Reason CodeTaskcode1..1Task.reasonCode.coding[0].codeclaimrejected
originalCaseNumberOriginal Case NumberTask Inputstring1..1Task.input[0].valueStringCL0000000001
appealDocumentDispute Justification DocumentTask Inputbase64Binary1..1Task.input[category=document].valueAttachment.dataJVBERi0xLjQK...

NRCeS profiles: Task.

D8 Cancel pre-authorisation (pmjay)

A Task with code cancel, the case number as input and one of seven reasons: treatmentplanchanged, patientrequest, financialconstraints, alternativetreatment, duplicateclaim, administrativeerror, other. Allowed at any point until the claim is raised.

API/v1/task/submit apis/13-other/v1-task-submit.bru
Callback/v1/task/on_submit apis/13-other/v1-task-on-submit.bru
WorkflowPC01
Carries JWEyes
Focal resourceTask
Simulator console/builder?family=preauth&usecase=cancel

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

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
PC01Preauth Cancel Initiatedproviderrequest.initiatedCancel an existing preauth

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskCodeAction CodeTaskcode1..1Task.code.coding[0].codecancel
caseNumberPre-auth Case NumberTask Inputstring1..1Task.input[0].valueStringVB26AA2600001

NRCeS profiles: Task.

D11 Reprocess a rejected claim (pmjay)

An appeal, not a resubmission: a Task with code reprocess and reason claimrejected, a supporting document attached, no amount. Raise it the moment the rejection arrives. Once only; the Claim Review Committee is final.

API/v1/task/submit apis/13-other/v1-task-submit.bru
Callback/v1/task/on_submit apis/13-other/v1-task-on-submit.bru
Workflow36
Carries JWEyes
Focal resourceTask
Simulator console/builder?family=claim&usecase=reprocess

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

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
36Claim Arbitration Request Submittedproviderrequest.initiatedReprocess/Erroneous request, with input intimationNumber; acknowledged on 37

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskCodeTask CodeTaskcode1..1Task.code.coding[0].codereprocess
taskReasonDispute ReasonTaskcode1..1Task.reasonCode.coding[0].codeclaimrejected
claimNumberRejected Claim IDTask Inputstring1..1Task.input[0].valueStringCL26AA2600001

NRCeS profiles: Task.

D12 Claim a shortfall (pmjay)

The same Task with reason partialpayment and an amount capped at the difference, allowed only after payment notice 33 has arrived and been acknowledged with 17. Once only, and never after a reprocess.

API/v1/task/submit apis/13-other/v1-task-submit.bru
Callback/v1/task/on_submit apis/13-other/v1-task-on-submit.bru
Workflow36
Carries JWEyes
Focal resourceTask
Simulator console/builder?family=claim&usecase=shortfall

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

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
36Claim Arbitration Request Submittedproviderrequest.initiatedReprocess/Erroneous request, with input intimationNumber; acknowledged on 37

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskCodeTask CodeTaskcode1..1Task.code.coding[0].codereprocess
taskReasonReason CodeTaskcode1..1Task.reasonCode.coding[0].codepartialpayment
claimNumberPartially Paid Claim IDTask Inputstring1..1Task.input[0].valueStringCL26AA2600001

NRCeS profiles: Task.

C10 Respond to a Task (payer)

The answer to a reprocess, shortfall or cancel. A cancellation done is PC02 and carries the case's ClaimResponse in its output; a reprocess on 36 is acknowledged on 37 as arbitration. Both payers answer this way.

API/v1/task/on_submit apis/13-other/v1-task-on-submit.bru
Callback/v1/task/submit apis/13-other/v1-task-submit.bru
Workflow251 acknowledged, 252 approved, 253 rejected, 254 queried, PC02 cancelled, 37 arbitration acknowledged
Carries JWEyes
Focal resourceTask

Request headers

HeaderExample value
x-hcx-sender_code1518@hcx
x-hcx-recipient_code1000004446@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id252
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusresponse.complete
x-hcx-ben-abha-id91711234567890

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
251Reprocess Request Receivedpayerresponse.completeReprocess request received
252Reprocess Request Approvedpayerresponse.completeReprocess request approved
253Reprocess Request Rejectedpayerresponse.completeReprocess request rejected
254Reprocess Request Queriedpayerrequest.initiatedReprocess request queried
PC02Preauthorization Cancellation Accomplishedstatus sheet onlyresponse.complete
37Claim Arbitration Acknowledgementstatus sheet onlyresponse.complete

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskStatusTask StatusTaskcode1..1Task.statuscompleted
outputDecisionDecision ReferenceTask Outputreference0..1Task.output[0].valueReference.referenceClaimResponse/cr-reprocess-approved

NRCeS profiles: Task.