Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement HL7v2 Message Response in Submission API #15731

Open
1 task
arnejduranovic opened this issue Aug 30, 2024 · 4 comments
Open
1 task

Implement HL7v2 Message Response in Submission API #15731

arnejduranovic opened this issue Aug 30, 2024 · 4 comments
Labels
blocked Issue State label to flag PRs and issues to show they are blocked platform Platform Team

Comments

@arnejduranovic
Copy link
Collaborator

arnejduranovic commented Aug 30, 2024

User Story

As a sender of Lab Orders using the EPIC system,
I require ReportStream's submission API to return an HL7v2 formatted response instead of the normal JSON,
so that the EPIC system can properly acknowledge the submission was successful.

Description/Use Case

Certain senders may require RS response objects to be in a certain format, which may potentially limit the information RS can provide. This ticket is specifically asking for a HL7v2 formatted message to support epic systems sending lab orders. It is likely this HL7v2 message will be the following: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/MSA

Risks/Impacts/Considerations

Dev Notes

  • The submission API in RS returns a JSON object with a lot of properties, and we may not need to port all of them to the new message type. This is pending requirements.

  • Epic has indicated they are willing to populate “x-application” with a value of “hl7-v2+er7” to indicate to RS it should return an HL7v2 message in the body of the response. Another option is we can create a new sender setting that indicates what format senders want their responses it.

  • See comment here regarding an issue with the current implementation in the current/old submission endpoint that should be taken into account with this implementation: Platform/angela/14116/read hl7 #16859 (comment)

Acceptance Criteria

  • Submission endpoint supports returning HL7v2 formatted body in HTTP response
@arnejduranovic arnejduranovic added platform Platform Team blocked Issue State label to flag PRs and issues to show they are blocked labels Aug 30, 2024
@arnejduranovic
Copy link
Collaborator Author

arnejduranovic commented Aug 30, 2024

Marking as blocked: Waiting on ETOR-TI team to provide exact requirements for the HL7v2 message for this use case.

@JohnNKing
Copy link
Contributor

Draft ETOR ACK requirements: https://cdc.sharepoint.com/:w:/r/teams/OLSS_ETOR_ReportStream/Shared%20Documents/ReportStream%20ETOR%20ACK%20Requirements.docx?d=w93bd416399924de6a301626414d6cea2&csf=1&web=1&e=OEaZKR

Feedback during the LA SME call today indicated we were on the right track. However, we may receive more partner feedback in the coming week.

@JohnNKing
Copy link
Contributor

@JohnNKing
Copy link
Contributor

JohnNKing commented Dec 17, 2024

Feedback from one of our partners (Ochsner): ACKs in staging are working as expected, for orders sent from Epic! 🎉

Correction: Please disregard. I should have instead posted this to #16394. I didn't realize this story was specific to the new Submission API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Issue State label to flag PRs and issues to show they are blocked platform Platform Team
Projects
None yet
Development

No branches or pull requests

2 participants