FHIRsmith: CapabilityStatement/CapabilityStatement-HealthDataAPI.json

FHIR IG analytics

Package	fhir.nwgenomics.nhs.uk
Resource Type	CapabilityStatement
Id	CapabilityStatement-HealthDataAPI.json
FHIR Version	R4
Source	https://build.fhir.org/ig/nw-gmsa/nw-gmsa.github.com/CapabilityStatement-HealthDataAPI.html
URL	https://fhir.nwgenomics.nhs.uk/CapabilityStatement/HealthDataAPI
Version	0.2.1
Status	draft
Date	2026-03-08
Name	EURIDICE Health Data API
Title	CapabilityStatement for NW Genomics Genomic Data Repository (EURIDICE Health Data API)
Realm	us
Authority	hl7
Description	Is based on [EURIDICE Health Data API](https://euridice.org/eu-health-data-api/), which we are using as FHIR R4 version of [Care Connect API](https://nhsconnect.github.io/CareConnectAPI/) The `OpenAPISwagger Definition file` below, can be viewed using [Swagger Editor](https://editor.swagger.io/)
Kind	capability

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
fhir.nwgenomics.nhs.uk#current	Binary	Binary
fhir.nwgenomics.nhs.uk#current	DiagnosticReport	Diagnostic Report
fhir.nwgenomics.nhs.uk#current	DocumentReference	DocumentReference
fhir.nwgenomics.nhs.uk#current	Observation	Observation
fhir.nwgenomics.nhs.uk#current	Patient	Patient

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement HealthDataAPI

CapabilityStatement for NW Genomics Genomic Data Repository (EURIDICE Health Data API)

Implementation Guide Version: 0.2.1
FHIR Version: 4.0.1
Supported Formats: application/fhir+xml, application/fhir+json
Published on: 2026-03-08
Published by: NHS North West Genomics

Note 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.

FHIR RESTful Capabilities

Mode: `server`

Security

Enable CORS: no

Security services supported: OAuth

Recommend IHE-IUA

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	Searches
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

Resource Conformance: SHALL Patient

Base System Profile
Patient

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support read, search-type.

Documentation

EURIDICE Patient Matching - IHE Patient Demographics Query for Mobile (PDQm) Mobile Patient Demographics Query [ITI-78]

Search Parameters

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

Resource Conformance: SHALL Binary

Base System Profile
Binary

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support read.

Documentation

EURIDICE Document Exchange - IHE Mobile access to Health Documents (MHD) Retrieve Document [ITI-68]

Resource Conformance: SHALL DocumentReference

Base System Profile
DocumentReference

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support read, search-type.

Documentation

EURIDICE Document Exchange - IHE Mobile access to Health Documents (MHD) Find Document References [ITI-67]

Resource Conformance: SHALL DiagnosticReport

Base System Profile
Diagnostic Report

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support read, search-type.

Documentation

EURIDICE Resource access - Query for Existing Data for Mobile (QEDm) Mobile Query Existing Data [PCC-44]

Search Parameters

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

Combined Search Parameters

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`

Resource Conformance: SHALL Observation

Base System Profile
Observation

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support read, search-type.

Documentation

EURIDICE Resource access - Query for Existing Data for Mobile (QEDm) Mobile Query Existing Data [PCC-44]

Search Parameters

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

Combined Search Parameters

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`

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "HealthDataAPI",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.nwgenomics.nhs.uk/CapabilityStatement/HealthDataAPI",
  "version": "0.2.1",
  "name": "EURIDICE Health Data API",
  "title": "CapabilityStatement for NW Genomics Genomic Data Repository (EURIDICE Health Data API)",
  "status": "draft",
  "experimental": false,
  "date": "2026-03-08",
  "publisher": "NHS North West Genomics",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nwgenomics.nhs.uk/contact-us"
        }
      ]
    }
  ],
  "description": "Is based on [EURIDICE Health Data API](https://euridice.org/eu-health-data-api/), which we are using as FHIR R4 version of [Care Connect API](https://nhsconnect.github.io/CareConnectAPI/)\n\nThe `OpenAPISwagger Definition file` below, can be viewed using [Swagger Editor](https://editor.swagger.io/)",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB",
          "display": "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind": "capability",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "OAuth"
              }
            ]
          }
        ],
        "description": "Recommend [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "profile": "https://fhir.nwgenomics.nhs.uk/StructureDefinition/Patient",
          "documentation": "EURIDICE Patient Matching - IHE Patient Demographics Query for Mobile (PDQm) [Mobile Patient Demographics Query [ITI-78]](https://profiles.ihe.net/ITI/PDQm/ITI-78.html)",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "type": "token",
              "documentation": "Whether the patient record is active"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "family",
              "type": "string",
              "documentation": "A portion of the family name of the patient"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "given",
              "type": "string",
              "documentation": "A portion of the given name of the patient"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token",
              "documentation": "A patient identifier"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "telecom",
              "type": "token",
              "documentation": "The value in any kind of telecom details of the patient"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "birthdate",
              "type": "date",
              "documentation": "The patient's date of birth"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address",
              "type": "string",
              "documentation": "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "gender",
              "type": "token",
              "documentation": "Gender of the patient"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Binary",
          "profile": "https://fhir.nwgenomics.nhs.uk/StructureDefinition/Binary",
          "documentation": "EURIDICE Document Exchange - IHE Mobile access to Health Documents (MHD) [Retrieve Document [ITI-68]](https://profiles.ihe.net/ITI/MHD/ITI-68.html)",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "profile": "https://fhir.nwgenomics.nhs.uk/StructureDefinition/DocumentReference",
          "documentation": "EURIDICE Document Exchange - IHE Mobile access to Health Documents (MHD) [Find Document References [ITI-67]](https://profiles.ihe.net/ITI/MHD/ITI-67.html)",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "code"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "code"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "DiagnosticReport",
          "profile": "https://fhir.nwgenomics.nhs.uk/StructureDefinition/DiagnosticReport",
          "documentation": "EURIDICE Resource access - Query for Existing Data for Mobile (QEDm) [Mobile Query Existing Data [PCC-44]](https://build.fhir.org/ig/IHE/QEDm/branches/master/PCC-44.html)",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "type": "token",
              "documentation": "The classification of the type of observation"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "type": "token",
              "documentation": "The code of the observation type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "type": "date",
              "documentation": "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "reference",
              "documentation": "Search by subject - a patient"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "code"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "category"
                },
                {
                  "url": "required",
                  "valueString": "code"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "Observation",
          "profile": "https://fhir.nwgenomics.nhs.uk/StructureDefinition/Observation",
          "documentation": "EURIDICE Resource access - Query for Existing Data for Mobile (QEDm) [Mobile Query Existing Data [PCC-44]](https://build.fhir.org/ig/IHE/QEDm/branches/master/PCC-44.html)",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "type": "token",
              "documentation": "The classification of the type of observation"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "type": "token",
              "documentation": "The code of the observation type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token",
              "documentation": "The status of the observation type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "type": "date",
              "documentation": "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "reference",
              "documentation": "Search by subject - a patient"
            }
          ]
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

CapabilityStatement for NW Genomics Genomic Data Repository (EURIDICE Health Data API)

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Patient

Resource Conformance: SHALL Binary

Resource Conformance: SHALL DocumentReference

Resource Conformance: SHALL DiagnosticReport

Resource Conformance: SHALL Observation

Source1

Mode: `server`