/
Annotations specification

Annotations specification

2023-Oct-26

This space is to specify, review and feedback on the SI Release Management plan to roll out Annotations.

Background:

Decisions made:

  • We have agreed to draw a distinction between data and metadata annotations -

    • ...for now we will use the new annotations refsets (specified below) to annotate metadata only

    • ...Data annotations will be addressed using additional relationships. 

  • The only remaining question will then be how to distinguish between what is technically data vs metadata -

    • note:  we may require a review board to manage this...

  • Content team agreements:



To Review:

Review Item

Internal Sign Off?

External Sign Off?

Review Item

Internal Sign Off?

External Sign Off?

1

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







2

Proposed RF2 Packaging formats:



  • International Edition



  • Extensions



  • Derivatives







3

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







4

Documentation:







5

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)







6

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







Copyright © 2026, SNOMED International