{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"338f181a-3e3e-4fdd-902c-7a0d3470ce96"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"ef16d48a-70aa-47fb-aaff-350409285445"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"This document provides details on how external applications can send HL7 messages to OpenSpecimen using its exposed APIs. The process involves authentication, message submission, and logout.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Workflow","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Authentication","type":"text","marks":[{"type":"strong"}]},{"text":": Obtain a session token.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Send Messages","type":"text","marks":[{"type":"strong"}]},{"text":": Transmit HL7 messages in batch or individually.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Logout","type":"text","marks":[{"type":"strong"}]},{"text":": Terminate the session.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"External applications must sign in to OpenSpecimen using the ","type":"text"},{"text":"sessions","type":"text","marks":[{"type":"code"}]},{"text":" API.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"67f55333-0894-4e12-a072-0924befd7aad"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Descriptions","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"paragraph","content":[{"text":"Values","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"URL","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"https:///rest/ng/sessions","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"POST","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Headers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"Content-Type: application/json\nAccept: application/json","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Request Body","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"{\n \"loginName\": \"\",\n \"password\": \"\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Response","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"{\n \"token\": \"\"\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The session token must be included in subsequent API calls.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Sending Messages","type":"text"}]},{"type":"paragraph","content":[{"text":"Messages can be sent individually or in batches (preferred for efficiency).","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"811f9ce1-f4c2-4758-8db2-b27ec99f44a9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Descriptions","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"paragraph","content":[{"text":"Values","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"URL","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"https:///rest/ng/external-app-messages","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"POST","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Headers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"Content-Type: application/json\nAccept: application/json\nX-OS-API-CLIENT: ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Request Body","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"{\n \"protocol\": \"HL7\",\n \"messages\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Response","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"{\n \"transactionId\": \"\"\n}","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Messages are queued asynchronously for processing. The API acknowledges receipt with a transaction ID.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logout","type":"text"}]},{"type":"paragraph","content":[{"text":"Once message submission is complete, terminate the session.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"08fe0c10-cb62-4f80-8272-1bdc0dda128a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Descriptions","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"paragraph","content":[{"text":"Values","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"URL","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"https:///rest/ng/external-app-messages","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"DELETE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Headers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"Content-Type: application/json\nAccept: application/json\nX-OS-API-CLIENT: ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Request Body","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"{}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[177.0]},"content":[{"type":"paragraph","content":[{"text":"Response","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"codeBlock","content":[{"text":"{\n \"status\": \"success\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Handling","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HTTP 401","type":"text","marks":[{"type":"strong"}]},{"text":": Invalid or missing session token.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HTTP 400","type":"text","marks":[{"type":"strong"}]},{"text":": Malformed request or input error.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HTTP 503","type":"text","marks":[{"type":"strong"}]},{"text":": OpenSpecimen-related errors.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Error Response Format","type":"text"}]},{"type":"codeBlock","content":[{"text":"[\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n]","type":"text"}]}],"version":1}