This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
Operation-activitydefinition-data-requirements.xml
Example
OperationDefinition/ActivityDefinition-data-requirements
(XML)
Raw
XML
(
canonical
form
)
Jump
past
Narrative
+
also
see
XML
Format
Specification
)
Operation
Definition
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
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
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)
<?xml version="1.0" encoding="UTF-8"?>
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
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)
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
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="ActivityDefinition-data-requirements"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p class="res-header-id">
<b> Generated Narrative: OperationDefinition ActivityDefinition-data-requirements</b>
</p>
<a name="ActivityDefinition-data-requirements"> </a>
<a name="hcActivityDefinition-data-requirements"> </a>
<p> URL: [base]/ActivityDefinition/[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> 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="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="cds"/> </extension> <url value="http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements"/> <version value="6.0.0-ballot3"/> <name value="DataRequirements"/> <title value="Data Requirements"/> <status value="active"/> <kind value="operation"/> <experimental value="false"/> <date value="2025-12-17T09:50:17+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 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.