Proposed specifications for the new refset types for the agreed implementation of Annotations:

•  

  • https://confluence.ihtsdotools.org/display/TRAG/Member+Annotations+String+Value+Reference+Set

  • https://confluence.ihtsdotools.org/display/TRAG/Component+Annotations+String+Value+Reference+Set

Proposed RF2 Packaging formats:

• International Edition

•  

  • der2_sscsRefset_MemberAnnotationStringValueSnapshot_INT_[date].txt

    • NOTE:  This is because the additional columns in this Refset file as as follows:

      • s (string) = text field containing the "languageCode"

      • s (string) = UUID referencing the "referencedMemberId"

        • (is "s" correct here?  As "i" (detailed here:  3.3.2 Release File Naming Convention) is a SIGNED Integer, whereas UUID's are UNSIGNED integers)

      • c (SCTID) = SCTID referencing the "annotationTypeId"

      • s (string) = text field containing the "annotationValue"

  • der2_scsRefset_ComponentAnnotationStringValueSnapshot_INT_[date].txt

    • NOTE:  This is because the additional columns in this Refset file as as follows:

      • s (string) = text field containing the "languageCode"

      • c (SCTID) = SCTID referencing the "annotationTypeId"

      • s (string) = text field containing the "annotationValue"

• Extensions

•  

  • der2_sscsRefset_MemberAnnotationStringValueSnapshot_[CountryCode + Namespace]_[date].txt

    • (eg)

      • der2_sscsRefset_MemberAnnotationStringValueSnapshot_IE1000220_20240421.txt

  • der2_scsRefset_ComponentAnnotationStringValueSnapshot_[CountryCode + Namespace]_[date].txt

    • (eg)

      • der2_scsRefset_ComponentAnnotationStringValueSnapshot_IE1000220_20240421.txt

• Derivatives

•  

  • der2_sscsRefset_[derivative name]MemberAnnotationStringValueSnapshot_INT_[date].txt
    
    

    • (eg)

      • der2_sscsRefset_OrphanetMemberAnnotationStringValueSnapshot_INT_20240131.txt

  • der2_scsRefset_[derivative name]ComponentAnnotationStringValueSnapshot_INT_[date].txt
    
    

    • (eg)

      • der2_scsRefset_OrphanetComponentAnnotationStringValueSnapshot_INT_20240131.txt

Proposed RF2 Packaging composition:

• The current proposal is for the 2x new refsets to be held in the /Refset/Metadata subfolders

  • (eg)

    • Full/Refset/Metadata/der2_scsRefset_MemberAnnotationStringValueSnapshot_INT_20240101.txt

    • Snapshot/Refset/Metadata/der2_scsRefset_ComponentAnnotationStringValueSnapshot_INT_20240101.txt

Documentation:

• Release File Specification:

  • https://confluence.ihtsdotools.org/display/DOCRELFMT/SNOMED+CT+Release+File+Specifications?src=sidebar

• Glossary

  • https://confluence.ihtsdotools.org/display/DOCGLOSS/SNOMED+Glossary

• Anything else???

Annotations Usage Guidelines (Best Practice):

• Actual recommended Best Practice approach to annotating content needs to be agreed with Content Team, MAG, etc

• Should be usable + flexible BUT also constrained enough to be standardised across all Products + Implementations

  • (otherwise just a free for all where the resulting data will not be usable)

Communications:

• Communicate the intention to implement all of these changes to the Member Forum

• Communicate the new Refsets in the International Edition to the users

• Communicate the new Metadata concepts in the International Edition to the users

• Communicate the Best Practice for creating Annotations

• Communicate the Best Practice for consuming Annotations