Operation-plandefinition-apply.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="PlanDefinition-apply"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Place</h2>
      <p>OPERATION: Place</p>
      <div>
        <p>The apply operation applies a PlanDefinition to a given context</p>

      </div>
      <p>URL: [base]/PlanDefinition/[id]/$apply</p>
      <p>Parameters</p>
      <table class="grid">
        <tr>
          <td>
            <b>Use</b>
          </td>
          <td>
            <b>Name</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>patient</td>
          <td>1..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>The patient that is the target of the plan to be applied</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>encounter</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>The encounter in context, if any</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>practitioner</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>The practitioner applying the plan definition</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>organization</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>The organization applying the plan definition</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>userType</td>
          <td>0..1</td>
          <td>CodeableConcept</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>0..1</td>
          <td>CodeableConcept</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>0..1</td>
          <td>CodeableConcept</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>0..1</td>
          <td>CodeableConcept</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>0..1</td>
          <td>CodeableConcept</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>1..1</td>
          <td>CarePlan</td>
          <td/>
          <td>
            <div>
              <p>The CarePlan that is the result of applying the plan definition</p>

            </div>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply"/>
  <name value="Place"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-12-06T12:22:34+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 PlanDefinition to a given context"/>
  <code value="apply"/>
  <resource value="PlanDefinition"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The patient that is the target of the plan to be applied"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Patient"/>
    </profile>
  </parameter>
  <parameter>
    <name value="encounter"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The encounter in context, if any"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Encounter"/>
    </profile>
  </parameter>
  <parameter>
    <name value="practitioner"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The practitioner applying the plan definition"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
    </profile>
  </parameter>
  <parameter>
    <name value="organization"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The organization applying the plan definition"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Organization"/>
    </profile>
  </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 CarePlan that is the result of applying the plan definition"/>
    <type value="CarePlan"/>
  </parameter>
</OperationDefinition>