NHS North West Genomics
0.2.1 - ci-build
NHS North West Genomics - Local Development build (v0.2.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.nwgenomics.nhs.uk/CapabilityStatement/HealthDataAPI | Version: 0.2.1 | |||
| Draft as of 2026-03-08 | Computable Name: EURIDICE Health Data API | |||
Is based on EURIDICE Health Data API, which we are using as FHIR R4 version of Care Connect API
The OpenAPISwagger Definition file below, can be viewed using Swagger Editor
Examples and API documentation can be found on:
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml, application/fhir+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | https://fhir.nwgenomics.nhs.uk/StructureDefinition/Patient | Y | Y | _id, active, family, given, identifier, telecom, birthdate, address, gender | |||||
| Binary | https://fhir.nwgenomics.nhs.uk/StructureDefinition/Binary | Y | |||||||
| DocumentReference | https://fhir.nwgenomics.nhs.uk/StructureDefinition/DocumentReference | Y | Y | ||||||
| DiagnosticReport | https://fhir.nwgenomics.nhs.uk/StructureDefinition/DiagnosticReport | Y | Y | category, code, date, patient, patient+category, patient+category+code, patient+category+date, patient+category+code+date | |||||
| Observation | https://fhir.nwgenomics.nhs.uk/StructureDefinition/Observation | Y | Y | category, code, status, date, patient, patient+category, patient+category+code, patient+category+date, patient+category+code+date |
read, search-type.EURIDICE Patient Matching - IHE Patient Demographics Query for Mobile (PDQm) Mobile Patient Demographics Query [ITI-78]
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | active | token | Whether the patient record is active |
| SHALL | family | string | A portion of the family name of the patient |
| SHALL | given | string | A portion of the given name of the patient |
| SHALL | identifier | token | A patient identifier |
| SHALL | telecom | token | The value in any kind of telecom details of the patient |
| SHALL | birthdate | date | The patient's date of birth |
| SHALL | address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| SHALL | gender | token | Gender of the patient |
read.EURIDICE Document Exchange - IHE Mobile access to Health Documents (MHD) Retrieve Document [ITI-68]
read, search-type.EURIDICE Document Exchange - IHE Mobile access to Health Documents (MHD) Find Document References [ITI-67]
read, search-type.EURIDICE Resource access - Query for Existing Data for Mobile (QEDm) Mobile Query Existing Data [PCC-44]
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | The classification of the type of observation |
| SHALL | code | token | The code of the observation type |
| SHALL | date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period. The date modifiers ge,le,gt,lt SHALL be supported. |
| SHALL | patient | reference | Search by subject - a patient |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+category | reference+token |
| SHALL | patient+category+code | reference+token+token |
| SHALL | patient+category+date | reference+token+date |
| SHOULD | patient+category+code+date | reference+token+token+date |
read, search-type.EURIDICE Resource access - Query for Existing Data for Mobile (QEDm) Mobile Query Existing Data [PCC-44]
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | The classification of the type of observation |
| SHALL | code | token | The code of the observation type |
| SHALL | status | token | The status of the observation type |
| SHALL | date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period. The date modifiers ge,le,gt,lt SHALL be supported. |
| SHALL | patient | reference | Search by subject - a patient |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+category | reference+token |
| SHALL | patient+category+code | reference+token+token |
| SHALL | patient+category+date | reference+token+date |
| SHOULD | patient+category+code+date | reference+token+token+date |