CIP-API Data Description¶
The aim of this "Data Description" section is to describe the data associated with a GMS referral in the CIP-API.
Scope¶
The data described in this section are examples obtained when querying the endpoints /api/2/interpretation-request and /api/2/interpretation-request/{id}/{version}, with the query parameter: ?extra_params=show_referral.
Note
The show_referral parameter adds to data returned the GMS specific referral information - it is not applicable
for 100K cases
The ?extra_params=show_referral parameter when applied to either of the CIP-API endpoints above, adds the GMS Referral
information i.e. details of the WGS test ordered through the Test Order Management System (TOMS) in the Referral model
object format (see below) to the CIP-API data returned by that endpoint.
Note
There additional endpoints in the CIP-API that are not currently covered by this document
Known GMS Data Issues / Future improvements¶
- The groupOfVariants field is not populated in Clinical Reports generated in Congenica. This means variants reported as compound heterozygous in Congenica are not grouped as expected in the outcomes questionnaire. Internal ticket reference: BPS-64