Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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-activitydefinition-data-requirements.xml

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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

Jump past Narrative

Operation Definition

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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ActivityDefinition-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/ActivityDefinition-data-requirements</pre> 
      <div> 
        <p> The data-requirements operation aggregates and returns the parameters and data requirements
           for the activity definition and all its dependencies as a single module definition library</p> 

      </div> 
      <p> URL: [base]/ActivityDefinition/[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> 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 represented as a module-definition Library that
                 describes the aggregate parameters, data requirements, and dependencies of the activity
                 definition</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 the activity definition. The result is a Library resource with a
           type of module-definition that contains all the parameter definitions and data requirements
           of the activity definition 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="2"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements"/> 
  <version value="4.5.0"/> 
  <name value="Data Requirements"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2020-08-20T17:41:31+10: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 the activity definition and all its dependencies as a single module definition library"/> 
  <code value="data-requirements"/> 
  <comment value="The effect of invoking this operation is to determine the aggregate set of data requirements
   and dependencies for the activity definition. The result is a Library resource with a
   type of module-definition that contains all the parameter definitions and data requirements
   of the activity definition and any libraries referenced by it. Implementations SHOULD
   aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)"/> 
  <resource value="ActivityDefinition"/> 
  <system value="false"/> 
  <type value="false"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="The result of the requirements gathering represented as a module-definition Library that
     describes the aggregate parameters, data requirements, and dependencies of the activity
     definition"/> 
    <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.