SMART Guidelines Starter Kit
2.1.0 - ci-build International flag

SMART Guidelines Starter Kit, published by WHO. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-ig-starter-kit/tree/main and changes regularly. See the Directory of published versions

Code Systems

Code Systems are created when new codes need to be defined

In particular, each SMART guideline will have a guideline-level code system defined with codes for all the concepts defined in the guideline (i.e. all the concepts defined in the data dictionary).

In addition, sometimes existing code systems need to be completed, for example adding designations in different languages to codes, or adding relationships between vaccine codes.

CodeSystemidentifier 1..*url 1..*status 1..1name 1..1title 1..1experimental 1..1description 1..1CodeSystemCodeSystemExtendsUsesData needsfor code systems(seelegend)

Inputs

  • L2 DAK

Outputs

  • CodeSystem resources in input/codesystems or input/fsh/codesystems

Activities

The creation of a CodeSystem is typically driven by the following needs:

  • When a ValueSets requires codes that are not in yet available from a CodeSystem
  • When a mapping (e.g. a ConceptMap) requires codes that are not yet available from a CodeSystem

  • When a new property must be added to a concept in a codesystem, using a supplement CodeSystem

  • Care should be taken before creating codesystems. As the SMART ImplementationGuides and FHIR ecosystems evolve, the necessary codes are available and shared.
    • One exception is the internal codes for the data elements in the DAK (e.g. the unique concept IMMZ.C.DE1). These are created for every new element in a logical model.

This is the overview of the activities and related artifacts used:


Output Criteria / Definition of Done

Change tracking

As with all FHIR Conformance resources, change management is critical. Do not set the version element of CodeSystems defined in the SMART Guideline, the version element will be set by the publication process. See the versioning topic for more information on change management.

Tooling

Tool Usage Doc
Sushi    
OCL    
tx.fhir.org    

Informative examples

SMART Guidelines - Immunizations (Measles): Code Systems

Known issues and dependencies