Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). 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-plandefinition-data-requirements.xml

Example OperationDefinition/PlanDefinition-data-requirements (XML)

Clinical Decision Support Work Group Maturity Level : N/A Standards Status : Informative Compartments : 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"?>


  
  
    
    
      
      
      
      
      
        The data-requirements operation aggregates and returns the parameters and data requirements
           for the plan definition and all its dependencies as a single module definition library

      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
            
          
          
          
            

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="PlanDefinition-data-requirements"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> URL: [base]/PlanDefinition/[id]/$data-requirements</p> 
      <p> Parameters</p> 
      <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> 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 is a module-definition Library that describes
                 the aggregate parameters, data requirements, and dependencies of the plan definition

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

      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  The data-requirements operation aggregates and returns the parameters and data requirements
   for the plan definition and all its dependencies as a single module definition library
  
  The effect of invoking this operation is to determine the aggregate set of data requirements
   and dependencies for the plan definition. The result is a Library resource with a type
   of module-definition that contains all the parameter definitions and data requirements
   of the plan definition and any libraries referenced by it. Implementations SHOULD aggregate
   data requirements intelligently (i.e. by collapsing overlapping data requirements)
  
  
  
  
  
    
    
    
    

                 the aggregate parameters, data requirements, and dependencies of the plan 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 plan definition. The result is a Library
           resource with a type of module-definition that contains all the parameter definitions
           and data requirements of the plan 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="3"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">    <valueCode value="trial-use"/>   </extension>   <url value="http://hl7.org/fhir/OperationDefinition/PlanDefinition-data-requirements"/>   <version value="5.0.0"/>   <name value="DataRequirements"/>   <title value="Data Requirements"/>   <status value="draft"/>   <kind value="operation"/>   <experimental value="false"/>   <date value="2023-03-26T15:21:02+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 the plan definition and all its dependencies as a single module
   definition library"/> 
  <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 the plan definition. The result is a Library
   resource with a type of module-definition that contains all the parameter definitions
   and data requirements of the plan definition and any libraries referenced by it.
   Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing
   overlapping data requirements)"/> 
  <resource value="PlanDefinition"/>   <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 is a module-definition Library that describes
     the aggregate parameters, data requirements, and dependencies of the plan definition
    
  

     the aggregate parameters, data requirements, and dependencies of the plan 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.