Skip to content

Clinical Interpretation Portal-API

The Clinical Interpretation Portal (CIP)-API serves four functions:

  1. It communicates with the NHS GLH user and the Decision Support Systems (DSS) regarding which cases are ready for interpretation. It does this by creating an “Interpretation Request” which is sent to Interpretation Services (e.g., Tiering & Exomiser) and DSS and is visible from the CIP-API web services.

  2. When an Interpretation Service generates an “Interpreted Genome”, it pushes this information back to the CIP-API. These data are appended to the Interpretation Request for the case and can be accessed through the CIP-API web services.

  3. If an NHS GLH user selects a variant as a Primary Finding in the Interpretation Portal (or DSS) user interface and decides to produce a Summary of Findings, the Portal and / or DSS pushes this information as a “ClinicalReport” to the CIP-API. The “ClinicalReport” is appended to the InterpretationRequest for the case.

  4. Via the Interpretation Portal, the CIP-API displays the case status and the ClinicalReport.json as an HTML page visible to the NHS GLH user.

Note

Further information about how to access and query the API and all the endpoints are documented here: https://cipapi-documentation.genomicsengland.co.uk/