$apply

Apply

draftFHIR Core package4.3.0operation10 inputs1 output

The apply operation applies a definition in a specific context

Metadata

hl7.org/fhir

Canonical URL: http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply
Code: $apply
Kind: operation
Affects State: No
Publisher: HL7 (FHIR Project)

Invocation Context

Can be invoked at:

Type LevelInstance Level

Target Resources:

ActivityDefinition

Affects State:No

Implementation Notes

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

Input Parameters (10)

Name	Type	Card.	Description
`activityDefinition`	ActivityDefinition	0..1	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
`subject`*	string	1..*	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
`encounter`	string	0..1	The encounter in context, if any
`practitioner`	string	0..1	The practitioner in context
`organization`	string	0..1	The organization in context
`userType`	CodeableConcept	0..1	The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
`userLanguage`	CodeableConcept	0..1	Preferred language of the person using the system
`userTaskContext`	CodeableConcept	0..1	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
`setting`	CodeableConcept	0..1	The current setting of the request (inpatient, outpatient, etc.)
`settingContext`	CodeableConcept	0..1	Additional detail about the setting of the request, if any

Output Parameters (1)

Name	Type	Card.	Description
`return`	Any	1..1	The resource that is the result of applying the definition

Additional Information

Version: 4.3.0
Date: 2022-05-28T12:47:40+10:00