Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

OperationDefinition: CRMI Data Requirements Operation

Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-data-requirements Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: CRMIDataRequirements
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.33.3

Determines the effective data requirements for one or more artifacts, including known components and dependencies, and optionally informed by a version manifest. When multiple artifacts are specified, the result is the aggregate data requirements for all the artifacts.

See $package and $data-requirements

Language: en

URL: [base]/$data-requirements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INurl0..*uri

Optionally versioned canonical or artifact reference to the resource(s) for which data requirements will be determined. Multiple artifacts will result in the aggregate data requirements for all the artifacts.

This parameter cannot be used when invoking at the instance level. When invoking at the type level, the reference must be to a type that agrees with the invocation.

INexpression0..*string

The identifier (optionally qualified) of the expression(s) for which data requirements will be determined, regardless of whether the declaration is private. If no expression names are provided, the operation determines data requirements for the entire artifact or artifacts. If the operation is performed with multiple artifacts, expression names must be qualified with the name of the library in which they appear. Note that this may result in expression requirements being included because they are called from a specified expression, rather than because they are specified directly.

INparameters0..1Parameters

Any input parameters (optionally qualified) for the artifact(s). If any artifact is a logic library, or references logic libraries, parameters defined in this input will be bound by name to parameters defined in the logic library (or referenced libraries). If parameter names are qualified, the parameter will be bound only to parameters in the library with the qualifier name, and the qualifier name must be the name of an artifact being processed (or an included library, recursively). If the logic library is a CQL library, parameter types are mapped to CQL as specified in the Using CQL with FHIR 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.

INartifactVersion0..*uri

Specifies a version to use for a canonical or artifact 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.

INcheckArtifactVersion0..*uri

Edge Case: Specifies a version to use for a canonical or artifact 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.

INforceArtifactVersion0..*uri

Edge Case: Specifies a version to use for a canonical or artifact 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 overridden, 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.

INmanifest0..1canonical (CRMI Manifest Library)

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, the expansion parameters of the manifest are used to provide expansion behavior and canonical resolution for dependencies encountered while processing the operation.

INartifactEndpointConfiguration0..*

Configuration information to resolve canonical artifacts

  • artifactRoute: An optional route used to determine whether this endpoint is expected to be able to resolve artifacts that match the route (i.e. start with the route, up to and including the entire url)
  • endpointUri: The URI of the endpoint, exclusive with the endpoint parameter
  • endpoint: An Endpoint resource describing the endpoint, exclusive with the endpointUri parameter

Processing semantics:

Create a canonical-like reference (e.g. {canonical.url}|{canonical.version} or similar extensions for non-canonical artifacts).

  • Given a single artifactEndpointConfiguration
    • When artifactRoute is present
      • And canonical or artifact reference starts with artifactRoute
      • Then attempt to resolve with endpointUri or endpoint
    • When artifactRoute is not present
      • Then attempt to resolve with endpointUri or endpoint
  • Given multiple artifactEndpointConfigurations
    • Then rank order each configuration (see below)
    • And attempt to resolve with endpointUri or endpoint in order until resolved

Rank each artifactEndpointConfiguration such that:

  • if artifactRoute is present and canonical or artifact reference starts with artifactRoute: rank based on number of matching characters
  • if artifactRoute is not present: include but rank lower

NOTE: For evenly ranked artifactEndpointConfigurations, order as defined in the OperationDefinition.

INartifactEndpointConfiguration.artifactRoute0..1uri
INartifactEndpointConfiguration.endpointUri0..1uri
INartifactEndpointConfiguration.endpoint0..1Endpoint
OUTreturn1..1Library

The result of the requirements operation is a module-definition Library that returns the computed effective requirements of the artifact (or the aggregate effective requirements of the artifacts, if multiple artifacts are specified).

The data requirements operation is used for dependency gathering, as a way to understand the set of dependencies of a given artifact (or set of artifacts), as well as for data requirements determination, as a way to understand the complete set of data requirements for a given artifact (or set of artifacts), including terminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies, and data requirements.

When the value of an element of a data requirement cannot be determined due to a processing exception (for example, a code filter based on the result of a function), the crmi-analysisException extension is used on that element to indicate that the value could not be determined, with a message describing the exception.