/
2024 Transition plan for Annotations

2024 Transition plan for Annotations

2024-Nov-05

Action item

Implementer

Planned timeline

Action item

Implementer

Planned timeline

Development work to prep AP, snowstorm, release systems, etc

  • MAINT-2493 - Annotations: Change annotations refset column languageCode to languageDialectCode (this relates to content stored in the Terminology Server, rather than the column headings in the file) - complete

  • INFRA-12849 - Annotations: Change annotations refset column languageCode to languageDialectCode - complete

  • INFRA-12258 - Add attribution to Orphanet - in progress

  • INFRA-12737 and INFRA-12763 these relate to the data type metadata we declare for these two refsets in the Refset Descriptor - now complete.

PWI will be starting to add attributions to Production w/b 13 May 2024 and we also need to test out a release that pulls refset descriptor changes from Snowstorm rather than an externally maintained S3 folder.

Peter Williams

 

To be deployed to Prod in the May 2024 Dev release...

COMPLETED ON SCHEDULE

Changes to the Annotations Refset format:

  • The languageCode field was specified as the two characters of ISO-639-1 code for the language of the annotation text.

    • The change is to include support for specifying dialect when it is applicable by adhering to RFC 5646.

    • This allows the combination of two characters of ISO 639-1 code and two uppercase letters of country code (ISO 3166) separated by a hyphen.

  • The "languageCode" will be changed to "languageDialectCode" in the field column of BOTH REFSETS. (see https://projects.jira.snomed.org/browse/INFRA-12849)

    • The metadata concept 1304275002 |Language or dialect code (foundation metadata concept)| will be used for the metadata of this column in the descriptor refset.

  • The changes will apply to both the Member Annotation String Value reference set + Component Annotation String Value reference set

    • CONFIRMED IN VERSION 2 OF THE JUNE 2024 PreProd RELEASE:

      • Component Annotations (1292992004)

        • < id    effectiveTime    active    moduleId    refsetId    referencedComponentId    languageCode    typeId    value
          ---
          > id    effectiveTime    active    moduleId    refsetId    referencedComponentId    languageDialectCode    typeId    value

      • Member Annotations (1292995002)

        • < id    effectiveTime    active    moduleId    refsetId    referencedComponentId    referencedMemberId    languageCode    typeId    value
          ---
          > id    effectiveTime    active    moduleId    refsetId    referencedComponentId    referencedMemberId    languageDialectCode    typeId    value

NOTE:

  1. EDITIONS & EXTENSIONS REQUIRE SAME CHANGES AS INT EDITION (above)

 

Andrew Atkinson

(+ tested by Yong)

To be released in the JUNE 2024 INT Edition release...

COMPLETED ON SCHEDULE

Changes to the Annotations documentation made on 31/05/2024:

Andrew Atkinson +

Yongsheng Gao

To be completed before the JUNE 2024 INT Edition release...

COMPLETED ON SCHEDULE

Fixes to the refsetDescriptor records (see INFRA-12737 for details):

  • 1. The AttributeType for the (attributeOrder=0) refsetDescriptor record for both Member + Component Annotations needs to be changed from:

    • 900000000000461009 |Concept type component|

      • to

    • 900000000000460005 |Component type (foundation metadata concept)|

    • (see comments in 5.2.4.9 Member Annotation String Value Reference Set + https://jira.ihtsdotools.org/browse/INFRA-12763 for details)

      • CONFIRMED IN VERSION 2 OF THE JUNE 2024 PreProd RELEASE:

        • < 6cc1d4ca-32fd-44cb-8ad3-e49f23ec7760    20231201    1    900000000000012004    900000000000456007    1292992004    900000000000518009    900000000000461009    0
          ---
          > 6cc1d4ca-32fd-44cb-8ad3-e49f23ec7760    20240601    1    900000000000012004    900000000000456007    1292992004    900000000000518009    900000000000460005    0

        • < f6d9647b-6ee6-400d-9c7f-77818fa1f986    20231201    1    900000000000012004    900000000000456007    1292995002    900000000000518009    900000000000461009    0
          ---
          > f6d9647b-6ee6-400d-9c7f-77818fa1f986    20240601    1    900000000000012004    900000000000456007    1292995002    900000000000518009    900000000000460005    0

      • Need cross check from Yong/Peter/Maria...CONFIRMED VIA EMAIL AT 11:19 on 14/05/2024

      • Need verification in final Prod release for June 2024...CONFIRMED 15/05/2024 - International Edition Traceability matrix (June 2024)

  • .

  • 2. The languageDialect column for a) the (attributeOrder=2) refsetDescriptor record for Member Annotations + b) the (attributeOrder=1) refsetDescriptor record for Component Annotations

  • , needs to be changed from:

    • 1296895003 |Language code (foundation metadata concept)|

      • to the new concept

    • 1304275002 |Language or dialect code (foundation metadata concept)|

    • (see comments in https://jira.ihtsdotools.org/browse/MAINT-2493)

    • .

    • SORRY @Peter Williams - the refsetDescriptor records in MAIN have been updated as per items 1 & 3 (above and below), but haven't had the Language Code value changed to the new one

      • - which should now be 1304275002 as specified by Yong above:

  •  

    •  

      • 2c0d0378-c28c-4705-b8af-f5f0f8276dfd    20231201    1    900000000000012004    900000000000456007    1292992004    1296895003    900000000000465000    1

      • afe9824b-1323-4407-a0b7-a028ae2b780a    20231201    1    900000000000012004    900000000000456007    1292995002    1296895003    900000000000465000    2

    • .

    • Confirmed now working in Version 1 of the May 2024 Prod INT Edition release - International Edition Traceability matrix (June 2024)

    • .

  • 3. The AttributeType for a) the (attributeOrder=4) refsetDescriptor record for Member Annotations (1292995002) + b) the (attributeOrder=3) refsetDescriptor record for Component Annotations (1292992004), needs to be changed from:

NOTE:

  1. EDITIONS REQUIRE SAME CHANGES AS INT EDITION (above)

  2. EXTENSIONS REQUIRE NO CHANGES, because as per the spec (5.2.4.1 Reference Set Descriptor):

    1. Creation of a Reference set descriptor is optional when creating a reference set in another Extension. If a descriptor is not created, the descriptor of the closest ancestor of the reference set is used when validating reference set member records.

    2. This is the same approach as all other International refsets that are also included in the Extensions - MRCM Refsets, SimpleRefset, SimpleMapRefset, etc.  They are NOT included in the Extensions RefsetDescriptor files, and are included in the Edition RefsetDescriptor files only because they are part of the International module and are therefore included as part of the International content that comprises the Edition packages.

Andrew Atkinson

(+ tested by Yong)

To be released in the July 2024 INT Edition release...

COMPLETED ON SCHEDULE

Copyright © 2025, SNOMED International