HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2
This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Draft as of 2021-07-26 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="operationdefinition-library-package"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>LibraryPackaging</h2>
<p>OPERATION: LibraryPackaging</p>
<p>The official URL for this operation definition is: </p>
<pre>http://hl7.org/fhir/us/ecr/OperationDefinition/library-package</pre>
<div>
<p>Packages the contents referenced by an asset-collection library such as a quality program release or version manifest.</p>
</div>
<p>URL: [base]/Library/$package</p>
<p>URL: [base]/Library/[id]/$package</p>
<p>Parameters</p>
<table class="grid">
<tr>
<td>
<b>Use</b>
</td>
<td>
<b>Name</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>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 library to package. The server must know the library (e.g. it is defined explicitly in the server's libraries)</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>url</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 library. The server must know the library (e.g. it is defined explicitly in the server's libraries)</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>version</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 library to be used for packaging</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>identifier</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 library to be packaged. The server must know the library and the identifier must resolve unambiguously to a single library on the server.</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>capability</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>offset</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>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>system-version</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 system, if the library or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] -
e.g. http://loinc.org|2.56</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>check-system-version</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 system. If a library or value set specifies a different version, an error is returned instead of the package. The format is the same as
a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>force-system-version</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 system. This parameter overrides any specified version in the library and value sets (and any 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 value is override, the version used SHALL explicitly be represented in the expansion parameters</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>manifest</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 referenced by the value set(s) being expanded. When specified, code systems identified as
<code>depends-on</code> related artifacts in the library have the same meaning as specifying that code system version in the <code>system-version</code> parameter. </p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>include-dependencies</td>
<td>0..1</td>
<td>
<a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a>
</td>
<td/>
<td>
<div>
<p>Specifies whether to include known (i.e. present on the server) dependencies of the library in the resulting package, recursively (default = true)</p>
</div>
</td>
</tr>
<tr>
<td>IN</td>
<td>include-components</td>
<td>0..1</td>
<td>
<a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a>
</td>
<td/>
<td>
<div>
<p>Specifies whether to include known (i.e. present on the server) components of the library in the resulting package, recursively (default = true)</p>
</div>
</td>
</tr>
<tr>
<td>OUT</td>
<td>return</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 library that are known to the server (if include-dependencies
is true), and all the component resources referenced by the library that are known to the server (if include-components is true). 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>This operation is used to retrieve the contents associated with a particular library such as a quality program, including the use of the quality program as a binding parameters specification
to identify code system and value set versions that should be used for expansion of value sets used by measures in the quality program.</p>
</div>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="pher"/>
</extension>
<url
value="http://hl7.org/fhir/us/ecr/OperationDefinition/operationdefinition-library-package"/>
<version value="2.1.2"/>
<name value="LibraryPackaging"/>
<title value="Library Packaging"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2021-07-26T09:29:23+11:00"/>
<publisher value="HL7 International / Public Health"/>
<contact>
<name value="HL7 International / Public Health"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/pher"/>
</telecom>
</contact>
<description
value="Packages the contents referenced by an asset-collection library such as a quality program release or version manifest."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<code value="package"/>
<comment
value="This operation is used to retrieve the contents associated with a particular library such as a quality program, including the use of the quality program as a binding parameters specification to identify code system and value set versions that should be used for expansion of value sets used by measures in the quality program."/>
<resource value="Library"/>
<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 library to package. The server must know the library (e.g. it is defined explicitly in the server's libraries)"/>
<type value="string"/>
</parameter>
<parameter>
<name value="url"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A canonical reference to a library. The server must know the library (e.g. it is defined explicitly in the server's libraries"/>
<type value="uri"/>
</parameter>
<parameter>
<name value="version"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The version of the library to be used for packaging"/>
<type value="string"/>
</parameter>
<parameter>
<name value="identifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A business identifier of the library to be packaged. The server must know the library and the identifier must resolve unambiguously to a single library on the server."/>
<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="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="system-version"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Specifies a version to use for a system, if the library or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56"/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="check-system-version"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Edge Case: Specifies a version to use for a system. If a library or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56"/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="force-system-version"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the library and value sets (and any 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 value is override, the version used SHALL explicitly be represented in the expansion parameters"/>
<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 referenced by the value set(s) being expanded. When specified, code systems identified as `depends-on` related artifacts in the library have the same meaning as specifying that code system version in the `system-version` parameter."/>
<type value="canonical"/>
</parameter>
<parameter>
<name value="include-dependencies"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Specifies whether to include known (i.e. present on the server) dependencies of the library in the resulting package, recursively (default = true)"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="include-components"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Specifies whether to include known (i.e. present on the server) components of the library in the resulting package, recursively (default = true)"/>
<type value="boolean"/>
</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 library that are known to the server (if include-dependencies is true), and all the component resources referenced by the library that are known to the server (if include-components is true). 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 © 2020+ HL7 International / Public Health. Package hl7.fhir.us.ecr#2.1.2 based on FHIR 4.0.1. Generated 2024-10-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change