Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Care In The Community PlanDefinition Apply Operation - XML Representation

Draft as of 2022-09-20

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="PlanDefinition-apply"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition PlanDefinition-apply</b></p><a name="PlanDefinition-apply"> </a><a name="hcPlanDefinition-apply"> </a><a name="PlanDefinition-apply-en-NZ"> </a><p>URL: [base]/PlanDefinition/[id]/$apply</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>planDefinition</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/plandefinition.html">PlanDefinition</a></td><td/><td><div><p>The plan definition to be applied (required).</p>
</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The subject Patient that is the target of the plan to be applied.</p>
</div></td></tr><tr><td>IN</td><td>encounter</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The encounter in context, if any</p>
</div></td></tr><tr><td>IN</td><td>practitioner</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The practitioner applying the plan definition</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/careplan.html">CarePlan</a></td><td/><td><div><p>The CarePlan that is the result of applying the plan definition</p>
</div></td></tr></table><div><p>The result of this operation is a CarePlan resource</p>
</div></div>
  </text>
  <url
       value="https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/PlanDefinition-apply"/>
  <version value="0.4.0"/>
  <name value="CareInTheCommunityPlanDefinitionApplyOperation"/>
  <title value="Care In The Community PlanDefinition Apply Operation"/>
  <status value="draft"/>
  <kind value="query"/>
  <date value="2022-09-20"/>
  <publisher value="Te Whatu Ora"/>
  <contact>
    <name value="Te Whatu Ora"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.tewhatuora.govt.nz/"/>
    </telecom>
  </contact>
  <contact>
    <name value="David Grainger"/>
    <telecom>
      <system value="email"/>
      <value value="david.grainger@middleware.co.nz"/>
      <use value="work"/>
    </telecom>
  </contact>
  <description
               value="The apply operation applies a PlanDefinition to a given context"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="NZ"/>
      <display value="New Zealand"/>
    </coding>
  </jurisdiction>
  <code value="apply"/>
  <comment value="The result of this operation is a CarePlan resource"/>
  <base value="http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply"/>
  <resource value="PlanDefinition"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="planDefinition"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The plan definition to be applied (required)."/>
    <type value="PlanDefinition"/>
  </parameter>
  <parameter>
    <name value="subject"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The subject Patient that is the target of the plan to be applied."/>
    <type value="string"/>
    <searchType value="reference"/>
  </parameter>
  <parameter>
    <name value="encounter"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The encounter in context, if any"/>
    <type value="string"/>
    <searchType value="reference"/>
  </parameter>
  <parameter>
    <name value="practitioner"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The practitioner applying the plan definition"/>
    <type value="string"/>
    <searchType value="reference"/>
  </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>