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

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

## : Care In The Community ActivityDefinition Apply Operation - XML Representation

Draft as of 2022-09-20

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="ActivityDefinition-apply"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition ActivityDefinition-apply</b></p><a name="ActivityDefinition-apply"> </a><a name="hcActivityDefinition-apply"> </a><p>URL: [base]/ActivityDefinition/[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>activityDefinition</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/activitydefinition.html">ActivityDefinition</a></td><td/><td><div><p>The activity 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="https://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The subject Patient that is the target of the activity to be applied.</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="https://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The practitioner applying the activity 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/servicerequest.html">ServiceRequest</a></td><td/><td><div><p>The ServiceRequest that is the result of applying the plan definition</p>
    </div></td></tr></table><div><p>The result of this operation is a ServiceRequest resource</p>
    </div></div>
      </text>
      <url
           value="https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/ActivityDefinition-apply"/>
      <version value="0.4.5"/>
      <name value="CareInTheCommunityActivityDefinitionApplyOperation"/>
      <title value="Care In The Community ActivityDefinition Apply Operation"/>
      <status value="draft"/>
      <kind value="operation"/>
      <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="Te Whatu Ora Integration Team"/>
        <telecom>
          <system value="email"/>
          <value value="integration@tewhatuora.govt.nz"/>
          <use value="work"/>
        </telecom>
      </contact>
      <description
                   value="The apply operation applies an ActivityDefinition 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 ServiceRequest resource"/>
      <base
            value="http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply"/>
      <resource value="ActivityDefinition"/>
      <system value="false"/>
      <type value="false"/>
      <instance value="true"/>
      <parameter>
        <name value="activityDefinition"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The activity definition to be applied (required)."/>
        <type value="ActivityDefinition"/>
      </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 activity to be applied."/>
        <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 activity definition"/>
        <type value="string"/>
        <searchType value="reference"/>
      </parameter>
      <parameter>
        <name value="return"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The ServiceRequest that is the result of applying the plan definition"/>
        <type value="ServiceRequest"/>
      </parameter>
    </OperationDefinition>