Current Build
Clinical Decision Support Work Group Maturity Level: 2Trial Use Compartments: N/A

The apply operation applies a definition in a specific context.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply

Formal Definition (as a OperationDefinition).

URL: [base]/ActivityDefinition/$apply

URL: [base]/ActivityDefinition/[id]/$apply

This is not an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
activityDefinition0..1ActivityDefinition

The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required

patient1..1string
(reference)

The patient that is the target of the activity to be applied

encounter0..1string
(reference)

The encounter in context, if any

practitioner0..1string
(reference)

The practitioner in context

organization0..1string
(reference)

The organization in context

userType0..1CodeableConcept

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)

userLanguage0..1CodeableConcept

Preferred language of the person using the system

userTaskContext0..1CodeableConcept

The 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

setting0..1CodeableConcept

The current setting of the request (inpatient, outpatient, etc.)

settingContext0..1CodeableConcept

Additional detail about the setting of the request, if any

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Any

The resource that is the result of applying the definition

The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. For a more detailed description, refer to the ActivityDefinition resource

Request: Apply a citalopram prescription activity definition to a patient

GET [base]/ActivityDefinition/citalopramPrescription/$apply?patient=124

Response: Returned on successful application

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<MedicationRequest xmlns="http://hl7.org/fhir">
  <!-- This example demonstrates the result of an $apply operation for the citalopramPrescription activity definition. -->
  <id value="apply-operation-response"/>
  <text>
	<status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
    Generated...
    </div>
  </text>
  <contained>
    <Medication>
      <id value="citalopramMedication"/>
      <code>
        <coding>
          <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/>
          <code value="200371"/>
        </coding>
        <text value="citalopram"/>
      </code>
        <form>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="385055001"/>
            <display value="Tablet dose form"/>
          </coding>
          <text value="Tablet dose form"/>
        </form>
        <ingredient>
          <itemReference>
            <reference value="#citalopramSubstance"/>
          </itemReference>
          <amount>
            <numerator>
              <value value="20"/>
              <unit value="mg"/>
            </numerator>
            <denominator>
              <value value="1"/>
              <unit value="{tbl}"/>
            </denominator>
          </amount>
        </ingredient>
    </Medication>
  </contained>
  <contained>
    <Substance>
      <id value="citalopramSubstance"/>
      <code>
        <coding>
          <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/>
          <code value="2556"/>
        </coding>
        <text value="citalopram"/>
      </code>
    </Substance>
  </contained>
  <status value="draft"/>
  <intent value="proposal"/>
  <medicationReference>
	  <reference value="#citalopramMedication"/>
  </medicationReference>
  <subject>
	  <reference value="Patient/124"/>
  </subject>
  <!--definition>
    <reference value="ActivityDefinition/citalopramPrescription"/>
  </definition-->
  <instantiates value="ActivityDefinition/citalopramPrescription"/>
  <dosageInstruction>
	<text value="1 tablet oral 1 time daily"/>
	<timing>
		<repeat>
			<frequency value="1"/>
			<period value="1"/>
			<periodUnit value="d"/>
		</repeat>
	</timing>
	<route>
		<coding>
			<code value="26643006"/>
			<display value="Oral route (qualifier value)"/>
		</coding>
		<text value="Oral route (qualifier value)"/>
	</route>
	<doseAndRate>
	    <type>
	      <text value="ordered"/>
	    </type>
	    <doseQuantity>
			<value value="1"/>
			<unit value="{tbl}"/>
	    </doseQuantity>
	</doseAndRate>
  </dosageInstruction>
  <dispenseRequest>
	  <numberOfRepeatsAllowed value="3"/>
	  <quantity>
		  <value value="30"/>
		  <unit value="{tbl}"/>
	  </quantity>
  </dispenseRequest>
</MedicationRequest>

 

For more information about operations, including how they are invoked, see Operations.