This page is part of the Clinical Guidelines (v0.1.0: STU 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
Terminologies are a critical aspect of supporting interoperable computable content. This implementation guide defines profiles for the CodeSystem and ValueSet resources to identify key elements that must be supported.
Readers of this implementation guide should be familiar with the Using Codes topic in the base FHIR specification.
Standard and established code systems should be used whenever possible. Only in the case that existing code systems do not provide the necessary concepts should new code systems be defined. If required, code systems defined by content conforming to this IG SHALL use the cpg-codesystem profile.
Note that this does not mean that any code system referenced by computable content must use the cpg-codesystem profile. The conformance requirement only applies to code systems defined as part of computable content. For example, the SNOMED-CT code system would not be expected to conform to the cpg-codesystem profile.
Refer to the base FHIR specification for a list of established code systems and the corresponding canonical URL.
This implementation guide defines two value set profiles, a base cpg-valueset profile that establishes key elements that must be supported for any value set content, and a derived profile, cpg-expressionbasedvalueset, that defines key elements that must be supported for expression-based value set content. Value sets defined by content conforming to this IG SHALL use at least the cpg-valueset profile.
In addition, value sets SHOULD be defined using expression-based (or intensional) definitions if the value set definition (the content logical definition) cannot be represented using the standard FHIR value set compose syntax. Value sets defined in this way SHALL conform to the cpg-expressionbasedvalueset profile.
Note that as with code systems, this does not mean that any value set referenced by computable content must use the cpg-valueset or related profiles. The conformance requirements only apply to value sets defined as part of computable content.
Note carefully that for expression-based value sets, content is effectively distributed with the valueset.compose
containing the enumerated set of individual concepts obtained as the result of the computed expansion of the expression or rulesText as of the time of publication. As new versions of the cpg-expressionbasedvalueset
instance are created, and/or as new versions of the code systems used by the value set are created, the value set compose content will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, expression-based value set definitions SHOULD be updated.