Release 5 R6 Ballot (3rd Draft)
This page is part of the FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Publish-box (todo)

Example OperationDefinition/PlanDefinition-apply (Narrative)

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 PlanDefinition. See the Operation documentation

Generated Narrative: OperationDefinition PlanDefinition-apply

URL: [base]/PlanDefinition/$apply

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN planDefinition type 0..1 PlanDefinition

The plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required, or a url (and optionally version) must be supplied

IN url type 0..1 canonical ( PlanDefinition )

The url of the plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter (and optionally the version), or the planDefinition parameter must be supplied

IN version type 0..1 string

The version of the plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter may only be used if the url parameter is supplied.

IN subject 1..* string
( reference )

The subject(s) that is/are the target of the plan 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 applying the plan definition

IN organization 0..1 string
( 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 0..* Bundle

A Bundle for each input subject that is the result of applying the plan definition to that subject

The result of this operation is a Bundle for each subject, where the Bundle contains as its first entry a RequestOrchestration Request resources that is are the direct result of applying the PlanDefinition to that subject, and any subsequent entries in the Bundle are resources that were created or updated as part of that process. subject. The RequestOrchestration Bundle will have actions entries for each of the applicable actions in the plan PlanDefinition based on evaluating the applicability condition in context. context, and producing Request resources based on the definition element for each applicable action.

For each applicable action, the definition is applied as described in the $apply operation of the ActivityDefinition resource, and the resulting resource is added as an entry to the Bundle. The resulting Bundle may be any combination of Request resources, including CarePlan, RequestOrchestration, and individual Request resources such as ServiceRequest and MedicationRequest.

Note that to preserve the structure of the PlanDefinition, systems may choose to return the results in a RequestOrchestration. In this case, the individual request resources will have an intent of option , meaning the their intent is governed by the RequestOrchestraiont.

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 PlanDefinition and ActivityDefinition resource documentation. 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 entries in the result Bundle(s)). 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 and/or persisted.

 

 

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.