search

cqframework / sample-content-ig

Sample Content IG
Apache License 2.0
7 stars 13 forks source link

Mandatory resource name and recommended resource description #19

Closed alackerbauer closed 1 year ago

alackerbauer commented 1 year ago

Currently, in the QA report the following error and warning messages show up:

  1. error | Unable to find ImplementationGuide.definition.resource.name for the resource Library/FHIRHelpers. Name is mandatory if it cannot be inferred from the resource to allow proper population of the artifact list.
  2. warning | Unable to find ImplementationGuide.definition.resource.description for the resource Library/FHIRHelpers. Descriptions are strongly encouraged if they cannot be inferred from the resource to allow proper population of the artifact list.

The same is true for the resource Device/cqf-tooling and Questionnaire/phq-9-questionnaire.

There is two ways to resolve those error messages:

  1. by adding the elements title and description directly into the resource json (only possible in the Library resource), e.g. the file https://github.com/cqframework/sample-content-ig/blob/master/input/resources/library/Library-FHIRHelpers.json
  2. by adding a resource reference directly to the base ImplementationGuide resource and adding the elements name and description there, as it is done in the Opioid IG: https://github.com/cqframework/opioid-cds-r4/blob/master/input/opioid-cds.xml#L283

The resources Device/cqf-tooling and Library/FHIRHelpers are automatically generated with the _refresh command. In addition to the above mentioned possible fixes, it might make sense adding those elements directly to the generated library by default when using the _refresh command.