This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

G.3 Definitional Resources

CDS Work Group

Maturity Level: 2

Ballot Status: Trial Use

Part of defining knowledge artifacts such as order sets, protocols, and decision support rules is describing in a patient- or context-independent way the activities to be performed. For example, when defining an order set, the orderable items must be described with enough detail to enable the creation of the items when the order set is applied. These descriptions can be thought of as templates for the creation of patient- or context-specific resources and are often referred to as definitional resources, to distinguish them from intent resources (that signal an intention to take some action for a specific patient), as well as event resources (that signal that some action has actually been taken for a patient).

In the most general case, these definitional resources only need to describe the most basic aspects of the activitiy to be performed, such as:

• Who - Which person should perform the activity, often specified as a participant role such as a provider specialty.
• What - What type of activity should be performed, often specified simply as a category or a concept.
• When - When the activity should be performed, often specified relative to the time the plan is applied.
• Where - Where the activity should take place, often specified as a facility role.

However, this level of conceptual description often does not carry enough information to enable computable description of activities. For example, medication activities will often involve specific drug and dosage information that must be captured as part of the definition. Further, it is often the case that the values for the elements of resources to be created cannot be specified exactly as part of the definition, but must be specified using a formula that allows for the calculation to be based on patient- or context-specific information.

The ActivityDefinition resource supports the description of definitional resources within FHIR:

For example, the following fragment illustrates a definition to create a referral request:

<ActivityDefinition>
  <description value="refer to primary care mental-health integrated care program for evaluation and treatment
   of mental health conditions now"/>
  <category value="referral"/>
  <code>
    <coding>
      <system value="http://snomed.info/sct"/>
      <code value="306206005"/>
    </coding>
  </code>
  <timingTiming>
    <event>
      <extension url="http://hl7.org/fhir/StructureDefinition/cqif-basic-cqlExpression">
        <valueString value="Now()"/>
      </extension>
    </event>
  </timingTiming>
  <participantType value="practitioner"/>
</ActivityDefinition>

Note the use of an expression to represent the value of the timing element as Now().

For medication activities, the ActivityDefinition resource has some basic elements such as the product and quantity, and dosageInstruction but there are cases where elements that need to be set on the resulting MedicationRequest are not present on the ActivityDefinition (such as dispenseRequest). In those cases, the dynamicValue expression elements can be used to describe the values for elements that are present on the target resource, but not in the definitional resource. For example:

<ActivityDefinition>
  <id value="citalopramPrescription"/>
  <status value="draft"/>
  <category value="drug"/>
  <productReference>
    <reference value="#citalopramMedication"/>
  </productReference>
  <dynamicValue>
    <path value="dispenseRequest.numberOfRepeatsAllowed"/>
    <expression value="3"/>
  </dynamicValue>
  <dynamicValue>
    <path value="dispenseRequest.quantity"/>
    <expression value="30 '{tbl}'"/>
  </dynamicValue>
</ActivityDefinition>

Note to implementers: Although there is currently only one definitional resource defined (ActivityDefinition), the concept is general, and this was a deliberate design decision to avoid the overhead of defining and maintaining a different definitional resource for every category of request. We anticipate that as the use cases of ActivityDefinition require more specialized elements to be added, the resource may be split.