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

• Narrative Content
• XML
• JSON
• TTL

: RunOperation - XML Representation

Active as of 2025-08-31

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="RunOperation"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition RunOperation</b></p><a name="RunOperation"> </a><a name="hcRunOperation"> </a><p>URL: [base]/$$run</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>viewReference</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>Reference to the ViewDefinition to be used for data aggregation.</p>
</div></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>The patient for whom the data is to be aggregated.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/binary.html">Binary</a></td><td/><td><div><p>The output of the operation with a Content-Type of application/json.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/RunOperation"/>
  <version value="0.4.1"/>
  <name value="run"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2025-08-31T13:33:02+00:00"/>
  <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="Run a flat data view operation to aggregate data for a specific patient using a defined ViewDefinition."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="NZ"/>
      <display value="New Zealand"/>
    </coding>
  </jurisdiction>
  <code value="run"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="viewReference"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Reference to the ViewDefinition to be used for data aggregation."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The patient for whom the data is to be aggregated."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The output of the operation with a Content-Type of application/json."/>
    <type value="Binary"/>
  </parameter>
</OperationDefinition>