Genomics England Clinical Interpretation API (CIP-API)

Genomics England Limited processes the genomes of families and cancer participants as part of the 100,000 genomes project as well as for the NHS Genomics Medicine Service (GMS). Genomics England makes the results available to Genomic Medicine Centres (GMCs) and Genomic Laboratory Hubs (GLHs) respectively through decision support tools provided by Decision Support Systems (DSSs) chosen by Genomics England.

The Genomics England Clinical Interpretation API was built to enable Genomics England to communicate data to and from DSSs. Furthermore it acts as a backend to systems such as the Genomics England Interpretation Portal and interfaces with the Clinical Variant Ark (CVA) - note CVA is only accessible on HSCN.

The aim of this documentation is to guide the user through the basic use cases of the CIP-API.

Python and bash code will be used to illustrate a call to the webservices, but this can be extrapolated to any other language. This application also provides a friendly web interface to use the webservices that can be used to get familiar with its usage.

Not all the endpoints will be covered in this documentation but a full list with a Swagger user interface can be found on the api/2/docs endpoint of any of the CIP-API instances. For example, the production CIP-API swagger user interface is found here: https://cipapi.genomicsengland.nhs.uk/api/2/docs

Note

The swagger user interface for api/1 endpoints is no longer available.

Attention

You can only access the production CIP-API while on the NHS N3 (HSCN) network