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
| Page standards status: Trial-use | Maturity Level: 4 |
{
"resourceType" : "OperationDefinition",
"id" : "crmi-data-requirements",
"language" : "en",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition crmi-data-requirements</b></p><a name=\"crmi-data-requirements\"> </a><a name=\"hccrmi-data-requirements\"> </a><p>URL: [base]/$data-requirements</p><p>URL: [base]/ActivityDefinition/$data-requirements</p><p>URL: [base]/ActivityDefinition/[id]/$data-requirements</p><p>URL: [base]/CapabilityStatement/$data-requirements</p><p>URL: [base]/CapabilityStatement/[id]/$data-requirements</p><p>URL: [base]/CodeSystem/$data-requirements</p><p>URL: [base]/CodeSystem/[id]/$data-requirements</p><p>URL: [base]/CompartmentDefinition/$data-requirements</p><p>URL: [base]/CompartmentDefinition/[id]/$data-requirements</p><p>URL: [base]/ConceptMap/$data-requirements</p><p>URL: [base]/ConceptMap/[id]/$data-requirements</p><p>URL: [base]/ExampleScenario/$data-requirements</p><p>URL: [base]/ExampleScenario/[id]/$data-requirements</p><p>URL: [base]/GraphDefinition/$data-requirements</p><p>URL: [base]/GraphDefinition/[id]/$data-requirements</p><p>URL: [base]/Group/$data-requirements</p><p>URL: [base]/Group/[id]/$data-requirements</p><p>URL: [base]/ImplementationGuide/$data-requirements</p><p>URL: [base]/ImplementationGuide/[id]/$data-requirements</p><p>URL: [base]/Library/$data-requirements</p><p>URL: [base]/Library/[id]/$data-requirements</p><p>URL: [base]/Measure/$data-requirements</p><p>URL: [base]/Measure/[id]/$data-requirements</p><p>URL: [base]/Medication/$data-requirements</p><p>URL: [base]/Medication/[id]/$data-requirements</p><p>URL: [base]/MedicationKnowledge/$data-requirements</p><p>URL: [base]/MedicationKnowledge/[id]/$data-requirements</p><p>URL: [base]/MessageDefinition/$data-requirements</p><p>URL: [base]/MessageDefinition/[id]/$data-requirements</p><p>URL: [base]/NamingSystem/$data-requirements</p><p>URL: [base]/NamingSystem/[id]/$data-requirements</p><p>URL: [base]/OperationDefinition/$data-requirements</p><p>URL: [base]/OperationDefinition/[id]/$data-requirements</p><p>URL: [base]/PlanDefinition/$data-requirements</p><p>URL: [base]/PlanDefinition/[id]/$data-requirements</p><p>URL: [base]/Questionnaire/$data-requirements</p><p>URL: [base]/Questionnaire/[id]/$data-requirements</p><p>URL: [base]/SearchParameter/$data-requirements</p><p>URL: [base]/SearchParameter/[id]/$data-requirements</p><p>URL: [base]/StructureDefinition/$data-requirements</p><p>URL: [base]/StructureDefinition/[id]/$data-requirements</p><p>URL: [base]/StructureMap/$data-requirements</p><p>URL: [base]/StructureMap/[id]/$data-requirements</p><p>URL: [base]/Substance/$data-requirements</p><p>URL: [base]/Substance/[id]/$data-requirements</p><p>URL: [base]/TerminologyCapabilities/$data-requirements</p><p>URL: [base]/TerminologyCapabilities/[id]/$data-requirements</p><p>URL: [base]/TestScript/$data-requirements</p><p>URL: [base]/TestScript/[id]/$data-requirements</p><p>URL: [base]/ValueSet/$data-requirements</p><p>URL: [base]/ValueSet/[id]/$data-requirements</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>url</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Optionally versioned canonical or artifact reference to the resource(s) for which data\nrequirements will be determined. Multiple artifacts will result in the aggregate data\nrequirements for all the artifacts.</p>\n<p>This parameter cannot be used when invoking at the instance level. When invoking at the\ntype level, the reference must be to a type that agrees with the invocation.</p>\n</div></td></tr><tr><td>IN</td><td>expression</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The identifier (optionally qualified) of the expression(s) for which data requirements will\nbe determined, regardless of whether the declaration is private. If no expression names are\nprovided, the operation determines data requirements for the entire artifact or artifacts.\nIf the operation is performed with multiple artifacts, expression names must be qualified with\nthe name of the library in which they appear. Note that this may result in expression requirements\nbeing included because they are called from a specified expression, rather than because they are\nspecified directly.</p>\n</div></td></tr><tr><td>IN</td><td>parameters</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td><div><p>Any input parameters (optionally qualified) for the artifact(s).\nIf any artifact is a logic library, or references logic libraries,\nparameters defined in this input will be bound by name to parameters\ndefined in the logic library (or referenced libraries). If parameter\nnames are qualified, the parameter will be bound only to parameters in\nthe library with the qualifier name, and the qualifier name must be the\nname of an artifact being processed (or an included library, recursively).\nIf the logic library is a CQL library, parameter types are mapped to CQL\nas specified in the Using CQL with FHIR implementation guide. If a\nparameter appears more than once in the input Parameters resource, it is\nrepresented with a List in the input CQL. If a parameter has parts, it is\nrepresented as a Tuple in the input CQL.</p>\n</div></td></tr><tr><td>IN</td><td>artifactVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Specifies a version to use for a canonical or artifact resource if the artifact referencing\nthe resource does not already specify a version. The format is the same as a canonical URL:\n[url]|[version] - e.g. http://loinc.org|2.56</p>\n<p>Note that this is a generalization of the <code>system-version</code> parameter to the $expand operation\nto apply to any canonical resource, including code systems.</p>\n</div></td></tr><tr><td>IN</td><td>checkArtifactVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical or artifact resource. If the artifact referencing\nthe resource specifies a different version, an error is returned instead of the package. The\nformat is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56</p>\n<p>Note that this is a generalization of the <code>check-system-version</code> parameter to the $expand operation to\napply to any canonical resource, including code systems.</p>\n</div></td></tr><tr><td>IN</td><td>forceArtifactVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical or artifact resource. This parameter overrides any\nspecified version in the artifact (and any artifacts it depends on). The\nformat is the same as a canonical URL: [system]|[version] - e.g.\nhttp://loinc.org|2.56. Note that this has obvious safety issues, in that it may\nresult in a value set expansion giving a different list of codes that is both\nwrong and unsafe, and implementers should only use this capability reluctantly.</p>\n<p>It primarily exists to deal with situations where specifications have fallen\ninto decay as time passes. If the version of a canonical is overridden, the version used SHALL\nexplicitly be represented in the expansion parameters.</p>\n<p>Note that this is a generalization of the <code>force-system-version</code> parameter to the $expand operation\nto apply to any canonical resource, including code systems.</p>\n</div></td></tr><tr><td>IN</td><td>manifest</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a> (<a href=\"StructureDefinition-crmi-manifestlibrary.html\" title=\"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary\">CRMI Manifest Library</a>)</td><td/><td><div><p>Specifies an asset-collection library that defines version\nbindings for code systems and other canonical resources referenced by the value\nset(s) being expanded and other canonical resources referenced by the artifact.\nWhen specified, the expansion parameters of the manifest are used to provide expansion\nbehavior and canonical resolution for dependencies encountered while processing the\noperation.</p>\n</div></td></tr><tr><td>IN</td><td>artifactEndpointConfiguration</td><td/><td>0..*</td><td/><td/><td><div><p>Configuration information to resolve canonical artifacts</p>\n<ul>\n<li><code>artifactRoute</code>: 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)</li>\n<li><code>endpointUri</code>: The URI of the endpoint, exclusive with the <code>endpoint</code> parameter</li>\n<li><code>endpoint</code>: An Endpoint resource describing the endpoint, exclusive with the <code>endpointUri</code> parameter</li>\n</ul>\n<p><strong>Processing semantics</strong>:</p>\n<p>Create a canonical-like reference (e.g.\n<code>{canonical.url}|{canonical.version}</code> or similar extensions for non-canonical artifacts).</p>\n<ul>\n<li>Given a single <code>artifactEndpointConfiguration</code>\n<ul>\n<li>When <code>artifactRoute</code> is present\n<ul>\n<li>And canonical or artifact reference <em>starts with</em> <code>artifactRoute</code></li>\n<li>Then attempt to resolve with <code>endpointUri</code> or <code>endpoint</code></li>\n</ul>\n</li>\n<li>When <code>artifactRoute</code> is not present\n<ul>\n<li>Then attempt to resolve with <code>endpointUri</code> or <code>endpoint</code></li>\n</ul>\n</li>\n</ul>\n</li>\n<li>Given multiple <code>artifactEndpointConfiguration</code>s\n<ul>\n<li>Then rank order each configuration (see below)</li>\n<li>And attempt to resolve with <code>endpointUri</code> or <code>endpoint</code> in order until resolved</li>\n</ul>\n</li>\n</ul>\n<p>Rank each <code>artifactEndpointConfiguration</code> such that:</p>\n<ul>\n<li>if <code>artifactRoute</code> is present <em>and</em> canonical or artifact reference <em>starts with</em> <code>artifactRoute</code>: rank based on number of matching characters</li>\n<li>if <code>artifactRoute</code> is <em>not</em> present: include but rank lower</li>\n</ul>\n<p>NOTE: For evenly ranked <code>artifactEndpointConfiguration</code>s, order as defined in the\nOperationDefinition.</p>\n</div></td></tr><tr><td>IN</td><td>artifactEndpointConfiguration.artifactRoute</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr><tr><td>IN</td><td>artifactEndpointConfiguration.endpointUri</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr><tr><td>IN</td><td>artifactEndpointConfiguration.endpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td/></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/library.html\">Library</a></td><td/><td><div><p>The result of the requirements operation is a <em>module-definition</em> Library that\nreturns the computed effective requirements of the artifact (or the aggregate effective\nrequirements of the artifacts, if multiple artifacts are specified).</p>\n</div></td></tr></table><div><p>The data requirements operation is used for dependency gathering, as a way to understand\nthe set of dependencies of a given artifact (or set of artifacts), as well as for data requirements\ndetermination, as a way to understand the complete set of data requirements for a given artifact\n(or set of artifacts), including\nterminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies,\nand data requirements.</p>\n<p>When the value of an element of a data requirement cannot be determined due to a processing exception\n(for example, a code filter based on the result of a function), the <a href=\"StructureDefinition-crmi-analysisException.html\">crmi-analysisException</a>\nextension is used on that element to indicate that the value could not be determined, with a message describing the exception.</p>\n</div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 4,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
}
]
}
}
],
"url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-data-requirements",
"version" : "3.0.0-ballot",
"name" : "CRMIDataRequirements",
"title" : "CRMI Data Requirements",
"status" : "active",
"kind" : "operation",
"date" : "2026-11-18T15:03:22+00:00",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "Determines the effective data requirements for one or more artifacts, including known\ncomponents and dependencies, and optionally informed by a version manifest. When multiple\nartifacts are specified, the result is the aggregate data requirements for all the artifacts.\n\nSee [$package and $data-requirements](distribution.html#package-and-data-requirements)",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"code" : "data-requirements",
"comment" : "The data requirements operation is used for dependency gathering, as a way to understand \nthe set of dependencies of a given artifact (or set of artifacts), as well as for data requirements \ndetermination, as a way to understand the complete set of data requirements for a given artifact \n(or set of artifacts), including \nterminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies,\nand data requirements.\n\nWhen the value of an element of a data requirement cannot be determined due to a processing exception\n(for example, a code filter based on the result of a function), the [crmi-analysisException](StructureDefinition-crmi-analysisException.html)\nextension is used on that element to indicate that the value could not be determined, with a message describing the exception.",
"resource" : [
"ActivityDefinition",
"CapabilityStatement",
"CodeSystem",
"CompartmentDefinition",
"ConceptMap",
"ExampleScenario",
"GraphDefinition",
"Group",
"ImplementationGuide",
"Library",
"Measure",
"Medication",
"MedicationKnowledge",
"MessageDefinition",
"NamingSystem",
"OperationDefinition",
"PlanDefinition",
"Questionnaire",
"SearchParameter",
"StructureDefinition",
"StructureMap",
"Substance",
"TerminologyCapabilities",
"TestScript",
"ValueSet"
],
"system" : true,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Optionally versioned canonical or artifact reference to the resource(s) for which data \nrequirements will be determined. Multiple artifacts will result in the aggregate data \nrequirements for all the artifacts.\n\nThis parameter cannot be used when invoking at the instance level. When invoking at the\ntype level, the reference must be to a type that agrees with the invocation.",
"type" : "uri"
},
{
"name" : "expression",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The identifier (optionally qualified) of the expression(s) for which data requirements will \nbe determined, regardless of whether the declaration is private. If no expression names are \nprovided, the operation determines data requirements for the entire artifact or artifacts. \nIf the operation is performed with multiple artifacts, expression names must be qualified with\nthe name of the library in which they appear. Note that this may result in expression requirements\nbeing included because they are called from a specified expression, rather than because they are\nspecified directly.",
"type" : "string"
},
{
"name" : "parameters",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Any input parameters (optionally qualified) for the artifact(s). \nIf any artifact is a logic library, or references logic libraries, \nparameters defined in this input will be bound by name to parameters \ndefined in the logic library (or referenced libraries). If parameter\nnames are qualified, the parameter will be bound only to parameters in\nthe library with the qualifier name, and the qualifier name must be the\nname of an artifact being processed (or an included library, recursively). \nIf the logic library is a CQL library, parameter types are mapped to CQL \nas specified in the Using CQL with FHIR implementation guide. If a \nparameter appears more than once in the input Parameters resource, it is \nrepresented with a List in the input CQL. If a parameter has parts, it is \nrepresented as a Tuple in the input CQL.",
"type" : "Parameters"
},
{
"name" : "artifactVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Specifies a version to use for a canonical or artifact resource if the artifact referencing \nthe resource does not already specify a version. The format is the same as a canonical URL:\n[url]|[version] - e.g. http://loinc.org|2.56 \n\nNote that this is a generalization of the `system-version` parameter to the $expand operation \nto apply to any canonical resource, including code systems.",
"type" : "uri"
},
{
"name" : "checkArtifactVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a canonical or artifact resource. If the artifact referencing \nthe resource specifies a different version, an error is returned instead of the package. The\nformat is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 \n\nNote that this is a generalization of the `check-system-version` parameter to the $expand operation to \napply to any canonical resource, including code systems.",
"type" : "uri"
},
{
"name" : "forceArtifactVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a canonical or artifact resource. This parameter overrides any\nspecified version in the artifact (and any artifacts it depends on). The\nformat is the same as a canonical URL: [system]|[version] - e.g.\nhttp://loinc.org|2.56. Note that this has obvious safety issues, in that it may\nresult in a value set expansion giving a different list of codes that is both\nwrong and unsafe, and implementers should only use this capability reluctantly.\n\nIt primarily exists to deal with situations where specifications have fallen\ninto decay as time passes. If the version of a canonical is overridden, the version used SHALL\nexplicitly be represented in the expansion parameters. \n\nNote that this is a generalization of the `force-system-version` parameter to the $expand operation \nto apply to any canonical resource, including code systems.",
"type" : "uri"
},
{
"name" : "manifest",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Specifies an asset-collection library that defines version\nbindings for code systems and other canonical resources referenced by the value\nset(s) being expanded and other canonical resources referenced by the artifact.\nWhen specified, the expansion parameters of the manifest are used to provide expansion\nbehavior and canonical resolution for dependencies encountered while processing the \noperation.",
"type" : "canonical",
"targetProfile" : [
🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary"
]
},
{
"name" : "artifactEndpointConfiguration",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Configuration information to resolve canonical artifacts\n* `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)\n* `endpointUri`: The URI of the endpoint, exclusive with the `endpoint` parameter\n* `endpoint`: An Endpoint resource describing the endpoint, exclusive with the `endpointUri` parameter\n\n**Processing semantics**:\n\nCreate a canonical-like reference (e.g.\n`{canonical.url}|{canonical.version}` or similar extensions for non-canonical artifacts).\n\n* Given a single `artifactEndpointConfiguration`\n * When `artifactRoute` is present\n * And canonical or artifact reference *starts with* `artifactRoute`\n * Then attempt to resolve with `endpointUri` or `endpoint`\n * When `artifactRoute` is not present\n * Then attempt to resolve with `endpointUri` or `endpoint`\n* Given multiple `artifactEndpointConfiguration`s\n * Then rank order each configuration (see below)\n * And attempt to resolve with `endpointUri` or `endpoint` in order until resolved\n\nRank each `artifactEndpointConfiguration` such that:\n* if `artifactRoute` is present *and* canonical or artifact reference *starts with* `artifactRoute`: rank based on number of matching characters \n* if `artifactRoute` is *not* present: include but rank lower\n\nNOTE: For evenly ranked `artifactEndpointConfiguration`s, order as defined in the\nOperationDefinition.",
"part" : [
{
"name" : "artifactRoute",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "uri"
},
{
"name" : "endpointUri",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "uri"
},
{
"name" : "endpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "Endpoint"
}
]
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the requirements operation is a _module-definition_ Library that\nreturns the computed effective requirements of the artifact (or the aggregate effective\nrequirements of the artifacts, if multiple artifacts are specified).",
"type" : "Library"
}
]
}