National Health Authority

Command Palette

Search for a command to run...

Workflow Status Codes

Use the NHCX workflow code and status values in the protected header.

Use this table to set the protected header values for an NHCX workflow. Set x-hcx-workflow_id from the Workflow ID column. Set x-hcx-status from the Status column.

Verify protocol error rows

Some source rows mark a value as a protocol error. Treat those rows as sandbox guidance and confirm them before production use.

Header fields

FieldValue sourceUse
x-hcx-workflow_idWorkflow IDIdentifies the workflow stage.
x-hcx-statusStatusIdentifies the protocol status.
Outcome noteNRCeS outcomeAdds source notes for the stage.

Workflow codes

StageWorkflow IDStatusOutcome note
Patient registered10request.initiate
Patient admitted11request.initiate
Discharge submitted14request.initiate
Preauthorization request resubmitted16request.initiate
Claim request in process28response.partial
Claim forwarded29response.partial
Payment processed31request.initiate
Payment settled33request.initiate
Discharge query response submitted141response.complete
Claim query response submitted151response.complete
Reprocess request approved252response.complete
Reprocess request rejected253response.complete
Reprocess request queried254request.initiate
Discharge request approved261response.partial
Discharge request rejected262response.complete
Discharge request queried263request.initiate
Preauthorization intimation12request.initiateNR
Preauthorization reprocess intimation121request.initiateNR
Claim document reprocess intimation122request.initiateNR
Claim document reprocess acknowledgment122response.completeTreat this as a protocol error.
Enhancement intimation13request.initiateNR
Enhancement acknowledgment success13response.partialqueued; treat this as a protocol error.
Enhancement acknowledgment failure13response.errorerror; treat this as a protocol error.
Enhancement query acknowledgment success131response.partialTreat this as a protocol error.
Enhancement query acknowledgment failure131response.errorTreat this as a protocol error.
Enhancement query response131response.complete
Final bill intimation45request.initiateNR
Final bill acknowledgment success45response.partialqueued; treat this as a protocol error.
Final bill acknowledgment failure45response.errorerror; treat this as a protocol error.
Claim document intimation15request.initiateNR
Final bill query response181response.complete
Claim document query response161response.complete
Payment notice received17response.complete
Preauthorization query acknowledgment success18response.partial
Preauthorization query acknowledgment failure18response.errorTreat this as a protocol error.
Preauthorization query response19response.complete
Preauthorization acknowledgment success20response.partialqueued
Preauthorization acknowledgment failure20response.errorerror
Preauthorization approve21response.completepartial
Enhancement approve22response.completepartial
Preauthorization deny23response.completecomplete
Enhancement deny231response.completecomplete
Preauthorization query raised24request.initiateNR
Enhancement query raised241request.initiateNR
Claim document acknowledgment success25response.partialqueued
Claim document acknowledgment failure25response.errorerror
Preauthorization reprocess acknowledgment251response.complete
Final bill approve46response.completepartial
Claim document approve26response.completecomplete
Final bill query raised47request.initiateNR
Final bill query acknowledgment success47response.partialTreat this as a protocol error.
Final bill query acknowledgment failure47response.errorTreat this as a protocol error.
Claim document query raised27request.initiateNR
Claim document query acknowledgment success27response.partialTreat this as a protocol error.
Claim document query acknowledgment failure27response.errorTreat this as a protocol error.
Final bill deny491response.completecomplete
Claim document deny291response.completecomplete
Payment notice intimation30request.initiate
Payment notice acknowledgment success30response.partialTreat this as a protocol error.
Payment notice acknowledgment failure30response.errorTreat this as a protocol error.
Enhancement reprocess intimationNANANA
Enhancement reprocess acknowledgmentNANANA
Final bill reprocess intimationNANANA
Final bill reprocess acknowledgmentNANANA
Reimbursement claim reprocess requestedR122request.initiate
Reimbursement claim submittedR15request.initiate
Reimbursement claim query response submittedR151response.complete
Reimbursement claim reprocess request approvedR252response.complete
Reimbursement claim reprocess request rejectedR253response.complete
Reimbursement claim reprocess request queriedR254request.initiate
Reimbursement claim approvedR26response.complete
Reimbursement claim queriedR27request.initiate
Reimbursement claim evaluation in processR28response.partial
Reimbursement claim rejectedR291response.complete
Wallet upgrade intimation34request.initiate
Claim arbitration intimation36request.initiate
Fraud alert38request.initiate
Wallet upgrade acknowledgment35response.complete
Claim arbitration acknowledgment37response.complete
Fraud alert acknowledgment39response.complete
Grievance intimationG11request.initiate
Grievance acknowledgmentG12response.complete
Grievance intimation failureG13response.error
Preauthorization arbitration intimation41request.initiate
Preauthorization arbitration acknowledgment42response.complete
Return payment intimationRP1request.initiate
Return payment acknowledgmentRP2response.complete
Return payment failureRP3response.error
Notification for a payerN01request.initiate
Notification for a providerN02request.initiate
Notification for a beneficiaryN03request.initiate
Notification acknowledgmentN04response.complete
Discharge correction intimationDC01request.initiate
Discharge correction acknowledgmentDC02response.complete
Preauthorization cancellationPC01request.initiate
Preauthorization cancellation accomplishedPC02response.complete
Residual claim adjudication initiation, erroneousE01request.initiate
Residual claim adjudication with approvalE02response.complete
Residual claim adjudication with rejectionE03response.complete
Residual claim adjudication with queryE04response.complete

Sources

  • workflow-status-codes.md (NHCX sandbox portal)