CDS Annotation with comments

[jrodriguez-rc]

If a CDS annotation has comments, formatting don't work:

  @UI.facet: [ // Header
               { id:              'HeaderData',
                 purpose:         #HEADER,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'HeaderData',
                 position:        10,
                 hidden:          true },
               { id:              'HeaderPatientData',
                 purpose:         #HEADER,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'HeaderPatientData',
                 position:        20,
                 label:           'Patient',
                 hidden:          #( HidePatient ) },
               { id:              'HeaderAddressData',
                 purpose:         #HEADER,
                 type:            #FIELDGROUP_REFERENCE,
                 label:           'Main Address',
                 targetQualifier: 'HeaderAddressData',
                 position:        30 },
               { id:              'HeaderCommunicationData',
                 purpose:         #HEADER,
                 type:            #FIELDGROUP_REFERENCE,
                 label:           'Standard Communication',
                 targetQualifier: 'HeaderCommunicationData',
                 position:        40 },
               // Basic data
               { id:              'BasicData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Basic Data',
                 targetQualifier: 'BasicData',
                 position:        10 },
               // General information
               { id:              'GeneralData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'General Information',
                 targetQualifier: 'GeneralData',
                 parentId:        'BasicData',
                 position:        10 },
               { id:              'NameInformation',
                 purpose:         #STANDARD,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'NameInformation',
                 parentId:        'GeneralData',
                 position:        10 },
               { id:              'IdInformation',
                 purpose:         #STANDARD,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'IdInformation',
                 parentId:        'GeneralData',
                 position:        20 },
               { id:              'GeneralInformation',
                 purpose:         #STANDARD,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'GeneralInformation',
                 parentId:        'GeneralData',
                 position:        30 },
               { id:              'MoreInformation',
                 purpose:         #STANDARD,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'MoreInformation',
                 parentId:        'GeneralData',
                 position:        40,
                 isPartOfPreview: false },
               { id:              'AdministrativeData',
                 purpose:         #STANDARD,
                 type:            #FIELDGROUP_REFERENCE,
                 targetQualifier: 'AdministrativeData',
                 parentId:        'GeneralData',
                 position:        50,
                 isPartOfPreview: false },
               // Identifiers
               { id:              'PatientIdentifier',
                 purpose:         #STANDARD,
                 type:            #LINEITEM_REFERENCE,
                 position:        80,
                 label:           'Identifier',
                 targetElement:   '_Identifier' },
               // Address
               { id:              'AddressData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Address Data',
                 targetQualifier: 'AddressData',
                 position:        100 },
               { id:            '/RHP/R_PersonAddressTP',
                 type:          #LINEITEM_REFERENCE,
                 parentId:      'AddressData',
                 targetElement: '_Address' },
               // Contact
               { id:              'PatientContact',
                 purpose:         #STANDARD,
                 type:            #LINEITEM_REFERENCE,
                 position:        110,
                 label:           'Contact',
                 targetElement:   '_Contact' },
               // Link
               { id:              'PatientLink',
                 purpose:         #STANDARD,
                 type:            #LINEITEM_REFERENCE,
                 position:        120,
                 label:           'Relatives',
                 targetElement:   '_Link' },
               // Communication
               { id:              'CommunicationData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Communication Data',
                 targetQualifier: 'CommunicationData',
                 position:        200 },
               // Contact
               { id:              'ContactData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Communication',
                 parentId:        'CommunicationData',
                 targetQualifier: 'ContactData',
                 position:        10 },
               { id:            '/RHP/R_PersonTelecomTP',
                 type:          #LINEITEM_REFERENCE,
                 parentId:      'ContactData',
                 targetElement: '_Telecom' },
               // Language
               { id:              'LanguageData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Languages',
                 parentId:        'CommunicationData',
                 targetQualifier: 'LanguageData',
                 position:        20 },
               { id:            '/RHP/R_PersonCommunicationTP',
                 type:          #LINEITEM_REFERENCE,
                 parentId:      'LanguageData',
                 targetElement: '_Communication' },
               // Practitioners
               { id:              'PractitionerData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Practitioner',
                 targetQualifier: 'PractitionerData',
                 position:        200 },
               // General practitioner
               { id:              'GeneralPractitionerData',
                 purpose:         #STANDARD,
                 type:            #COLLECTION,
                 label:           'Primary care provider',
                 parentId:        'PractitionerData',
                 targetQualifier: 'GeneralPractitionerData',
                 position:        10 },
               { id:            '/RHP/R_PatientPractitionerTP',
                 type:          #LINEITEM_REFERENCE,
                 parentId:      'GeneralPractitionerData',
                 targetElement: '_GeneralPractitioner' } ]

[jmgrassau]

Hi Jaime,

thanks for opening this. Yes, that's currently a known limitation: The cleanup rule "Rearrange annotations" not only changes whitespace, but can potentially rearrange the structure and order of the annotations, as done in this example:

Therefore, it would be rather difficult to handle comments that are found in between the annotations: Where exactly would they be moved if the order is changed, if multiple identical keywords are extracted from the braces etc.?

This is why, as of now, annotations with comments are simply skipped. You could argue that there are nice cases (such as your example) where comments could simply stay where they are without harming the result – so maybe, a possible enhancement would be to identify those cases and include them in the cleanup.

Kind regards,
Jörg-Michael