CSpec-Registry-API.md

@@ -464,6 +464,12 @@ The table below lists the key fields returned in the API response.
 </tr>
 </table>
 
+### Legacy specification documents.
+As per the ClinGen Variant Curation Working Group recommendation a VCEP should be able to maintain and version specifications for a single gene separately. All specifications that are applicable for multiple genes are to be re-released into separate SVI documents.
+
+A legacy document with multiple gene specifications will be fully archived when the attribute `legacyReplaced` is set to `true`. This property will be true only AFTER all the linked specification documents are re-released. 
+For example API to access a legacy document is given here. - `https://genboree.org/cspec/SequenceVariantInterpretation/id/GN023?fields=entContent.legacyReplaced`. All the corresponding individual, single gene specific documents can be accessed via  - `https://genboree.org/cspec/SequenceVariantInterpretation/id/GN023?fields=ld.SequenceVariantInterpretation`. A superseded document fully replaces its legacy document only when the property `entContent.legacyFullySuperseded` is set to true. Identifiers for all the legacy documents in the Registry include - `GN014,GN016,GN004,GN005,GN011,GN018,GN023`
+
 #### Current versions 
 A specification document is valid and has the current version if it meets the following criteria in this order