North West Genomic Medicine Service Alliance
0.0.7 - ci-build
North West Genomic Medicine Service Alliance
0.0.7 - ci-build
North West Genomic Medicine Service Alliance - Local Development build (v0.0.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
This API for the NW GMSA Clinical Data Repository is based on the following API contracts:
The search parameters are based on FHIR Search which provides detailed description of the parameters and value types.
|
FHIR Profile: Condition
|
Related to HL7 v2 Segment: DG1
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/Condition?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/Condition?identifier=[system|][code] | A unique identifier of the condition record |
| patient | reference | GET [base]/Condition?patient=[id] | Who has the condition? |
|
FHIR Profile: DiagnosticReport
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/DiagnosticReport?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/DiagnosticReport?identifier=[system|][code] | An identifier for the report |
| patient | reference | GET [base]/DiagnosticReport?patient=[id] | id is the logical id of the patient on the server which can be obtained by a Patient query. |
| category | token | GET [base]/DiagnosticReport?category=[system|][code] | Which diagnostic discipline/department created the report |
| code | token | GET [base]/DiagnosticReport?code=[system|][code] | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| date | date | GET [base]/DiagnosticReport?date=[date] | The clinically relevant time of the report |
| _include | GET [base]/DiagnosticReport?_include=DiagnosticResult:[parameter] | ||
| _id | GET [base]/DiagnosticReport?_id=[id] |
Searching for a DiagnosticReport by code (Diagnostic testing for known variant(s)).
GET [base]/DiagnosticReport?code=https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory|R240.1
Accept: application/fhir+json
Searching for a DiagnosticReport by category (Genetics) and patient.
GET [base]/DiagnosticReport?category=http://terminology.hl7.org/CodeSystem/v2-0074|GE&patient=995525
Accept: application/fhir+json
Return a single DiagnosticReport with its associated results (Observation).
GET [base]/DiagnosticReport?_id=46120&_include=DiagnosticReport:result
Accept: application/fhir+json
|
FHIR Profile: Encounter
|
Related to HL7 v2 Segment: PV1
|
This Encounter represents the overall episode or stay, for further information see Interweave Encounter Grouping
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/Encounter?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/Encounter?identifier=[system|][code] | Identifier(s) by which this encounter is known |
| patient | reference | GET [base]/Encounter?patient=[id] | The patient present at the encounter |
| date | date | GET [base]/Encounter?date=[date] | A date within the actualPeriod the Encounter lasted |
Searching for an Encounter by Visit Number.
GET [base]/Encounter?identifier=http://www.acme.org/encounter/identifiers/R0A|1001166717
Accept: application/fhir+json
|
FHIR Profile: Observation
|
Related to HL7 v2 Segment: OBX
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/Observation?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/Observation?identifier=[system|][code] | The unique id for a particular observation |
| patient | reference | GET [base]/Observation?patient=[id] | id is the logical id of the patient on the server which can be obtained by a Patient query. |
| category | token | GET [base]/Observation?category=[system|][code] | The classification of the type of observation |
| code | token | GET [base]/Observation?code=[system|][code] | The code of the observation type |
| date | date | GET [base]/Observation?date=[date] | Obtained date/time. If the obtained element is a period, a date that falls in the period |
| combo-code | token | GET [base]/Observation?combo-code=[system|][code] | The code of the observation type or component type |
Searching for an Observation by code (Genetic variant assessment).
GET [base]/Observation?code=http://loinc.org|69548-6
Accept: application/fhir+json
Searching for a Observation by combo-code (Genomic reference sequence) and patient.
GET [base]/Observation?combo-code=http://loinc.org|48013-7
Accept: application/fhir+json
|
FHIR Profile: Patient
|
Related to HL7 v2 Segment: PID
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/Patient?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/Patient?identifier=[system|][code] | A patient identifier |
Searching for a Patient via NHS Number.
GET [base]/Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9449305552
Accept: application/fhir+json
Searching for a Patient via Medical Record Number.
GET [base]/Patient?identifier=http://www.acme.org/patient/identifier|A12356565
Accept: application/fhir+json
|
FHIR Profile: ServiceRequest
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/ServiceRequest?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/ServiceRequest?identifier=[[system|][code] | Identifiers assigned to this order |
| patient | reference | GET [base]/ServiceRequest?patient=[id] | id is the logical id of the patient on the server which can be obtained by a Patient query. |
| assigner | token | GET [base]/ServiceRequest?assigner=[system|][code] | Assigning Authority (ODS Code) for identifiers assigned to this order |
| code | token | GET [base]/ServiceRequest?code=[system|][code] | What is being requested/ordered |
Searching for a ServiceRequest via Order Placer Number.
GET [base]/ServiceRequest?identifier=http://www.acme.org/servicerequest/identifier|1601737
Accept: application/fhir+json
Searching for a ServiceRequest via Order Placer Number and Assigning Authority. Note in this example the system for assigner and identifier have been omitted.
GET [base]/ServiceRequest?identifier=1601737&assigner=R0A
Accept: application/fhir+json
Searching for a ServiceRequest by code and patient
GET [base]/ServiceRequest?code=https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory|R240.1&patient=995525
Accept: application/fhir+json
|
FHIR Profile: Specimen
|
Related to HL7 v2 Segment: SPM
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/Specimen?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/Specimen?identifier=[system|][code] | The unique identifier associated with the specimen |
| accession | token | GET [base]/Specimen?accession=[system|][code] | The accession number associated with the specimen |
| patient | reference | GET [base]/Specimen?patient=[id] | id is the logical id of the patient on the server which can be obtained by a Patient query. |
Searching for a Specimen via Accession Number.
GET [base]/Specimen?identifier=http://www.example.org/specimen/accession|1001166717
Accept: application/fhir+json
|
FHIR Profile: Task
|
| Parameter | Type | Search | Note |
|---|---|---|---|
| _lastUpdated | date | GET [base]/Task?_lastUpdated=[date] | Date the resource was last updated |
| identifier | token | GET [base]/Task?identifier=[system|][code] | Search for a task instance by its business identifier |
| patient | reference | GET [base]/Task?patient=[id] | id is the logical id of the patient on the server which can be obtained by a Patient query. |
| code | token | GET [base]/Task?code=[system|][code] | Search by task code |
| authored-on | date | GET [base]/Task?authored-on=[date] | Search by creation date |
| requester:identifier | token | GET [base]/Task?requester:identifier=[system|][code] | Search by task requester |
| owner:identifier | token | GET [base]/Task?owner:identifier=[system|][code] | Search by task owner |
| status | token | GET [base]/Task?status=[code] | Search by task status |
Searching for a requested Task for an Organisation.
GET [base]/Task?status=requested&owner:organization=https://fhir.nhs.uk/Id/ods-organization-code|699X0
Accept: application/fhir+json
Searching for updates for to a Task requested by an Organisation since 11th July 2025
GET [base]/Task?requester:organization=https://fhir.nhs.uk/Id/ods-organization-code|R0A&_lastUpdated=ge2025-07-11
Accept: application/fhir+json
IG © 2024+ NHS North West GMSA. Package nw-gmsa.github.io#0.0.7 based on FHIR 4.0.1. Generated 2025-08-20
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change