Operation
Definition
<?xml version="1.0" encoding="UTF-8"?>
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
(
)
The subject(s) that is/are the target of the activity definition to be applied. The subject
may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided
in this parameter will be resolved as the subject of the PlanDefinition based on the type
of the subject. If multiple subjects of the same type are provided, the behavior is implementation-d
efined
(
)
(
)
(
)
The type of user initiating the request, e.g. patient, healthcare provider, or specific
type of healthcare provider (physician, nurse, etc.)
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
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. In addition, parameters to the $apply operation are available
within dynamicValue expressions as context variables, accessible by the name of the parameter,
prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition
resource
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. In addition, parameters to the $apply operation are available
within dynamicValue expressions as context variables, accessible by the name of the parameter,
prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition
resource
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
The subject(s) that is/are the target of the activity definition to be applied. The subject
may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided
in this parameter will be resolved as the subject of the PlanDefinition based on the type
of the subject. If multiple subjects of the same type are provided, the behavior is implementation-d
efined
The type of user initiating the request, e.g. patient, healthcare provider, or specific
type of healthcare provider (physician, nurse, etc.)
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
<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="ActivityDefinition-apply"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p> URL: [base]/ActivityDefinition/$apply</p> <p> URL: [base]/ActivityDefinition/[id]/$apply</p> <p> Parameters</p> <table class="grid"> <tr> <td> <b> Use</b> </td> <td> <b> Name</b> </td> <td> <b> Scope</b> </td> <td> <b> Cardinality</b> </td> <td> <b> Type</b> </td> <td> <b> Binding</b> </td> <td> <b> Documentation</b> </td> </tr> <tr> <td> IN</td> <td> activityDefinition</td> <td> type</td> <td> 0..1</td> <td> <a href="activitydefinition.html">ActivityDefinition</a> </td> <td/> <td> <div> <p> 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</p>
</div> </td> </tr> <tr> <td> IN</td> <td> subject</td> <td/> <td> 1..*</td> <td> <a href="datatypes.html#string">string</a> <br/> ( <a href="search.html#reference">reference</a> ) </td> <td/> <td> <div> <p> The subject(s) that is/are the target of the activity definition to be applied.
The subject may be a Patient, Practitioner, Organization, Location, Device, or
Group. Subjects provided in this parameter will be resolved as the subject of the
PlanDefinition based on the type of the subject. If multiple subjects of the same
type are provided, the behavior is implementation-defined</p>
</div> </td> </tr> <tr> <td> IN</td> <td> encounter</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#string">string</a> <br/> ( <a href="search.html#reference">reference</a> ) </td> <td/> <td> <div> <p> The encounter in context, if any</p> </div> </td> </tr> <tr> <td> IN</td> <td> practitioner</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#string">string</a> <br/> ( <a href="search.html#reference">reference</a> ) </td> <td/> <td> <div> <p> The practitioner in context</p> </div> </td> </tr> <tr> <td> IN</td> <td> organization</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#string">string</a> <br/> ( <a href="search.html#reference">reference</a> ) </td> <td/> <td> <div> <p> The organization in context</p> </div> </td> </tr> <tr> <td> IN</td> <td> userType</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#CodeableConcept">CodeableConcept</a> </td> <td/> <td> <div> <p> The type of user initiating the request, e.g. patient, healthcare provider, or
specific type of healthcare provider (physician, nurse, etc.)</p>
</div> </td> </tr> <tr> <td> IN</td> <td> userLanguage</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#CodeableConcept">CodeableConcept</a> </td> <td/> <td> <div> <p> Preferred language of the person using the system</p> </div> </td> </tr> <tr> <td> IN</td> <td> userTaskContext</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#CodeableConcept">CodeableConcept</a> </td> <td/> <td> <div> <p> 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</p>
</div> </td> </tr> <tr> <td> IN</td> <td> setting</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#CodeableConcept">CodeableConcept</a> </td> <td/> <td> <div> <p> The current setting of the request (inpatient, outpatient, etc.)</p> </div> </td> </tr> <tr> <td> IN</td> <td> settingContext</td> <td/> <td> 0..1</td> <td> <a href="datatypes.html#CodeableConcept">CodeableConcept</a> </td> <td/> <td> <div> <p> Additional detail about the setting of the request, if any</p> </div> </td> </tr> <tr> <td> OUT</td> <td> return</td> <td/> <td> 1..1</td> <td> <a href="resource.html">Resource</a> </td> <td/> <td> <div> <p> The resource that is the result of applying the definition</p> </div> </td> </tr> </table> <div> <p> 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. In addition,
parameters to the $apply operation are available within dynamicValue expressions
as context variables, accessible by the name of the parameter, prefixed with a
percent (%) symbol. For a more detailed description, refer to the ActivityDefinition
resource. Note that result of this operation is transient (i.e. none of the resources
created by the operation are persisted in the server, they are all returned as
contained resources in the result). The result effectively represents a proposed
set of activities, and it is up to the caller to determine whether and how those
activities are actually carried out.</p>
</div> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="3"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <url value="http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply"/> <version value="5.0.0-draft-final"/> <name value="Apply"/> <title value="Apply"/> <status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2023-03-01T23:03:57+11:00"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="The apply operation applies a definition in a specific context"/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <affectsState value="false"/> <code value="apply"/> <comment value="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. In addition,
parameters to the $apply operation are available within dynamicValue expressions
as context variables, accessible by the name of the parameter, prefixed with a
percent (%) symbol. For a more detailed description, refer to the ActivityDefinition
resource. Note that result of this operation is transient (i.e. none of the resources
created by the operation are persisted in the server, they are all returned as
contained resources in the result). The result effectively represents a proposed
set of activities, and it is up to the caller to determine whether and how those
activities are actually carried out."/>
<resource value="ActivityDefinition"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="activityDefinition"/> <use value="in"/> <scope value="type"/> <min value="0"/> <max value="1"/> <documentation value="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"/>
<type value="ActivityDefinition"/> </parameter> <parameter> <name value="subject"/> <use value="in"/> <min value="1"/> <max value="*"/> <documentation value="The subject(s) that is/are the target of the activity definition to be applied.
The subject may be a Patient, Practitioner, Organization, Location, Device, or
Group. Subjects provided in this parameter will be resolved as the subject of the
PlanDefinition based on the type of the subject. If multiple subjects of the same
type are provided, the behavior is implementation-defined"/>
<type value="string"/> <searchType value="reference"/> </parameter> <parameter> <name value="encounter"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The encounter in context, if any"/> <type value="string"/> <searchType value="reference"/> </parameter> <parameter> <name value="practitioner"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The practitioner in context"/> <type value="string"/> <searchType value="reference"/> </parameter> <parameter> <name value="organization"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The organization in context"/> <type value="string"/> <searchType value="reference"/> </parameter> <parameter> <name value="userType"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The type of user initiating the request, e.g. patient, healthcare provider, or
specific type of healthcare provider (physician, nurse, etc.)"/>
<type value="CodeableConcept"/> </parameter> <parameter> <name value="userLanguage"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Preferred language of the person using the system"/> <type value="CodeableConcept"/> </parameter> <parameter> <name value="userTaskContext"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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"/>
<type value="CodeableConcept"/> </parameter> <parameter> <name value="setting"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The current setting of the request (inpatient, outpatient, etc.)"/> <type value="CodeableConcept"/> </parameter> <parameter> <name value="settingContext"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Additional detail about the setting of the request, if any"/> <type value="CodeableConcept"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The resource that is the result of applying the definition"/> <type value="Resource"/> </parameter>
</
OperationDefinition
>
Usage
note:
every
effort
has
been
made
to
ensure
that
the
examples
are
correct
and
useful,
but
they
are
not
a
normative
part
of
the
specification.