Operation-library-data-requirements.xml

Operation Definition

<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Library-data-requirements"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> data-requirements</h2> 
      <p> OPERATION: data-requirements</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Library-data-requirements</pre> 
      <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> URL: [base]/Library/[id]/$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> 
            <a href="datatypes.html#string">string</a> 
          </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> 
            <a href="library.html">Library</a> 
          </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> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Library-data-requirements"/> 
  <version value="4.3.0-snapshot1"/> 
  <name value="data-requirements"/> 
  <title value="Data Requirements"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2021-12-20T14:08:35+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 data-requirements operation aggregates and returns the parameters and data requirements
   for a resource and all its dependencies as a single module definition"/> 
  <affectsState value="false"/> 
  <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)"/> 
  <resource value="Library"/> 
  <system value="true"/> 
  <type value="false"/> 
  <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="string"/> 
  </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>