Example
OperationDefinition/ActivityDefinition-data-requirements
(XML)
Raw
XML
(
canonical
form
+
also
see
XML
Format
Specification
)
Where
to
send
answers
Raw
XML
Operation
Definition
U.S. Office of the National Coordinator (ONC)'s Standards and Infrastructure (S&I)
Structured Data Capture project
The base URL for the server to which questionnaire answers associated with this questionnaire
should be submitted.
The base URL for the server to which questionnaire answers associated with this questionnaire
should be submitted.
May be used to represent additional information that is not part of the basic definition
of the element. In order to make the use of extensions safe and manageable, there is a
strict set of governance applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project,
or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
The use of extensions is what allows the FHIR specification to retain a core level of
simplicity for everyone.
The definition may point directly to a computable or human-readable definition of the
extensibility codes, or it may be a logical URI as declared in some other specification.
The definition should be version specific. This will ideally be the URI for the Resource
Profile defining the extension, with the code for the extension after a #.
Value of extension - may be a resource or one of a constrained set of the data types (see
Extensibility in the spec for list).
The base URL for the server to which questionnaire answers associated with this questionnaire
should be submitted.
<?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>
</StructureDefinition>
</
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.