... | @@ -3,43 +3,55 @@ |
... | @@ -3,43 +3,55 @@ |
|
[[_TOC_]]
|
|
[[_TOC_]]
|
|
|
|
|
|
## A. Actionability APIs
|
|
## A. Actionability APIs
|
|
Find detailed documentation on [Actionability APIs] here - ()
|
|
|
|
|
|
Find detailed documentation on \[Actionability APIs\] here - ()
|
|
|
|
|
|
## B. Actionability Messaging Services
|
|
## B. Actionability Messaging Services
|
|
|
|
|
|
### B.1 BRL Internal Pulsar
|
|
### B.1 BRL Internal Pulsar
|
|
|
|
|
|
### B.2 ClinGen Data Exchange Kafka Services
|
|
### B.2 ClinGen Data Exchange Kafka Services
|
|
|
|
|
|
#### B.2.1 _Actionability_ topic
|
|
#### B.2.1 _Actionability_ topic
|
|
|
|
|
|
This topic tracks curation events of an actionability topic. The events are tracked per context - Adult or Pediatric.
|
|
This topic tracks curation events of an actionability topic. The events are tracked per context - Adult or Pediatric.
|
|
|
|
|
|
> Check API PRODUCTION endpoint that generates the message content based on the current status of the topic:
|
|
> Check API PRODUCTION endpoint that generates the message content based on the current status of the topic:
|
|
> - Adult - https://actionability.clinicalgenome.org/ac/Adult/api/doc/AC002.json?flavor=wag
|
|
>
|
|
> - Pediatric - https://actionability.clinicalgenome.org/ac/Pediatric/api/doc/AC002.json?flavor=wag
|
|
> - Adult - <https://actionability.clinicalgenome.org/ac/Adult/api/doc/AC002.json?flavor=wag>
|
|
|
|
> - Pediatric - <https://actionability.clinicalgenome.org/ac/Pediatric/api/doc/AC002.json?flavor=wag>
|
|
|
|
|
|
> Given below are the STAGE equivalent of the production API endpoints:
|
|
> Given below are the STAGE equivalent of the production API endpoints:
|
|
> - Adult - https://actionability.test.genome.network/ac/Adult/api/doc/AC002.json?flavor=wag
|
|
>
|
|
> - Pediatric - https://actionability.test.genome.network/ac/Pediatric/api/doc/AC002.json?flavor=wag
|
|
> - Adult - <https://actionability.test.genome.network/ac/Adult/api/doc/AC002.json?flavor=wag>
|
|
|
|
> - Pediatric - <https://actionability.test.genome.network/ac/Pediatric/api/doc/AC002.json?flavor=wag>
|
|
|
|
|
|
#### B.2.2 Version 1
|
|
#### B.2.2 Version 1
|
|
|
|
|
|
Version 1 of the actionability topic message is gene-condition specific. Follow the schema and example documents given below:
|
|
Version 1 of the actionability topic message is gene-condition specific. Follow the schema and example documents given below:
|
|
|
|
|
|
- Schema - [schema_1.0.0_AV1.json5](uploads/20e1a283b86d43b0624da880be661ae9/schema_1.0.0_AV1.json5)
|
|
- Schema - [schema_1.0.0_AV1.json5](uploads/20e1a283b86d43b0624da880be661ae9/schema_1.0.0_AV1.json5)
|
|
- Example messages
|
|
- Example messages
|
|
|
|
|
|
> 1. In Prep state - [AC1056_in_prepration.json](uploads/64f85e97c4201ee3b35c0cfe5a555be2/AC1056_in_prepration.json)
|
|
> 1. In Prep state - [AC1056_in_prepration.json](uploads/64f85e97c4201ee3b35c0cfe5a555be2/AC1056_in_prepration.json)
|
|
> 2. Released state - [AC001_released.json](uploads/3890b3cedd37b6f53177c11e00ce6019/AC001_released.json)
|
|
> 2. Released state - [AC001_released.json](uploads/3890b3cedd37b6f53177c11e00ce6019/AC001_released.json)
|
|
> 3. Released - under revision state - [AC061_released_under_revision.json](uploads/25b7ca698780f5c7f3819a98bb526162/AC061_released_under_revision.json)
|
|
> 3. Released - under revision state - [AC061_released_under_revision.json](uploads/25b7ca698780f5c7f3819a98bb526162/AC061_released_under_revision.json)
|
|
|
|
|
|
#### B.2.2 Version 2
|
|
#### B.2.2 Version 2
|
|
|
|
|
|
Version 2 of the actionability topic message supports both gene-condition AND variant-condition specific curation topics. Follow the schema and example documents given below:
|
|
Version 2 of the actionability topic message supports both gene-condition AND variant-condition specific curation topics. Follow the schema and example documents given below:
|
|
|
|
|
|
- Schema - [schema_2.0.0.json5](uploads/f77a8404f3aaf2dd7b7b414f2a9887df/schema_2.0.0.json5)
|
|
- Schema - [schema_2.0.0.json5](uploads/f77a8404f3aaf2dd7b7b414f2a9887df/schema_2.0.0.json5)
|
|
- Example messages
|
|
- Example messages
|
|
|
|
|
|
> 1. Gene-Condition Released state - [AC001_gc_released.json](uploads/4f622166867893eee061a7b110cf2f3a/AC001_gc_released.json)
|
|
> 1. Gene-Condition Released state - [AC001_gc_released.json](uploads/4f622166867893eee061a7b110cf2f3a/AC001_gc_released.json)
|
|
> 2. Variant-Condition Released state[AC1060_vc_released.json](uploads/430a74dafae2af6f77982e223925e632/AC1060_vc_released.json)
|
|
> 2. Variant-Condition Released state[AC1060_vc_released.json](uploads/430a74dafae2af6f77982e223925e632/AC1060_vc_released.json)
|
|
|
|
|
|
Summary of schema change
|
|
**Summary of schema change (1.0.0 to 2.0.0)**
|
|
- Property jsonMessageVersion domain definition changed to semantic version
|
|
|
|
- New property curationType
|
|
|
|
- New property variants. Note it is EITHER genes or variants based on the curationType property
|
|
|
|
|
|
|
|
|
|
- Property `jsonMessageVersion` domain definition changed to semantic version
|
|
|
|
- New property `curationType`
|
|
|
|
- New property `variants`. Note it is EITHER `genes` or `variants` based on the `curationType` property.
|
|
|
|
- All the properties, `conditions, preferred_conditions, assertions` and `scores` will EITHER contain the gene or variant properties.
|
|
|
|
|
|
## C. [Chromosomal Abnormalities](https://genboree.org/gitlab/clingen/actionability/-/wikis/Chromosomal-Abnormalities) |
|
## C. [Chromosomal Abnormalities](https://genboree.org/gitlab/clingen/actionability/-/wikis/Chromosomal-Abnormalities) |
|
|
|
\ No newline at end of file |