NHS North West Genomics
2.0.3 - ci-build United Kingdom flag

NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 2.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions

Document Exchange [MHD]

This API for the NW GMSA Clinical Data Repository is based on the following:

The search parameters are based on FHIR Search which provides a detailed description of the parameters and value types.

graph LR

publisher[Document Publisher]
provider[Document Access Provider]
consumer[Document Consumer]

publisher --> |Publish Document| provider
consumer --> |Request Documents| provider
provider --> |Respond| consumer

Document Consumption

The sequence diagram below relates to Genomics Data Platform (GDP).

sequenceDiagram
    participant Consumer as Document Consumer
    participant Provider as Document Access Provider

    rect rgb(240, 248, 255)
    Note over Consumer,Provider: Find Document References (ITI-67)
    Consumer->>Provider: GET /DocumentReference?patient=...&type=...
    Provider-->>Consumer: Bundle of DocumentReferences
    end

    rect rgb(240, 255, 240)
    Note over Consumer,Provider: Retrieve Document (ITI-68)
    Consumer->>Provider: GET [attachment.url from DocumentReference]
    Provider-->>Consumer: PDF or FHIR Document Bundle
    end

Binary [ITI-68]

Binary can be FHIR Document or PDF.

Retrieve Document [ITI-68]

Read

DocumentReference [ITI-67]

Find Document References [ITI-67]

Read

Parameter Type Search Note
_lastUpdated date GET [base]/DocumentReference?_lastUpdated=[date] Date the resource was last updated
identifier token GET [base]/DocumentReference?identifier=[system|][code] Master Version Specific Identifier
patient reference GET [base]/DocumentReference?patient=[id] Who/what is the subject of the document
date date GET [base]/DocumentReference?date=[date] When this document reference was created
category token GET [base]/DocumentReference?category=[system|][code] Categorisation of document
type token GET [base]/DocumentReference?type=[system|][code] Kind of document
Example

Searching for a DocumentReference by type (Genetic report) and patient.

GET [base]/DocumentReference?type=http://snomed.info/sct|1054161000000101&patient=995525
Accept: application/fhir+json

NRL Document Consumption

In the NRL version, Genomics Data Platform (GDP) is a Document Repository, and NRL is a Document Registry.

sequenceDiagram
    participant Consumer as Document Consumer
    participant Provider as Document Registry (NRL)
    participant Repository as Document Repository (GDP)

    rect rgb(240, 248, 255)
    Note over Consumer,Provider: Find Document References (ITI-67)
    Consumer->>Provider: GET /DocumentReference?patient=...&type=...
    Provider-->>Consumer: Bundle of DocumentReferences
    end

    rect rgb(240, 255, 240)
    Note over Consumer,Repository: Retrieve Document (ITI-68)
    Consumer->>Repository: GET [attachment.url from DocumentReference]
    Repository-->>Consumer: PDF or FHIR Document Bundle
    end

Document Publish

MDM_T02 Original document notification and content

Document is currently PDF.

sequenceDiagram
    participant Provider as Document Provider
    participant Consumer as Document Consumer

    rect rgb(240, 248, 255)
    Note over Consumer,Provider:Original document <br/>notification and content
    Provider->>Consumer: HL7 v2 MDM_T02 Message
    Consumer-->>Provider: Response HL7 v2 ACK
    end

See MDM_T02 Original document notification and content