FHIR Release 3 (STU)
ConformanceThis page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. 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 | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
This is the narrative for the resource. See also the XML or JSON format.
OPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply
The apply operation applies a PlanDefinition to a given context
URL: [base]/PlanDefinition/[id]/$apply
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | patient | 1..1 | Reference | The patient that is the target of the plan to be applied | |
| IN | encounter | 0..1 | Reference | The encounter in context, if any | |
| IN | practitioner | 0..1 | Reference | The practitioner applying the plan definition | |
| IN | organization | 0..1 | Reference | The organization applying the plan definition | |
| 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 | CarePlan | The CarePlan that is the result of applying the plan definition |
The result of this operation is a CarePlan resource, with activities for each of the applicable actions based on evaluating the applicability condition in context. For each applicable action, the activitydefinition is applied as described in the $apply operation of the ActivityDefinition resource, and the resulting resource is added as an activity to the CarePlan. 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
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.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change