Content Management Infrastructure Implementation Guide
0.1.0 - ballot United States of America flag

Content Management Infrastructure Implementation Guide, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/Content-Management-Infrastructure-IG/ and changes regularly. See the Directory of published versions

OperationDefinition: Library Data Requirements

Official URL: http://hl7.org/fhir/uv/cmi/OperationDefinition/Library-data-requirements Version: 0.1.0
Draft as of 2019-11-01 Computable Name: LibraryDataRequirements

Determines the effective data requirements for the library, including known components and dependencies, and optionally informed by a version manifest.

LibraryDataRequirements

OPERATION: LibraryDataRequirements

The official URL for this operation definition is: 

http://hl7.org/fhir/uv/cmi/OperationDefinition/Library-data-requirements

Determines the effective data requirements for the library, including known components and dependencies, and optionally informed by a version manifest.

URL: [base]/Library/$data-requirements

URL: [base]/Library/[id]/$data-requirements

Parameters

UseNameCardinalityTypeBindingDocumentation
INid0..1string

The logical id of the library to analyze. The server must know the library (e.g. it is defined explicitly in the server's libraries)

INurl0..1uri

A canonical reference to a library. The server must know the library (e.g. it is defined explicitly in the server's libraries

INversion0..1string

The version of the library to analyze

INidentifier0..1string
(token)

A business identifier of the library to be analyzed. The server must know the library and the identifier must resolve unambiguously to a single library on the server.

INexpression0..*string

The name of a specific expression to be considered for analysis. If no expressions are specified, the analysis is performed on the entire library. If expressions are specified, the analysis is performed only on the expressions specified.

INparameters0..1Parameters

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.

INsystem-version0..*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

INcheck-system-version0..*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

INforce-system-version0..*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

INmanifest0..1canonical

Specifies an asset-collection library that defines version bindings for code systems referenced by value set(s) or other artifacts used in the artifact. 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.

INinclude-dependencies0..1boolean

Specifies whether to follow known dependencies of the artifact as part of the analysis, recursively (default = true)

INinclude-components0..1boolean

Specifies whether to follow known components of the artifact as part of the analysis, recursively (default = true)

OUTreturn1..1Bundle

The result of the requirements operation is a module-definition Library that returns the computed effective requirements of the artifact.

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