This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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
Example OperationDefinition/ActivityDefinition-data-requirements (XML)
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="ActivityDefinition-data-requirements"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<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> 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 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="3"/>
</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="5.0.0-draft-final"/>
<name value="DataRequirements"/>
<title value="Data Requirements"/>
<status value="draft"/>
<kind value="operation"/>
<experimental value="false"/>
<date value="2023-03-01T23:03:57+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 activity 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 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.