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
| Field | Value source | Use |
|---|---|---|
x-hcx-workflow_id | Workflow ID | Identifies the workflow stage. |
x-hcx-status | Status | Identifies the protocol status. |
| Outcome note | NRCeS outcome | Adds source notes for the stage. |
Workflow codes
| Stage | Workflow ID | Status | Outcome note |
|---|---|---|---|
| Patient registered | 10 | request.initiate | |
| Patient admitted | 11 | request.initiate | |
| Discharge submitted | 14 | request.initiate | |
| Preauthorization request resubmitted | 16 | request.initiate | |
| Claim request in process | 28 | response.partial | |
| Claim forwarded | 29 | response.partial | |
| Payment processed | 31 | request.initiate | |
| Payment settled | 33 | request.initiate | |
| Discharge query response submitted | 141 | response.complete | |
| Claim query response submitted | 151 | response.complete | |
| Reprocess request approved | 252 | response.complete | |
| Reprocess request rejected | 253 | response.complete | |
| Reprocess request queried | 254 | request.initiate | |
| Discharge request approved | 261 | response.partial | |
| Discharge request rejected | 262 | response.complete | |
| Discharge request queried | 263 | request.initiate | |
| Preauthorization intimation | 12 | request.initiate | NR |
| Preauthorization reprocess intimation | 121 | request.initiate | NR |
| Claim document reprocess intimation | 122 | request.initiate | NR |
| Claim document reprocess acknowledgment | 122 | response.complete | Treat this as a protocol error. |
| Enhancement intimation | 13 | request.initiate | NR |
| Enhancement acknowledgment success | 13 | response.partial | queued; treat this as a protocol error. |
| Enhancement acknowledgment failure | 13 | response.error | error; treat this as a protocol error. |
| Enhancement query acknowledgment success | 131 | response.partial | Treat this as a protocol error. |
| Enhancement query acknowledgment failure | 131 | response.error | Treat this as a protocol error. |
| Enhancement query response | 131 | response.complete | |
| Final bill intimation | 45 | request.initiate | NR |
| Final bill acknowledgment success | 45 | response.partial | queued; treat this as a protocol error. |
| Final bill acknowledgment failure | 45 | response.error | error; treat this as a protocol error. |
| Claim document intimation | 15 | request.initiate | NR |
| Final bill query response | 181 | response.complete | |
| Claim document query response | 161 | response.complete | |
| Payment notice received | 17 | response.complete | |
| Preauthorization query acknowledgment success | 18 | response.partial | |
| Preauthorization query acknowledgment failure | 18 | response.error | Treat this as a protocol error. |
| Preauthorization query response | 19 | response.complete | |
| Preauthorization acknowledgment success | 20 | response.partial | queued |
| Preauthorization acknowledgment failure | 20 | response.error | error |
| Preauthorization approve | 21 | response.complete | partial |
| Enhancement approve | 22 | response.complete | partial |
| Preauthorization deny | 23 | response.complete | complete |
| Enhancement deny | 231 | response.complete | complete |
| Preauthorization query raised | 24 | request.initiate | NR |
| Enhancement query raised | 241 | request.initiate | NR |
| Claim document acknowledgment success | 25 | response.partial | queued |
| Claim document acknowledgment failure | 25 | response.error | error |
| Preauthorization reprocess acknowledgment | 251 | response.complete | |
| Final bill approve | 46 | response.complete | partial |
| Claim document approve | 26 | response.complete | complete |
| Final bill query raised | 47 | request.initiate | NR |
| Final bill query acknowledgment success | 47 | response.partial | Treat this as a protocol error. |
| Final bill query acknowledgment failure | 47 | response.error | Treat this as a protocol error. |
| Claim document query raised | 27 | request.initiate | NR |
| Claim document query acknowledgment success | 27 | response.partial | Treat this as a protocol error. |
| Claim document query acknowledgment failure | 27 | response.error | Treat this as a protocol error. |
| Final bill deny | 491 | response.complete | complete |
| Claim document deny | 291 | response.complete | complete |
| Payment notice intimation | 30 | request.initiate | |
| Payment notice acknowledgment success | 30 | response.partial | Treat this as a protocol error. |
| Payment notice acknowledgment failure | 30 | response.error | Treat this as a protocol error. |
| Enhancement reprocess intimation | NA | NA | NA |
| Enhancement reprocess acknowledgment | NA | NA | NA |
| Final bill reprocess intimation | NA | NA | NA |
| Final bill reprocess acknowledgment | NA | NA | NA |
| Reimbursement claim reprocess requested | R122 | request.initiate | |
| Reimbursement claim submitted | R15 | request.initiate | |
| Reimbursement claim query response submitted | R151 | response.complete | |
| Reimbursement claim reprocess request approved | R252 | response.complete | |
| Reimbursement claim reprocess request rejected | R253 | response.complete | |
| Reimbursement claim reprocess request queried | R254 | request.initiate | |
| Reimbursement claim approved | R26 | response.complete | |
| Reimbursement claim queried | R27 | request.initiate | |
| Reimbursement claim evaluation in process | R28 | response.partial | |
| Reimbursement claim rejected | R291 | response.complete | |
| Wallet upgrade intimation | 34 | request.initiate | |
| Claim arbitration intimation | 36 | request.initiate | |
| Fraud alert | 38 | request.initiate | |
| Wallet upgrade acknowledgment | 35 | response.complete | |
| Claim arbitration acknowledgment | 37 | response.complete | |
| Fraud alert acknowledgment | 39 | response.complete | |
| Grievance intimation | G11 | request.initiate | |
| Grievance acknowledgment | G12 | response.complete | |
| Grievance intimation failure | G13 | response.error | |
| Preauthorization arbitration intimation | 41 | request.initiate | |
| Preauthorization arbitration acknowledgment | 42 | response.complete | |
| Return payment intimation | RP1 | request.initiate | |
| Return payment acknowledgment | RP2 | response.complete | |
| Return payment failure | RP3 | response.error | |
| Notification for a payer | N01 | request.initiate | |
| Notification for a provider | N02 | request.initiate | |
| Notification for a beneficiary | N03 | request.initiate | |
| Notification acknowledgment | N04 | response.complete | |
| Discharge correction intimation | DC01 | request.initiate | |
| Discharge correction acknowledgment | DC02 | response.complete | |
| Preauthorization cancellation | PC01 | request.initiate | |
| Preauthorization cancellation accomplished | PC02 | response.complete | |
| Residual claim adjudication initiation, erroneous | E01 | request.initiate | |
| Residual claim adjudication with approval | E02 | response.complete | |
| Residual claim adjudication with rejection | E03 | response.complete | |
| Residual claim adjudication with query | E04 | response.complete |
Sources
- workflow-status-codes.md (NHCX sandbox portal)