Abbreviations, should these be handled [Rules]

cdisc-org / DDF-RA

This is the repository for all code and documentation for the DDF-RA project.

MIT License

17 stars 1 forks source link

Abbreviations, should these be handled [Rules] #426

Closed BSnoeijerCD closed 3 weeks ago

BSnoeijerCD commented 1 month ago

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.

See feature ticket #308

BSnoeijerCD commented 1 month ago

An abbreviation must be unique - case sensitive
A long name is expected to be unique for each abbreviation - not case sensitive

To consider:

Are spaces allowed in abbreviations?

ASL-rmarshall commented 1 month ago

@BSnoeijerCD Corresponding checks have been added to the RuleRequirements_v4 spreadsheet and are ready for your review:	Check_ID	Textual statement of rule	Warning/Error	Version 3.0	Version 4.0
CHK0191	All abbreviations defined for a study version must be unique.	ERROR	N	Y
CHK0192	The long names for all abbreviations defined for a study version are expected to be unique.	WARNING	N	Y

BSnoeijerCD commented 3 weeks ago

@BSnoeijerCD Corresponding checks have been added to the RuleRequirements_v4 spreadsheet and are ready for your review:

Check_ID Textual statement of rule Warning/Error Version 3.0 Version 4.0 CHK0191 All abbreviations defined for a study version must be unique. ERROR N Y CHK0192 The long names for all abbreviations defined for a study version are expected to be unique. WARNING N Y

@daveih : If you agree: I can add these to the Rules list and include them in the 3.5 release.

BSnoeijerCD commented 3 weeks ago

@dih-cdisc : added rules and pushed to Github.