Release 5
ConformanceThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| Clinical Decision Support Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is the narrative for the resource. See also the XML, JSON or Turtle format.
Note that this is the formal definition for the apply operation as an OperationDefinition on ActivityDefinition. See the Operation documentation
URL: [base]/ActivityDefinition/$apply
URL: [base]/ActivityDefinition/[id]/$apply
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | activityDefinition | type | 0..1 | ActivityDefinition | 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 | |
| IN | subject | 1..* | string (reference) | 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 | ||
| IN | encounter | 0..1 | string (reference) | The encounter in context, if any | ||
| IN | practitioner | 0..1 | string (reference) | The practitioner in context | ||
| IN | organization | 0..1 | string (reference) | The organization in context | ||
| IN | userType | 0..1 | CodeableConcept | The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.) | ||
| IN | userLanguage | 0..1 | CodeableConcept | Preferred language of the person using the system | ||
| IN | userTaskContext | 0..1 | CodeableConcept | 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 | ||
| IN | setting | 0..1 | CodeableConcept | The current setting of the request (inpatient, outpatient, etc.) | ||
| IN | settingContext | 0..1 | CodeableConcept | Additional detail about the setting of the request, if any | ||
| OUT | return | 1..1 | Resource | 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. 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.
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.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change