📒
HCX Protocol
v0.7
v0.7
  • Summary
  • Context
  • Introduction to HCX
  • Approach
    • Design Principles
    • Key Specifications
    • Governance
  • Technical Specifications
    • Open Protocol
      • Registries
      • Health Claims Exchange (HCX) Protocol
        • Exchange Protocol
        • Message Structure
        • API Structure
        • Error Handling
      • Data Security and Privacy
        • Transport Security
        • Message Security and Integrity
        • API Security
      • Audit and Reporting
    • Digital Network Policies
  • Domain Specifications
    • Domain Data Models
      • Handling Attachments
      • Handling Processing Errors
    • Terminologies (Code sets or Metadata standards)
    • Domain Specific Languages (DSLs)
    • Implementation Guide
  • Business Policy Specifications
    • Access Control (Roles)
    • Guidelines for Participant Onboarding
    • Guidelines for Grievance Redressal
    • Guidelines for Event audits
    • Guidelines for Beneficiary Authentication by Providers/Payors
  • Contributing to the specifications
  • Future Roadmap
Powered by GitBook
On this page
  1. Domain Specifications
  2. Domain Data Models

Handling Processing Errors

Handling domain/business processing related errors

PreviousHandling AttachmentsNextTerminologies (Code sets or Metadata standards)

Last updated 3 years ago

While the protocol related errors are expected to be handled as per , this section provides detail on responding when there are errors during business processing of the request.

An error in business processing will be responded using corresponding on_* callback containing corresponding response FHIR profile with following additional constraints:

  1. x-hcx-status needs to be set to "response.error"

  2. Error code in x-hcx-errordetails header needs to be set to "ERR_DOMAIN_PROCESSING" as mentioned in in the Error Response section in the Technical Specifications.

  3. Within the corresponding response FHIR profile {response_resource}

    1. Error status need to be indicated in {response_resource}.outcome attribute

    2. Details of error need to be carried in the corresponding {resopnse_resource}.error attribute.

Error Response section in the Technical Specifications
Recipient error scenarios table