CRMI License Requirements Operation - Canonical Resource Management Infrastructure Implementation Guide v2.0.0-ballot

Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

OperationDefinition: CRMI License Requirements Operation

Page standards status: Informative

Profiles: CRMI Operation Profile: Artifact Operation, CRMI Operation Profile: Artifact Version Bindable, CRMI Operation Profile: Manifestable

URL: [base]/ActivityDefinition/$crmi.license-requirements

URL: [base]/ActivityDefinition/[id]/$crmi.license-requirements

URL: [base]/CapabilityStatement/$crmi.license-requirements

URL: [base]/CapabilityStatement/[id]/$crmi.license-requirements

URL: [base]/ChargeItemDefinition/$crmi.license-requirements

URL: [base]/ChargeItemDefinition/[id]/$crmi.license-requirements

URL: [base]/CodeSystem/$crmi.license-requirements

URL: [base]/CodeSystem/[id]/$crmi.license-requirements

URL: [base]/CompartmentDefinition/$crmi.license-requirements

URL: [base]/CompartmentDefinition/[id]/$crmi.license-requirements

URL: [base]/ConceptMap/$crmi.license-requirements

URL: [base]/ConceptMap/[id]/$crmi.license-requirements

URL: [base]/EffectEvidenceSynthesis/$crmi.license-requirements

URL: [base]/EffectEvidenceSynthesis/[id]/$crmi.license-requirements

URL: [base]/EventDefinition/$crmi.license-requirements

URL: [base]/EventDefinition/[id]/$crmi.license-requirements

URL: [base]/Evidence/$crmi.license-requirements

URL: [base]/Evidence/[id]/$crmi.license-requirements

URL: [base]/EvidenceVariable/$crmi.license-requirements

URL: [base]/EvidenceVariable/[id]/$crmi.license-requirements

URL: [base]/ExampleScenario/$crmi.license-requirements

URL: [base]/ExampleScenario/[id]/$crmi.license-requirements

URL: [base]/GraphDefinition/$crmi.license-requirements

URL: [base]/GraphDefinition/[id]/$crmi.license-requirements

URL: [base]/ImplementationGuide/$crmi.license-requirements

URL: [base]/ImplementationGuide/[id]/$crmi.license-requirements

URL: [base]/Library/$crmi.license-requirements

URL: [base]/Library/[id]/$crmi.license-requirements

URL: [base]/Measure/$crmi.license-requirements

URL: [base]/Measure/[id]/$crmi.license-requirements

URL: [base]/MessageDefinition/$crmi.license-requirements

URL: [base]/MessageDefinition/[id]/$crmi.license-requirements

URL: [base]/NamingSystem/$crmi.license-requirements

URL: [base]/NamingSystem/[id]/$crmi.license-requirements

URL: [base]/OperationDefinition/$crmi.license-requirements

URL: [base]/OperationDefinition/[id]/$crmi.license-requirements

URL: [base]/PlanDefinition/$crmi.license-requirements

URL: [base]/PlanDefinition/[id]/$crmi.license-requirements

URL: [base]/Questionnaire/$crmi.license-requirements

URL: [base]/Questionnaire/[id]/$crmi.license-requirements

URL: [base]/ResearchDefinition/$crmi.license-requirements

URL: [base]/ResearchDefinition/[id]/$crmi.license-requirements

URL: [base]/ResearchElementDefinition/$crmi.license-requirements

URL: [base]/ResearchElementDefinition/[id]/$crmi.license-requirements

URL: [base]/RiskEvidenceSynthesis/$crmi.license-requirements

URL: [base]/RiskEvidenceSynthesis/[id]/$crmi.license-requirements

URL: [base]/SearchParameter/$crmi.license-requirements

URL: [base]/SearchParameter/[id]/$crmi.license-requirements

URL: [base]/StructureDefinition/$crmi.license-requirements

URL: [base]/StructureDefinition/[id]/$crmi.license-requirements

URL: [base]/StructureMap/$crmi.license-requirements

URL: [base]/StructureMap/[id]/$crmi.license-requirements

URL: [base]/TerminologyCapabilities/$crmi.license-requirements

URL: [base]/TerminologyCapabilities/[id]/$crmi.license-requirements

URL: [base]/TestScript/$crmi.license-requirements

URL: [base]/TestScript/[id]/$crmi.license-requirements

URL: [base]/ValueSet/$crmi.license-requirements

URL: [base]/ValueSet/[id]/$crmi.license-requirements

Parameters

Use Name Scope Cardinality Type Binding Documentation

IN

id

0..1

string

The logical id of the canonical resource to analyze.

IN

url

0..1

uri

A canonical reference to a canonical resource.

IN

version

0..1

string

The version of the canonical resource to analyze

IN

identifier

0..1

string
(token)

A business identifier of the canonical resource to be analyzed.

IN

expression

0..*

string

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

IN

parameters

0..1

Parameters

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.

NOTE: Does this only apply to Library resource types?

IN

artifactVersion

0..*

uri

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.

IN

checkArtifactVersion

0..*

uri

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.

IN

forceArtifactVersion

0..*

uri

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.

IN

manifest

0..1

canonical

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.

IN

include

0..*

string

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)

IN

contentEndpoint

0..1

Endpoint

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.

IN

terminologyEndpoint

0..1

Endpoint

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.

OUT

return

1..1

Parameters

The result of the requirements operation is a Parameters resource that returns the computed effective license requirements of the artifact.

The requirements operation supports the ability of a repository to determine the dependencies of an artifact, including terminology usage (code systems, value sets, and direct-reference codes).

Example:

Request

GET /Measure/$license-requirements
    ?url=http://acme.org/Measure/my-measure
    &version=1.2.0

Response

{
  "resourceType": "Parameters",
  "parameters": [
    {
      "name": "http://acme.org/Measure/my-measure",
      "parameter": [
        {
          "name": "license",
          "valueCode": "CC0-1.0"
        },
        {
          "name": "publisher",
          "valueString": "Acme Inc"
        },
        {
          "name": "copyright",
          "valueMarkdown": "Copyright notice"
        },
        {
          "name": "canonical",
          "valueCanonical": "http://acme.org/Measure/my-measure|1.2.0"
        }
      ]
    },
    {
      "name": "http://acme.org/Library/my-lib",
      "parameter": [
        {
          "name": "license",
          "valueCode": "not-open-source"
        },
        {
          "name": "license-details",
          "valueMarkdown": "ACME License
You have to pay for it."
        },
        {
          "name": "publisher",
          "valueString": "Acme Inc"
        },
        {
          "name": "copyright",
          "valueMarkdown": "Copyright notice"
        },
        {
          "name": "canonical",
          "valueCanonical": "http://acme.org/Library/my-lib|1.2.0"
        }
      ]
    }
  ]
}

IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-08-01
Links: Table of Contents | QA Report | Version History | | Propose a change