HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

OperationDefinition: Library Packaging

LibraryPackaging

OPERATION: LibraryPackaging

The official URL for this operation definition is: 

http://hl7.org/fhir/us/ecr/OperationDefinition/library-package

Packages the contents referenced by an asset-collection library such as a quality program release or version manifest.

URL: [base]/Library/$package

URL: [base]/Library/[id]/$package

Parameters

Use Name Cardinality Type Binding Documentation
IN id 0..1 string

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)
IN url 0..1 uri

A canonical reference to a library. The server must know the library (e.g. it is defined explicitly in the server's libraries)
IN version 0..1 string

The version of the library to be used for packaging
IN identifier 0..1 string
( token)

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.
IN capability 0..* string

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.

IN offset 0..1 integer

Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)
IN count 0..1 integer

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.
IN system-version 0..* canonical

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
IN check-system-version 0..* canonical

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
IN force-system-version 0..* canonical

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
IN manifest 0..1 canonical

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.

IN include-dependencies 0..1 boolean

Specifies whether to include known (i.e. present on the server) dependencies of the library in the resulting package, recursively (default = true)
IN include-components 0..1 boolean

Specifies whether to include known (i.e. present on the server) components of the library in the resulting package, recursively (default = true)
OUT return 1..1 Bundle

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.

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.