Document All Pipeline Error Codes

[brandonnava]

User Story

As a ReportStream sender I want to understand the meaning of any error code I might get back from the Submission History API so I can act on the error and resend a successful report

As a product manager of ReportStream, I want to understand the current state of the Submission History API, so that I can make informed decisions for future feature changes.

Description/Use Case

We're working on documentation that explains how to use our Submission History API and interpret the results. However since the API can respond with a number of error codes that were written years ago and not documented we can't provide thorough documentation of how to respond to any given error provided until we test all our error codes to understand them ourselves.

• Design has combed the codebase (ActionMessages.kt) for a complete list of possible error codes and put together a running list starting on row 64 of the Fields & Values tab of the SubmissionHistoryAPI_ValuesandResponses spreadsheet; however, most of these error messages appear only on the COVID Pipeline.
• The contents in the UP Errors & Warnings tab of the SubmissionHistoryAPI_ValuesandResponses spreadsheet is a good and thorough start to a compilation of the errors and warnings in the Universal Pipeline.

Dev Notes

• Comprehensively document the errors and warnings that appear in the action log of the Universal Pipeline.
• There is no need to document all the individual codes and messages of errors and warnings that solely appear in the COVID Pipeline. But if they appear in both the CP and UP, please document them.

Acceptance Criteria

• [ ] Verify that the contents in the UP Errors & Warnings tab of the SubmissionHistoryAPI_ValuesandResponses spreadsheet is comprehensive and accurate, providing any additional values from any missing locations in the codebase.
• [ ] Under the "Location" column, hyperlink the Github link to the specific codebase you are referencing

[MichaelEsuruoso]

Hey team! Please add your planning poker estimate with Zenhub @adegolier @arnejduranovic @david-navapbc @jack-h-wang @JFisk42 @kant777 @mkalish @thetaurean

[MichaelEsuruoso]

Hey team! Please add your planning poker estimate with Zenhub @arnejduranovic @david-navapbc @jalbinson @kant777 @thetaurean

[arnejduranovic]

I spent like 30 min combing through the code and these are the errors I found. (I did NOT include any messages that are only used by the COVID pipeline):

• HL7Reader - Contains errors that can occur during the processing of an HL7v2 message. All these make use of InvalidReportMessage class:
  • ERR, UNKOWN, "Provided raw data is empty.", REPORT
  • ERR, UNKOWN, "Unable to find HL7 messages in provided data.", REPORT
  • ERR, UNKOWN, "String did not contain any HL7 messages", REPORT
  • ERR, UNKOWN, "Validation Failed: ${exception.message}", REPORT
  • ERR, UNKOWN, "Required field missing: ${exception.message}", REPORT
  • ERR, UNKOWN, "Data type error: ${exception.message}", REPORT
  • ERR, UNKOWN, "Failed to parse message", REPORT
• RequestFunction - processing HTTP request
  • ERR, UNKNOWN, "$clientName: unknown sender", REPORT
  • ERR, UNKOWN, "unknown schema '${sender.schemaName}'", REPORT
  • ERR, UNKOWN, "Missing ${HttpHeaders.CONTENT_TYPE} header", REPORT
  • ERR, UNKOWN, "Resubmit as '${sender.format.mimeType}'", REPORT
  • ERR, UNKOWN, "Blank message(s) found within file. Blank messages cannot be processed.", REPORT
  • ERR, UNKOWN, "Expecting a post message with content", REPORT
• HL7Serializer - This is where you see the COVID pipeline specific HL7v2 messages and all the weird error codes. Covid pipeline only.
• FHIRConverter
  • ERR, UNKOWN, "Provided raw data is empty.", REPORT
  • ERR, UNKOWN, "Parse error while attempting to iterate over HL7 raw message", REPORT
  • ERR, UNKOWN, "Received unsupported report format: $format", REPORT
  • WARN, INVALID_MSG_CONDITION_MAPPING, "Observation missing code", REPORT
  • WARN, INVALID_MSG_CONDITION_MAPPING, "Missing mapping for code(s): " + unmappableCodes.joinToString(","), REPORT
• FHIRDestinationFilter
  • NA
• FHIRReceiver
  • In Progress
• FHIRReceiverFilter
  • WARN, UNKNOWN, "Item was not routed to $receiverOrg.$receiverName because it did not pass the" + " $filterType. Item failed on: $filter", ITEM
• FHIRTranslator
  • NA
• Misc
  • ERR, UNKNOWN, "Ignoring unsupported HL7 message type $messageType", REPORT
• FHIRTranscoder
  • ERR, UNKNOWN, "Provided raw data is empty.", REPORT
  • ERR, UNKNOWN, "$index: Unable to find FHIR Bundle in provided data.", REPORT
  • ERR, UNKNOWN, "$index: Unable to parse FHIR data.", REPORT

[MichaelEsuruoso]

Hey team! Please add your planning poker estimate with Zenhub @arnejduranovic @kant777 @thetaurean @wcutshall