Smile CDR v2024.05.PRE
On this page:

23.5.1ActivityDefinition

 

23.5.1.1Introduction

The FHIR Clinical Reasoning Module defines the ActivityDefinition resource and several associated operations. An ActivityDefinition is a shareable, consumable description of some activity to be performed. It may be used to specify actions to be taken as part of a workflow, order set, or protocol, or it may be used independently as part of a catalog of activities such as orderables.

In general, an activity definition is simply a conceptual description of some specific action that should be taken. An instance of an ActivityDefinition does not indicate that any action has been performed (as an event resource does), nor does it indicate the actual intent to carry out any particular action (as a request resource does). Instead, an activity definition provides a reusable template that can be used to construct specific request resources such as ServiceRequest and MedicationRequest.

Note that this is conceptually similar to the Task resource as well, with the distinction being that ActivityDefinition represents the description of a task in the abstract, while the Task resource is used to track a specific instance of a task as it moves through the steps of a workflow.

An ActivityDefinition resource provides a description, or template, of an action to perform. These actions can be purely text-based descriptions of the action to be performed, only interpretable by a human user, or they can be structured definitions with enough information to construct a resource to represent the request or activity directly. This process of converting the ActivityDefinition into a specific resource in a particular context is performed with the $apply operation.

23.5.1.2Operations

Smile CDR implements the following operations for ActivityDefinitions

23.5.1.3Apply

The ActivityDefinition/$apply operation creates a Request Resource for a given context. This implementation follows the FHIR Specification and supports the FHIR Clinical Guidelines IG.

23.5.1.3.1Parameters

The following parameters are supported for the ActivityDefinition/$apply operation:

ParameterTypeDescription
activityDefinitionActivityDefinitionThe activity definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required, or a url (and optionally version) must be supplied.
canonicalcanonical(ActivityDefinition)The canonical url of the activity definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter (and optionally the version), or the activityDefinition parameter must be supplied.
urluriCanonical URL of the ActivityDefinition when invoked at the resource type level. This is exclusive with the activityDefinition and canonical parameters.
versionstringVersion of the ActivityDefinition when invoked at the resource type level. This is exclusive with the activityDefinition and canonical parameters.
subjectstring(reference)The subject(s) that is/are the target of the activity definition to be applied.
encounterstring(reference)The encounter in context, if any.
practitionerstring(reference)The practitioner applying the activity definition.
organizationstring(reference)The organization applying the activity definition.
userTypeCodeableConceptThe type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
userLanguageCodeableConceptPreferred language of the person using the system
userTaskContextCodeableConceptThe task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources.
settingCodeableConceptThe current setting of the request (inpatient, outpatient, etc.).
settingContextCodeableConceptAdditional detail about the setting of the request, if any
parametersParametersAny input parameters defined in libraries referenced by the ActivityDefinition.
useServerDatabooleanWhether to use data from the server performing the evaluation. If this parameter is true (the default), then the operation will use data first from any bundles provided as parameters (through the data and prefetch parameters), second data from the server performing the operation, and third, data from the dataEndpoint parameter (if provided). If this parameter is false, the operation will use data first from the bundles provided in the data or prefetch parameters, and second from the dataEndpoint parameter (if provided).
dataBundleData to be made available to the ActivityDefinition evaluation.
dataEndpointEndpointAn endpoint to use to access data referenced by retrieve operations in libraries referenced by the ActivityDefinition.
contentEndpointEndpointAn endpoint to use to access content (i.e. libraries) referenced by the ActivityDefinition.
terminologyEndpointEndpointAn endpoint to use to access terminology (i.e. valuesets, codesystems, and membership testing) referenced by the ActivityDefinition.