This page is part of the Documentation Templates and Rules (v1.1.0-ballot: STU 1.1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Best Practices

The use of OIDs

If OIDs are used they SHALL be prefixed with urn:oid: per the OID primitive datatype definition.

Referencing value sets in Questionnaires

When remote value sets are referenced in Questionnaires, full URLs are recommended. If you are using local value sets a relative path is recommended.

Note: Expanding a large value set at run time, may slow down your DTR app. In other words having your value set already expanded could give the user a better client side experience.

Questionnaires and expressions

When referencing expressions in libraries such as a CQL library, the name of the library should be included.

e.g., “expression”: “\“LowerLimbProsthesis\“.PhysicalExaminationType”

In this example above LowerLimbProsthesis is the library name and PhysicalExaminationType is the expression name.

FHIR Library and included CQL

When developing FHIR Libraries that depend on CQL content, the content element SHALL include the data element. Note: The use of the data element requires it to contain a base-64 encoded string that represents the CQL file per the attachment specification.

For example, see the below snippet from a FHIR Library:

Note: Although the use of url in the content element is valid, using the data element should be more interoperable.