diff --git a/docs/diagrams/Pathology_and_Laboratory_Medicine_Reporting_FHIR_API.svg b/docs/diagrams/Pathology_and_Laboratory_Medicine_Reporting_FHIR_API.svg new file mode 100644 index 00000000..7c389196 --- /dev/null +++ b/docs/diagrams/Pathology_and_Laboratory_Medicine_Reporting_FHIR_API.svg @@ -0,0 +1,3 @@ + + +
1. send test results
1. send test results
Laboratory middleware system
Laboratory middle...
Pathology API
Pathology API
Patient Data Manager (PDM)
Patient Data Mana...
2. store test results
2. store test results
Multicast Notification Service (MNS)
Multicast Notifica...
3. publish event
3. publish event
GP system
GP system
a. receive event
a. receive event
b. request test result
b. request test result
c. receive test result
c. receive test result \ No newline at end of file diff --git a/pathology-api/openapi.yaml b/pathology-api/openapi.yaml index b10460f5..fc3347fc 100644 --- a/pathology-api/openapi.yaml +++ b/pathology-api/openapi.yaml @@ -3,21 +3,60 @@ info: title: Pathology and Laboratory Medicine Reporting - FHIR API description: | ## Overview - The Pathology and Laboratory Medicine Reporting API enables the sharing of pathology test results from a laboratory middleware system to the requesting organisation, where the request was initiated in general practice. + Use this API to send structured pathology test results from a laboratory middleware system to the organisation that requested the test in general practice. + + ![Pathology API High-level Diagram](https://raw.githubusercontent.com/NHSDigital/clinical-data-pathology-api/main/docs/diagrams/Pathology_and_Laboratory_Medicine_Reporting_FHIR_API.svg) + +
+
+ +
+ + + + + + + +

How it works

+
+ +
+

Laboratory middleware systems receive and process batches of test results from Laboratory Information Management Systems (LIMS), following which:

+
    +
  1. Laboratory middleware systems send individual test results to the Pathology API. Each test result relates to a single Patient, but may contain multiple observations.
    2. +
  2. The Pathology API validates the request and stores the test result in Patient Data Manager (PDM).
    3. +
  3. Once stored, the Pathology API publishes an event to the Multicast Notification Service (MNS), containing details of the organisation that requested the test and a pointer to where the test result is stored in PDM.
    4. +
+

Separate to this process:

+
    +
  1. General Practice Information Management (GPIT) systems subscribe to Pathology and Laboratory Medicine Reporting test result stored events, and receive events that are relevant to them.
    2. +
  2. GPIT systems use the information specified on MNS events to request test results from Patient Data Manager.
    3. +
  3. Test results are retrieved from Patient Data Manager and processed by the GPIT system.
    4. +
+
+
+
Using this API you can: - Send a laboratory test result + This API replaces the current [Pathology Messaging - EDIFACT API](https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-edifact) and supersedes Laboratory HL7 V3 (see the [Message Implementation Manual](https://data.developer.nhs.uk/dms/mim/6.3.01/Index.htm)) under Domains -> Health and Clinical Management -> Laboratory). + + The following pathology specialisms are currently supported by this API, with further specialism coverage under review: + - clinical biochemistry (also known as chemical pathology), haematology, immunology, and transfusion medicine + - microbiology - this includes bacteriology, virology, and serology + ## Who can use this API - You can use this API if you are a software developer for a middleware application, supporting the aggregation and dissemination of pathology test results from LIMS. + You can use this API if you are a software developer for a middleware application, supporting the aggregation and dissemination of pathology test results from Laboratory Information Management Systems (LIMS). - You must register with us prior to using the API. + You must register with us prior to using the API, with onboarding currently restricted to invited applications only. ## Related APIs The following APIs are used by the Pathology and Laboratory Medicine Reporting API to facilitate the storage of pathology test results and publication of events to GP systems: - - [Patient Data Manager FHIR API](https://digital.nhs.uk/developer/api-catalogue/patient-data-manager) - - [Multicast Notification Service API](https://digital.nhs.uk/developer/api-catalogue/multicast-notification-service) + - [Patient Data Manager FHIR API](https://digital.nhs.uk/developer/api-catalogue/patient-data-manager) - used to store, retrieve, and manage patient healthcare data in a standardised, interoperable format. + - [Multicast Notification Service API](https://digital.nhs.uk/developer/api-catalogue/multicast-notification-service) - used to publish and receive patient-related healthcare events. ## API status and roadmap This API is currently [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).