Northern Region File My Report Web API

1.0.x
(0 reviews)

Overview

File My Report (FMR) Web API is a Northern Region Document Messaging capability that receives documents from any internal or external Consumer (also called publisher systems), determines the destinations where the document should be delivered to and delivers the documents to the target destinations in the format expected by the destination system(s). It accepts messages in PDF or HL7 ORU or JSON message formats.

Presently it supports the delivery of documents to:

  • Eclair Regional Clinical Document
    • This is the Regional Document Repository for all Clinical Documents and Reports such as patient admissions, discharge summaries
      • Reports are displayed in a document tree that is organised by Category (e.g., Clinic Letter, Discharge Summaries) and by Report Name
      • Éclair RCD reports can be viewed from under the Patient Clinical Document Viewer Tree in Regional Clinical Portal and in Testsafe
  • Web Eclair
    • This is a web-based user interface the displays the patients’ diagnostic results, usually from the fulfilment of laboratory, radiology orders.
    • It provides a facility for District Clinicians to review and accept or reject diagnostic results.
  • Auckland District 3M ChartLinc/ ChartView
    • ChartLinc is a proprietary interface that uses TCP/IP protocol to deliver clinical documents to 3M database.
    • Users will be able to search and view the documents in ChartView.

Diagram below depicts the flow of the document from Document Publisher to the possible target destination systems via File My Report (FMR).

resources/FMR%20Concept-sm-2b066fa8-02d6-4bae-be0b-b5ff5a252211.JPG

Input Metadata Requirements

resources/FMR%20Input%20Metadata%20Requirements%2C%20pt1-6eb0d2dd-e82b-4178-96ae-c63c95c42d4a.JPG

resources/FMR%20Input%20Metadata%20Requirements%2C%20pt2-cbc6470c-7b06-4dd0-816e-af47ee99583c.JPG

resources/FMR%20Input%20Metadata%20Requirements%2C%20pt3-589a0c8a-27ed-455c-8eec-c2df660662b4.JPG

Important Note

Please add header content type value text/hl7v2

Example:

curl --location --request POST 'https://fmr-documentweb-proxy-api-v40.au-s1.cloudhub.io/regional/filemyreport/document/v10/hl7' \
--header 'Content-Type: text/hl7v2' \
--header 'x-ha-metadata: *****' \
--header 'client_id: *****' \
--header 'client_secret: *****' \
--header 'Authorization: Bearer *****' \
--data-raw 'MSH|^~\&|RAURAUNGAEHE|G00011K|NRFILEMYREPORT|REGIONAL|20220622145902||ORU^R01|027200115121257_3|P|2.4||||||8859/1
PID|1||ZDS3849^^^NHI^||Mouse^Mickey^^^Mr||20140716
OBR|1|111|1X34G2831200|ARRAU0001^CHEMOTHERAPY TREATMENT SUMMARY|||202109141337|||||||||||||||||HAEMONCOL|F
OBX|1|ED|ARRAU0001^Chemotherapy Treatment Summary||NRFILEMYREPORT^application^pdf^Base64^***||||||F

Reviews