Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Draft as of 2023-03-12 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="crmi-data-requirements"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/ActivityDefinition/$crmi.data-requirements</p><p>URL: [base]/ActivityDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/CapabilityStatement/$crmi.data-requirements</p><p>URL: [base]/CapabilityStatement/[id]/$crmi.data-requirements</p><p>URL: [base]/ChargeItemDefinition/$crmi.data-requirements</p><p>URL: [base]/ChargeItemDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/CodeSystem/$crmi.data-requirements</p><p>URL: [base]/CodeSystem/[id]/$crmi.data-requirements</p><p>URL: [base]/CompartmentDefinition/$crmi.data-requirements</p><p>URL: [base]/CompartmentDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/ConceptMap/$crmi.data-requirements</p><p>URL: [base]/ConceptMap/[id]/$crmi.data-requirements</p><p>URL: [base]/EffectEvidenceSynthesis/$crmi.data-requirements</p><p>URL: [base]/EffectEvidenceSynthesis/[id]/$crmi.data-requirements</p><p>URL: [base]/EventDefinition/$crmi.data-requirements</p><p>URL: [base]/EventDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/Evidence/$crmi.data-requirements</p><p>URL: [base]/Evidence/[id]/$crmi.data-requirements</p><p>URL: [base]/EvidenceVariable/$crmi.data-requirements</p><p>URL: [base]/EvidenceVariable/[id]/$crmi.data-requirements</p><p>URL: [base]/ExampleScenario/$crmi.data-requirements</p><p>URL: [base]/ExampleScenario/[id]/$crmi.data-requirements</p><p>URL: [base]/GraphDefinition/$crmi.data-requirements</p><p>URL: [base]/GraphDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/ImplementationGuide/$crmi.data-requirements</p><p>URL: [base]/ImplementationGuide/[id]/$crmi.data-requirements</p><p>URL: [base]/Library/$crmi.data-requirements</p><p>URL: [base]/Library/[id]/$crmi.data-requirements</p><p>URL: [base]/Measure/$crmi.data-requirements</p><p>URL: [base]/Measure/[id]/$crmi.data-requirements</p><p>URL: [base]/MessageDefinition/$crmi.data-requirements</p><p>URL: [base]/MessageDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/NamingSystem/$crmi.data-requirements</p><p>URL: [base]/NamingSystem/[id]/$crmi.data-requirements</p><p>URL: [base]/OperationDefinition/$crmi.data-requirements</p><p>URL: [base]/OperationDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/PlanDefinition/$crmi.data-requirements</p><p>URL: [base]/PlanDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/Questionnaire/$crmi.data-requirements</p><p>URL: [base]/Questionnaire/[id]/$crmi.data-requirements</p><p>URL: [base]/ResearchDefinition/$crmi.data-requirements</p><p>URL: [base]/ResearchDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/ResearchElementDefinition/$crmi.data-requirements</p><p>URL: [base]/ResearchElementDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/RiskEvidenceSynthesis/$crmi.data-requirements</p><p>URL: [base]/RiskEvidenceSynthesis/[id]/$crmi.data-requirements</p><p>URL: [base]/SearchParameter/$crmi.data-requirements</p><p>URL: [base]/SearchParameter/[id]/$crmi.data-requirements</p><p>URL: [base]/StructureDefinition/$crmi.data-requirements</p><p>URL: [base]/StructureDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/StructureMap/$crmi.data-requirements</p><p>URL: [base]/StructureMap/[id]/$crmi.data-requirements</p><p>URL: [base]/TerminologyCapabilities/$crmi.data-requirements</p><p>URL: [base]/TerminologyCapabilities/[id]/$crmi.data-requirements</p><p>URL: [base]/TestScript/$crmi.data-requirements</p><p>URL: [base]/TestScript/[id]/$crmi.data-requirements</p><p>URL: [base]/ValueSet/$crmi.data-requirements</p><p>URL: [base]/ValueSet/[id]/$crmi.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>IN</td><td>id</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The logical id of the canonical resource to analyze.</p>
</div></td></tr><tr><td>IN</td><td>url</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td/><td><div><p>A canonical reference to a canonical resource.</p>
</div></td></tr><tr><td>IN</td><td>version</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The version of the canonical resource to analyze</p>
</div></td></tr><tr><td>IN</td><td>identifier</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#token">token</a>)</td><td/><td><div><p>A business identifier of the canonical resource to be analyzed.</p>
</div></td></tr><tr><td>IN</td><td>expression</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The name of a specific expression to be considered for analysis. If no
expressions are specified, the analysis is performed on the entire resource. If
expressions are specified, the analysis is performed only on the expressions
specified.</p>
</div></td></tr><tr><td>IN</td><td>parameters</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>Any input parameters for the artifact. Parameters defined in this input will be
bound by name to parameters defined in the CQL library (or referenced
libraries). Parameter types are mapped to CQL as specified in the Using CQL
section of this implementation guide. If a parameter appears more than once in
the input Parameters resource, it is represented with a List in the input CQL.
If a parameter has parts, it is represented as a Tuple in the input CQL.</p>
<p>NOTE: Does this only apply to Library resource types?</p>
</div></td></tr><tr><td>IN</td><td>canonicalVersion</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Specifies a version to use for a canonical resource if the artifact referencing
the resource does not already specify a version. The format is the same as a canonical URL:
[url]|[version] - e.g. http://loinc.org|2.56</p>
<p>Note that this is a generalization of the <code>system-version</code> parameter to the $expand operation
to apply to any canonical resource, including code systems.</p>
</div></td></tr><tr><td>IN</td><td>checkCanonicalVersion</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical resource. If the artifact referencing
the resource specifies a different version, an error is returned instead of the package. The
format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56</p>
<p>Note that this is a generalization of the <code>check-system-version</code> parameter to the $expand operation to
apply to any canonical resource, including code systems.</p>
</div></td></tr><tr><td>IN</td><td>forceCanonicalVersion</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical resource. This parameter overrides any
specified version in the artifact (and any artifacts it depends on). The
format is the same as a canonical URL: [system]|[version] - e.g.
http://loinc.org|2.56. Note that this has obvious safety issues, in that it may
result in a value set expansion giving a different list of codes that is both
wrong and unsafe, and implementers should only use this capability reluctantly.</p>
<p>It primarily exists to deal with situations where specifications have fallen
into decay as time passes. If the version of a canonical is overriden, the version used SHALL
explicitly be represented in the expansion parameters.</p>
<p>Note that this is a generalization of the <code>force-system-version</code> parameter to the $expand operation
to apply to any canonical resource, including code systems.</p>
</div></td></tr><tr><td>IN</td><td>manifest</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Specifies an asset-collection library that defines version bindings for code
systems and other canonical resources referenced by the value set(s) being expanded
and other canonical resources referenced by the artifact. When specified, code
systems and other canonical resources identified as <code>depends-on</code> related artifacts
in the manifest library have the same meaning as specifying that code system or other
canonical version in the <code>system-version</code> parameter of an expand or the <code>canonicalVersion</code>
parameter.</p>
</div></td></tr><tr><td>IN</td><td>include</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Specifies what contents should be included in the resulting package. The codes indicate which types of resources should be included, but note that
the set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts. Possible
values are:</p>
<ul>
<li>all (default) - all resource types</li>
<li>artifact - the specified artifact</li>
<li>canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)</li>
<li>terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)</li>
<li>conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)</li>
<li>profiles - profile definitions (i.e. StructureDefinition resources that define profiles)</li>
<li>extensions - extension definitions (i.e. StructureDefinition resources that define extensions)</li>
<li>knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)</li>
<li>tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)</li>
<li>examples - example resources (i.e. resources identified as examples in the implementation guide)</li>
</ul>
</div></td></tr><tr><td>IN</td><td>contentEndpoint</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/endpoint.html">Endpoint</a></td><td/><td><div><p>An endpoint to use to access content (i.e. libraries, activities, measures, questionnaires, and plans) referenced by the
artifact. If no content endpoint is supplied the evaluation will attempt to
retrieve content from the server on which the operation is being performed.</p>
</div></td></tr><tr><td>IN</td><td>terminologyEndpoint</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/endpoint.html">Endpoint</a></td><td/><td><div><p>An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and
membership testing) referenced by the Resource. If no terminology endpoint is
supplied, the evaluation will attempt to use the server on which the operation
is being performed as the terminology server.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The result of the requirements operation is a <em>module-definition</em> Library that
returns the computed effective requirements of the artifact.</p>
</div></td></tr></table><div><p>The requirements operation supports the ability of a repository to determine the
effective requirements of an artifact, including terminology usage (code
systems, value sets, and direct-reference codes), parameters, dependencies
(artifacts), and data requirements</p>
</div></div>
</text>
<url
value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-data-requirements"/>
<version value="1.0.0-ballot"/>
<name value="CRMIDataRequirements"/>
<title value="CRMI Data Requirements"/>
<status value="draft"/>
<kind value="operation"/>
<experimental value="false"/>
<date value="2023-03-12"/>
<publisher value="Clinical Decision Support WG"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/dss"/>
</telecom>
</contact>
<description
value="Determines the effective data requirements for the artifact, including known
components and dependencies, and optionally informed by a version manifest.
See [$crmi.package and $crmi.data-requirements](introduction.html)
*TODO*: Add example of the use-case that will do dependency tracing, similar to
`$package` but returns only the information and not the actual resources."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<code value="crmi.data-requirements"/>
<comment
value="The requirements operation supports the ability of a repository to determine the
effective requirements of an artifact, including terminology usage (code
systems, value sets, and direct-reference codes), parameters, dependencies
(artifacts), and data requirements"/>
<resource value="ActivityDefinition"/>
<resource value="CapabilityStatement"/>
<resource value="ChargeItemDefinition"/>
<resource value="CodeSystem"/>
<resource value="CompartmentDefinition"/>
<resource value="ConceptMap"/>
<resource value="EffectEvidenceSynthesis"/>
<resource value="EventDefinition"/>
<resource value="Evidence"/>
<resource value="EvidenceVariable"/>
<resource value="ExampleScenario"/>
<resource value="GraphDefinition"/>
<resource value="ImplementationGuide"/>
<resource value="Library"/>
<resource value="Measure"/>
<resource value="MessageDefinition"/>
<resource value="NamingSystem"/>
<resource value="OperationDefinition"/>
<resource value="PlanDefinition"/>
<resource value="Questionnaire"/>
<resource value="ResearchDefinition"/>
<resource value="ResearchElementDefinition"/>
<resource value="RiskEvidenceSynthesis"/>
<resource value="SearchParameter"/>
<resource value="StructureDefinition"/>
<resource value="StructureMap"/>
<resource value="TerminologyCapabilities"/>
<resource value="TestScript"/>
<resource value="ValueSet"/>
<system value="false"/>
<type value="true"/>
<instance value="true"/>
<parameter>
<name value="id"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The logical id of the canonical resource to analyze."/>
<type value="string"/>
</parameter>
<parameter>
<name value="url"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="A canonical reference to a canonical resource."/>
<type value="uri"/>
</parameter>
<parameter>
<name value="version"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="The version of the canonical resource to analyze"/>
<type value="string"/>
</parameter>
<parameter>
<name value="identifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A business identifier of the canonical resource to be analyzed."/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="expression"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="The name of a specific expression to be considered for analysis. If no
expressions are specified, the analysis is performed on the entire resource. If
expressions are specified, the analysis is performed only on the expressions
specified."/>
<type value="string"/>
</parameter>
<parameter>
<name value="parameters"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Any input parameters for the artifact. Parameters defined in this input will be
bound by name to parameters defined in the CQL library (or referenced
libraries). Parameter types are mapped to CQL as specified in the Using CQL
section of this implementation guide. If a parameter appears more than once in
the input Parameters resource, it is represented with a List in the input CQL.
If a parameter has parts, it is represented as a Tuple in the input CQL.
NOTE: Does this only apply to Library resource types?"/>
<type value="Parameters"/>
</parameter>
<parameter>
<name value="canonicalVersion"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Specifies a version to use for a canonical resource if the artifact referencing
the resource does not already specify a version. The format is the same as a canonical URL:
[url]|[version] - e.g. http://loinc.org|2.56
Note that this is a generalization of the `system-version` parameter to the $expand operation
to apply to any canonical resource, including code systems."/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="checkCanonicalVersion"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Edge Case: Specifies a version to use for a canonical resource. If the artifact referencing
the resource specifies a different version, an error is returned instead of the package. The
format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56
Note that this is a generalization of the `check-system-version` parameter to the $expand operation to
apply to any canonical resource, including code systems."/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="forceCanonicalVersion"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Edge Case: Specifies a version to use for a canonical resource. This parameter overrides any
specified version in the artifact (and any artifacts it depends on). The
format is the same as a canonical URL: [system]|[version] - e.g.
http://loinc.org|2.56. Note that this has obvious safety issues, in that it may
result in a value set expansion giving a different list of codes that is both
wrong and unsafe, and implementers should only use this capability reluctantly.
It primarily exists to deal with situations where specifications have fallen
into decay as time passes. If the version of a canonical is overriden, the version used SHALL
explicitly be represented in the expansion parameters.
Note that this is a generalization of the `force-system-version` parameter to the $expand operation
to apply to any canonical resource, including code systems."/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="manifest"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Specifies an asset-collection library that defines version bindings for code
systems and other canonical resources referenced by the value set(s) being expanded
and other canonical resources referenced by the artifact. When specified, code
systems and other canonical resources identified as `depends-on` related artifacts
in the manifest library have the same meaning as specifying that code system or other
canonical version in the `system-version` parameter of an expand or the `canonicalVersion`
parameter."/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="include"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Specifies what contents should be included in the resulting package. The codes indicate which types of resources should be included, but note that
the set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts. Possible
values are:
* all (default) - all resource types
* artifact - the specified artifact
* canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)
* terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)
* conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)
* profiles - profile definitions (i.e. StructureDefinition resources that define profiles)
* extensions - extension definitions (i.e. StructureDefinition resources that define extensions)
* knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)
* tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)
* examples - example resources (i.e. resources identified as examples in the implementation guide)"/>
<type value="string"/>
</parameter>
<parameter>
<name value="contentEndpoint"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An endpoint to use to access content (i.e. libraries, activities, measures, questionnaires, and plans) referenced by the
artifact. If no content endpoint is supplied the evaluation will attempt to
retrieve content from the server on which the operation is being performed."/>
<type value="Endpoint"/>
</parameter>
<parameter>
<name value="terminologyEndpoint"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and
membership testing) referenced by the Resource. If no terminology endpoint is
supplied, the evaluation will attempt to use the server on which the operation
is being performed as the terminology server."/>
<type value="Endpoint"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The result of the requirements operation is a _module-definition_ Library that
returns the computed effective requirements of the artifact."/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>
IG © 2022+ Clinical Decision Support WG. Package hl7.fhir.uv.crmi#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change