DRAFT SMART Guidelines L3 SOP
0.2.1 - CI Build International flag

DRAFT SMART Guidelines L3 SOP, published by TBD. This is not an authorized publication; it is the continuous build for version 0.2.1). This version is based on the current content of https://github.com/DigitalSQR/smart-ig-starter-kit and changes regularly. See the Directory of published versions

Profiles

SMART Guidelines consist of common types of interventions and content. Therefore some profiles for FHIR artifacts share commonalities.

Inputs:

  • Common Profiles (from commons clinical encounter)
  • Activity to Profile mapping/catalog

Outputs:

  • Profiles in input/profiles or input/fsh/profiles
  • Example instances in input/examples or input/fsh/examples

Activities:


Identify profile needs

The FHIR profiles are determined by the need for information objects from the definitions:

  • elements,
  • decision tables,
  • scheduling logic
  • processes,
  • indicators

The L3 author consults the logical models and the business processes to see which profiles are necessary.

Identify reusable profiles

The L3 Author shall search the common profiles repository to search for profiles that may exist which either

  • cover the exchange requirements for the scope
  • may be profiled - if they are in a similar or broader area that can be constrained in a derived profile

This search is in related sources - within the the SMART Guidelines ecosystem - or even outside, such as IHE or HL7 or national guidance. In these cases, the L3 author shall apply the necessary validation as the profiles may not meet the expectations or may change without warning.

The recommended priority for the search for existing profiles

  • other SMART IGs
  • HL7 international balloted reference implementation guides
  • IHE profiles
  • HL7 national balloted reference implementation guides
  • other references
  • search in previous or upcoming releases of FHIR

  • Profiles

Output Criteria / Definition of Done:

  • One profile per json file / One profile per fsh file, as per naming convention
    • The constraints or invariants applicable to a profile may be contained in the same FSH file.
  • All profiles shall be valid profiles
  • All data elements that need to be exchanged or used in a decision, workflow, or indicator are covered by one or more profiles.
  • Every profile shall have one example instance

Change tracking

  • Profiles are essential traceability artifacts, and all changes to a profile shall be tracked in change history
  • Breaking changes to a prior published release should follow a dedicated review process

Tooling

Tool Usage Doc
Sushi Profiles can be authored in FSH syntax HL7 Spec
Sushi Documentation

Informative examples

Known issues and dependencies