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-package"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/ActivityDefinition/$crmi.package</p><p>URL: [base]/ActivityDefinition/[id]/$crmi.package</p><p>URL: [base]/CapabilityStatement/$crmi.package</p><p>URL: [base]/CapabilityStatement/[id]/$crmi.package</p><p>URL: [base]/ChargeItemDefinition/$crmi.package</p><p>URL: [base]/ChargeItemDefinition/[id]/$crmi.package</p><p>URL: [base]/CodeSystem/$crmi.package</p><p>URL: [base]/CodeSystem/[id]/$crmi.package</p><p>URL: [base]/CompartmentDefinition/$crmi.package</p><p>URL: [base]/CompartmentDefinition/[id]/$crmi.package</p><p>URL: [base]/ConceptMap/$crmi.package</p><p>URL: [base]/ConceptMap/[id]/$crmi.package</p><p>URL: [base]/EffectEvidenceSynthesis/$crmi.package</p><p>URL: [base]/EffectEvidenceSynthesis/[id]/$crmi.package</p><p>URL: [base]/EventDefinition/$crmi.package</p><p>URL: [base]/EventDefinition/[id]/$crmi.package</p><p>URL: [base]/Evidence/$crmi.package</p><p>URL: [base]/Evidence/[id]/$crmi.package</p><p>URL: [base]/EvidenceVariable/$crmi.package</p><p>URL: [base]/EvidenceVariable/[id]/$crmi.package</p><p>URL: [base]/ExampleScenario/$crmi.package</p><p>URL: [base]/ExampleScenario/[id]/$crmi.package</p><p>URL: [base]/GraphDefinition/$crmi.package</p><p>URL: [base]/GraphDefinition/[id]/$crmi.package</p><p>URL: [base]/ImplementationGuide/$crmi.package</p><p>URL: [base]/ImplementationGuide/[id]/$crmi.package</p><p>URL: [base]/Library/$crmi.package</p><p>URL: [base]/Library/[id]/$crmi.package</p><p>URL: [base]/Measure/$crmi.package</p><p>URL: [base]/Measure/[id]/$crmi.package</p><p>URL: [base]/MessageDefinition/$crmi.package</p><p>URL: [base]/MessageDefinition/[id]/$crmi.package</p><p>URL: [base]/NamingSystem/$crmi.package</p><p>URL: [base]/NamingSystem/[id]/$crmi.package</p><p>URL: [base]/OperationDefinition/$crmi.package</p><p>URL: [base]/OperationDefinition/[id]/$crmi.package</p><p>URL: [base]/PlanDefinition/$crmi.package</p><p>URL: [base]/PlanDefinition/[id]/$crmi.package</p><p>URL: [base]/Questionnaire/$crmi.package</p><p>URL: [base]/Questionnaire/[id]/$crmi.package</p><p>URL: [base]/ResearchDefinition/$crmi.package</p><p>URL: [base]/ResearchDefinition/[id]/$crmi.package</p><p>URL: [base]/ResearchElementDefinition/$crmi.package</p><p>URL: [base]/ResearchElementDefinition/[id]/$crmi.package</p><p>URL: [base]/RiskEvidenceSynthesis/$crmi.package</p><p>URL: [base]/RiskEvidenceSynthesis/[id]/$crmi.package</p><p>URL: [base]/SearchParameter/$crmi.package</p><p>URL: [base]/SearchParameter/[id]/$crmi.package</p><p>URL: [base]/StructureDefinition/$crmi.package</p><p>URL: [base]/StructureDefinition/[id]/$crmi.package</p><p>URL: [base]/StructureMap/$crmi.package</p><p>URL: [base]/StructureMap/[id]/$crmi.package</p><p>URL: [base]/TerminologyCapabilities/$crmi.package</p><p>URL: [base]/TerminologyCapabilities/[id]/$crmi.package</p><p>URL: [base]/TestScript/$crmi.package</p><p>URL: [base]/TestScript/[id]/$crmi.package</p><p>URL: [base]/ValueSet/$crmi.package</p><p>URL: [base]/ValueSet/[id]/$crmi.package</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 an existing Resource to package on the server.</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 Resource to package on the server.</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 Resource</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 Resource.</p>
</div></td></tr><tr><td>IN</td><td>capability</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>A desired capability of the resulting package. <code>computable</code> to include
computable elements in packaged content; <code>executable</code> to include executable
elements in packaged content; <code>publishable</code> to include publishable elements in
packaged content.</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 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 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.
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
<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>offset</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Paging support - where to start if a subset is desired (default = 0). Offset is
number of records (not number of pages)</p>
</div></td></tr><tr><td>IN</td><td>count</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Paging support - how many resources should be provided in a partial page view.
If count = 0, the client is asking how large the package is.</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>packageOnly</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>True to indicate that the resulting package should only include resources that are defined in the implementation guide
or specification that defines the artifact being packaged. False (default) to indicate that the resulting package should
include resources regardless of what implementation guide or specification they are defined in.</p>
</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 packaging. Servers generating packages SHALL include all the
dependency resources referenced by the artifact that are known to the server and
specified by the include parameters.</p>
<p>For example, a measure repository SHALL include
all the required library resources, but would not necessarily have the
ValueSet resources referenced by the measure.</p>
</div></td></tr></table><div><p>TODO: More documentation about the operation, including inline examples:</p>
<pre><code class="language-json">{
"resourceType": "Bundle"
}
</code></pre>
</div></div>
</text>
<url value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-package"/>
<version value="1.0.0-ballot"/>
<name value="CRMIPackage"/>
<title value="CRMI Package"/>
<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="Packages a specified canonical resource with dependencies.
See [$package and $data-requirements](introduction.html)"/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<code value="crmi.package"/>
<comment
value="TODO: More documentation about the operation, including inline examples:
```json
{
"resourceType": "Bundle"
}
```"/>
<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 an existing Resource to package on the server."/>
<type value="string"/>
</parameter>
<parameter>
<name value="url"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A canonical reference to a Resource to package on the server."/>
<type value="uri"/>
</parameter>
<parameter>
<name value="version"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="The version of the Resource"/>
<type value="string"/>
</parameter>
<parameter>
<name value="identifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="A business identifier of the Resource."/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="capability"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="A desired capability of the resulting package. `computable` to include
computable elements in packaged content; `executable` to include executable
elements in packaged content; `publishable` to include publishable elements in
packaged content."/>
<type value="string"/>
</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="offset"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Paging support - where to start if a subset is desired (default = 0). Offset is
number of records (not number of pages)"/>
<type value="integer"/>
</parameter>
<parameter>
<name value="count"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Paging support - how many resources should be provided in a partial page view.
If count = 0, the client is asking how large the package is."/>
<type value="integer"/>
</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="packageOnly"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="True to indicate that the resulting package should only include resources that are defined in the implementation guide
or specification that defines the artifact being packaged. False (default) to indicate that the resulting package should
include resources regardless of what implementation guide or specification they are defined in."/>
<type value="boolean"/>
</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 packaging. Servers generating packages SHALL include all the
dependency resources referenced by the artifact that are known to the server and
specified by the include parameters.
For example, a measure repository SHALL include
all the required library resources, but would not necessarily have the
ValueSet resources referenced by the measure."/>
<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