STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Operation-library-data-requirements.xml

Raw XML (canonical form)

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Library-data-requirements"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Data Requirements</h2>
      <p>OPERATION: Data Requirements</p>
      <div>
        <p>The data-requirements operation aggregates and returns the parameters and data requirements
           for a resource and all its dependencies as a single module definition</p>

      </div>
      <p>URL: [base]/$data-requirements</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>target</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>The target of the data requirements operation</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>return</td>
          <td>1..1</td>
          <td>Library</td>
          <td/>
          <td>
            <div>
              <p>The result of the requirements gathering</p>

            </div>
          </td>
        </tr>
      </table>
      <div>
        <p>The effect of invoking this operation is to determine the aggregate set of data requirements
           and dependencies for a given target resource. The result is a Library resource with a
           type of module-definition that contains all the parameter definitions and data requirements
           of the target resource and any libraries referenced by it. Implementations SHOULD aggregate
           data requirements intelligently (i.e. by collapsing overlapping data requirements)</p>

      </div>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Library-data-requirements"/>
  <name value="Data Requirements"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-08-11T17:02:54+10:00"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="The data-requirements operation aggregates and returns the parameters and data requirements
   for a resource and all its dependencies as a single module definition"/>
  <code value="data-requirements"/>
  <comment value="The effect of invoking this operation is to determine the aggregate set of data requirements
   and dependencies for a given target resource. The result is a Library resource with a
   type of module-definition that contains all the parameter definitions and data requirements
   of the target resource and any libraries referenced by it. Implementations SHOULD aggregate
   data requirements intelligently (i.e. by collapsing overlapping data requirements)"/>
  <system value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="target"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The target of the data requirements operation"/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The result of the requirements gathering"/>
    <type value="Library"/>
  </parameter>
</OperationDefinition>

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.