SHIFT SLS Reference Implementation Guide
0.1.0 - ci-build International flag

SHIFT SLS Reference Implementation Guide, published by SHIFT-Task-Force. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/SHIFT-Task-Force/sls-ri-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

SLS FHIR Server Capability Statement

Capability Statement for the SLS FHIR Server

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

SLS Load ValueSets Operation Definition

Operation Definition for loading SLS ValueSets. This is used to populate the server with the necessary ValueSets for SLS.
SLS Tag Data Operation Definition

Operation Definition for applying security labels to the data passed in according to the loaded ValueSets.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

SLS ValueSet Profile

Profile for ValueSets used in the SLS RI

  • Shared ValueSets require experimental, url, title, description, and status.
  • title and description are encouraged to keep track of the purpose and use of the ValueSet as it is not always clear from the content of the ValueSet itself.
  • compose.inactive tends to need to be true as the ValueSet is covering historic data that may have been coded long ago when the now inactive codes were allowed.
  • useContext of focus is the tag value applied to data that matches a code in this ValueSet
    • display values are discouraged as they simply add size to the tagged output.
    • in R5/R6 the topic value can be used.
  • date is the date the ValueSet was created or last updated. This value will be used by the SLS RI to determine if the data being inspected was last inspected before the last update of the ValueSet.
  • expansion.timestamp is the date the ValueSet was expanded. This value will be used by the SLS RI to determine if the data being inspected was last inspected before the last expansion of the ValueSet.
  • expansion SHOULD provide expanded ValueSet as that give the definitive list of codes and a timestamp for when the expansion was performed. This allows the SLS RI to determine if the data being inspected matches any of the codes in the ValueSet without having to perform an expansion itself.
    • The RI can expand the ValueSet itself if the expansion is not provided, but this expansion limits the timestamp to now, thus forcing inspection of all data even when the actual valueSet has not changed.
    • The expansion is done by an external service which is then a dependency. The SLS RI uses tx.fhir.org terminology service.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

ValueSet: Multiple Topics with no expansion

This ValueSet covers multiple sensitive topics, showing that the topic can have multiple values associated with it.

This ValueSet does not include the expansion, so the SLS would expand this upon importing this ValueSet. This does get the most up-to-date expansion, but because it updates the expansion timestamp may result in reevaluating previously tagged resources that don't need to be reevaluated.

ValueSet for behavioral health conditions that span multiple topics used in the SLS RI. This ValueSet includes codes for behavioral health conditions that are relevant to the SLS use cases and may span multiple topics such as mental health, substance abuse, and psychotherapy notes.
ValueSet: Single topic with both definition and expansion

This ValueSet includes the definition of the ValueSet (compose include), and the expansion. Note that the display values are not necessary but are included in the compose include to confirm that the codes are what was intended by the display values.

ValueSet for mental health conditions used in the SLS RI. This ValueSet includes codes for mental health conditions that are relevant to the SLS use cases.
ValueSet: Single topic with only expansion

This ValueSet includes only the expansion, not the valueSet definition. Not sure this is valid, but it is all that the SLS-RI needs.

Because the expansion is specified the expansion parameter used-codesystem is included to indicate which code system was used in the expansion. The expansion timestamp and an identifier are also provided.

ValueSet for substance abuse conditions used in the SLS RI. This ValueSet includes codes for substance abuse conditions that are relevant to the SLS use cases.