FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/Library-data-requirements (XML)

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Operation Definition

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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Library-data-requirements"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Library-data-requirements</b> 
      </p> 
      <a name="Library-data-requirements"> </a> 
      <a name="hcLibrary-data-requirements"> </a> 
      <a name="Library-data-requirements-en-US"> </a> 
      <p> URL: [base]/$data-requirements</p> 
      <p> URL: [base]/Library/[id]/$data-requirements</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> target</td> 
          <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/>  
          <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> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cds"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Library-data-requirements"/> 
  <version value="6.0.0-ballot2"/> 
  <name value="DataRequirements"/> 
  <title value="Data Requirements"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2024-11-04T21:17:35+00:00"/> 
  <publisher value="HL7 International / Clinical Decision Support"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/dss"/> 
    </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"/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <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> 

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.