Abbreviations, should these be handled

[dih-cdisc]

Do we need to handle abbreviations. Currently we can place these in NarrativeContent without issue but we see repeated definitions. A lot of them will be common across protocols.

Child tickets:

Item	Ticket
Model	#422
CT	#424
API	#423
Rules	#426
IG	#425
Test Data	#424

[dih-cdisc]

Some examples, all from the same protocol

• Example 1

• Example 2

• Example 3

• Example 4

• Example 5

[dih-cdisc]

M11 Template includes Section 13

13 APPENDIX: GLOSSARY OF TERMS AND ABBREVIATIONS

Define abbreviations and other terms used in the protocol. A tabular presentation is common and may serve as the definition at first use.

[dih-cdisc]

They are name, label pairs, so like dictionary entries. Here the "tag" is visible whereas the tag is "hidden" in dictionaries.

[BSnoeijerCD]

As discussed with @dih-cdisc last Monday: the first iteration of how abbreviations could be stored: use cases:

• abbreviation tags can be reused throughout the document
• making sure all abbreviations tagged are included in the full list of abbreviations
• an interactive implementation can show the description when a user hoovers over the abbreviation
• shortlists of abbreviations can be shown below an (SoA) table automatically for all abbreviations used in this table.

UML proposal:

To discuss:

• link from studyDefinitionDocumentVersion? -> should be separate from the documentVersion as they can be reused across different documents. => so link to StudyVersion is more appropriate.
• is tag needed? -> We want to include it in NarrativeContentItem.text. HTML narrative content text includes actual variable references. No tags.
• attribute and reference names OK?

[BSnoeijerCD]

As discussed during scrum today

• classname = abbreviation
• attributes:
  • abbreviation
  • longName
  • notes (to allow for grouping and reference to codes etc)
• relate class to StudyVersion; Abbreviations can also be tagged and used in for example eligibility criteria, conditions, objectives and endpoint.
  • note that the abbreviation and corresponding long name will then be a specific reference in the parameterMap class related to a specific syntaxTemplateDictionary.
• reference to CDISC glossary will be added. though the model will not be limited to abbreviations in this glossary.

[BSnoeijerCD]

@EMuhlbradt @czwickl Please see the model updates based on our discussions below for your review:

[BSnoeijerCD]

@EMuhlbradt @czwickl : model updates for abbreviations are now in the 4_5 branch.

For the IG we can show how this works in practice for narrative content text as well as syntax templates.