Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Draft as of 2023-03-12 |
{
"resourceType" : "OperationDefinition",
"id" : "crmi-data-requirements",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/ActivityDefinition/$crmi.data-requirements</p><p>URL: [base]/ActivityDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/CapabilityStatement/$crmi.data-requirements</p><p>URL: [base]/CapabilityStatement/[id]/$crmi.data-requirements</p><p>URL: [base]/ChargeItemDefinition/$crmi.data-requirements</p><p>URL: [base]/ChargeItemDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/CodeSystem/$crmi.data-requirements</p><p>URL: [base]/CodeSystem/[id]/$crmi.data-requirements</p><p>URL: [base]/CompartmentDefinition/$crmi.data-requirements</p><p>URL: [base]/CompartmentDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/ConceptMap/$crmi.data-requirements</p><p>URL: [base]/ConceptMap/[id]/$crmi.data-requirements</p><p>URL: [base]/EffectEvidenceSynthesis/$crmi.data-requirements</p><p>URL: [base]/EffectEvidenceSynthesis/[id]/$crmi.data-requirements</p><p>URL: [base]/EventDefinition/$crmi.data-requirements</p><p>URL: [base]/EventDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/Evidence/$crmi.data-requirements</p><p>URL: [base]/Evidence/[id]/$crmi.data-requirements</p><p>URL: [base]/EvidenceVariable/$crmi.data-requirements</p><p>URL: [base]/EvidenceVariable/[id]/$crmi.data-requirements</p><p>URL: [base]/ExampleScenario/$crmi.data-requirements</p><p>URL: [base]/ExampleScenario/[id]/$crmi.data-requirements</p><p>URL: [base]/GraphDefinition/$crmi.data-requirements</p><p>URL: [base]/GraphDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/ImplementationGuide/$crmi.data-requirements</p><p>URL: [base]/ImplementationGuide/[id]/$crmi.data-requirements</p><p>URL: [base]/Library/$crmi.data-requirements</p><p>URL: [base]/Library/[id]/$crmi.data-requirements</p><p>URL: [base]/Measure/$crmi.data-requirements</p><p>URL: [base]/Measure/[id]/$crmi.data-requirements</p><p>URL: [base]/MessageDefinition/$crmi.data-requirements</p><p>URL: [base]/MessageDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/NamingSystem/$crmi.data-requirements</p><p>URL: [base]/NamingSystem/[id]/$crmi.data-requirements</p><p>URL: [base]/OperationDefinition/$crmi.data-requirements</p><p>URL: [base]/OperationDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/PlanDefinition/$crmi.data-requirements</p><p>URL: [base]/PlanDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/Questionnaire/$crmi.data-requirements</p><p>URL: [base]/Questionnaire/[id]/$crmi.data-requirements</p><p>URL: [base]/ResearchDefinition/$crmi.data-requirements</p><p>URL: [base]/ResearchDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/ResearchElementDefinition/$crmi.data-requirements</p><p>URL: [base]/ResearchElementDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/RiskEvidenceSynthesis/$crmi.data-requirements</p><p>URL: [base]/RiskEvidenceSynthesis/[id]/$crmi.data-requirements</p><p>URL: [base]/SearchParameter/$crmi.data-requirements</p><p>URL: [base]/SearchParameter/[id]/$crmi.data-requirements</p><p>URL: [base]/StructureDefinition/$crmi.data-requirements</p><p>URL: [base]/StructureDefinition/[id]/$crmi.data-requirements</p><p>URL: [base]/StructureMap/$crmi.data-requirements</p><p>URL: [base]/StructureMap/[id]/$crmi.data-requirements</p><p>URL: [base]/TerminologyCapabilities/$crmi.data-requirements</p><p>URL: [base]/TerminologyCapabilities/[id]/$crmi.data-requirements</p><p>URL: [base]/TestScript/$crmi.data-requirements</p><p>URL: [base]/TestScript/[id]/$crmi.data-requirements</p><p>URL: [base]/ValueSet/$crmi.data-requirements</p><p>URL: [base]/ValueSet/[id]/$crmi.data-requirements</p><p>Parameters</p><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>id</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The logical id of the canonical resource to analyze.</p>\n</div></td></tr><tr><td>IN</td><td>url</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>A canonical reference to a canonical resource.</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The version of the canonical resource to analyze</p>\n</div></td></tr><tr><td>IN</td><td>identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>A business identifier of the canonical resource to be analyzed.</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 name of a specific expression to be considered for analysis. If no\nexpressions are specified, the analysis is performed on the entire resource. If\nexpressions are specified, the analysis is performed only on the expressions\nspecified.</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 for the artifact. Parameters defined in this input will be\nbound by name to parameters defined in the CQL library (or referenced\nlibraries). Parameter types are mapped to CQL as specified in the Using CQL\nsection of this implementation guide. If a parameter appears more than once in\nthe input Parameters resource, it is represented with a List in the input CQL.\nIf a parameter has parts, it is represented as a Tuple in the input CQL.</p>\n<p>NOTE: Does this only apply to Library resource types?</p>\n</div></td></tr><tr><td>IN</td><td>canonicalVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Specifies a version to use for a canonical 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>checkCanonicalVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical 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>forceCanonicalVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical 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 overriden, 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></td><td/><td><div><p>Specifies an asset-collection library that defines version bindings for code\nsystems and other canonical resources referenced by the value set(s) being expanded\nand other canonical resources referenced by the artifact. When specified, code\nsystems and other canonical resources identified as <code>depends-on</code> related artifacts\nin the manifest library have the same meaning as specifying that code system or other\ncanonical version in the <code>system-version</code> parameter of an expand or the <code>canonicalVersion</code>\nparameter.</p>\n</div></td></tr><tr><td>IN</td><td>include</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Specifies what contents should be included in the resulting package. The codes indicate which types of resources should be included, but note that\nthe set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts. Possible\nvalues are:</p>\n<ul>\n<li>all (default) - all resource types</li>\n<li>artifact - the specified artifact</li>\n<li>canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)</li>\n<li>terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)</li>\n<li>conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)</li>\n<li>profiles - profile definitions (i.e. StructureDefinition resources that define profiles)</li>\n<li>extensions - extension definitions (i.e. StructureDefinition resources that define extensions)</li>\n<li>knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)</li>\n<li>tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)</li>\n<li>examples - example resources (i.e. resources identified as examples in the implementation guide)</li>\n</ul>\n</div></td></tr><tr><td>IN</td><td>contentEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access content (i.e. libraries, activities, measures, questionnaires, and plans) referenced by the\nartifact. If no content endpoint is supplied the evaluation will attempt to\nretrieve content from the server on which the operation is being performed.</p>\n</div></td></tr><tr><td>IN</td><td>terminologyEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and\nmembership testing) referenced by the Resource. If no terminology endpoint is\nsupplied, the evaluation will attempt to use the server on which the operation\nis being performed as the terminology server.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</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.</p>\n</div></td></tr></table><div><p>The requirements operation supports the ability of a repository to determine the\neffective requirements of an artifact, including terminology usage (code\nsystems, value sets, and direct-reference codes), parameters, dependencies\n(artifacts), and data requirements</p>\n</div></div>"
},
"url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-data-requirements",
"version" : "1.0.0-ballot",
"name" : "CRMIDataRequirements",
"title" : "CRMI Data Requirements",
"status" : "draft",
"kind" : "operation",
"experimental" : false,
"date" : "2023-03-12",
"publisher" : "Clinical Decision Support WG",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "Determines the effective data requirements for the artifact, including known\ncomponents and dependencies, and optionally informed by a version manifest.\n\nSee [$crmi.package and $crmi.data-requirements](introduction.html)\n\n*TODO*: Add example of the use-case that will do dependency tracing, similar to\n`$package` but returns only the information and not the actual resources.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"code" : "crmi.data-requirements",
"comment" : "The requirements operation supports the ability of a repository to determine the\neffective requirements of an artifact, including terminology usage (code\nsystems, value sets, and direct-reference codes), parameters, dependencies\n(artifacts), and data requirements",
"resource" : [
"ActivityDefinition",
"CapabilityStatement",
"ChargeItemDefinition",
"CodeSystem",
"CompartmentDefinition",
"ConceptMap",
"EffectEvidenceSynthesis",
"EventDefinition",
"Evidence",
"EvidenceVariable",
"ExampleScenario",
"GraphDefinition",
"ImplementationGuide",
"Library",
"Measure",
"MessageDefinition",
"NamingSystem",
"OperationDefinition",
"PlanDefinition",
"Questionnaire",
"ResearchDefinition",
"ResearchElementDefinition",
"RiskEvidenceSynthesis",
"SearchParameter",
"StructureDefinition",
"StructureMap",
"TerminologyCapabilities",
"TestScript",
"ValueSet"
],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "id",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The logical id of the canonical resource to analyze.",
"type" : "string"
},
{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to a canonical resource.",
"type" : "uri"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the canonical resource to analyze",
"type" : "string"
},
{
"name" : "identifier",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A business identifier of the canonical resource to be analyzed.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "expression",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The name of a specific expression to be considered for analysis. If no\nexpressions are specified, the analysis is performed on the entire resource. If\nexpressions are specified, the analysis is performed only on the expressions\nspecified.",
"type" : "string"
},
{
"name" : "parameters",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Any input parameters for the artifact. Parameters defined in this input will be\nbound by name to parameters defined in the CQL library (or referenced\nlibraries). Parameter types are mapped to CQL as specified in the Using CQL\nsection of this implementation guide. If a parameter appears more than once in\nthe input Parameters resource, it is represented with a List in the input CQL.\nIf a parameter has parts, it is represented as a Tuple in the input CQL.\n\nNOTE: Does this only apply to Library resource types?",
"type" : "Parameters"
},
{
"name" : "canonicalVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Specifies a version to use for a canonical 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" : "canonical"
},
{
"name" : "checkCanonicalVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a canonical 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" : "canonical"
},
{
"name" : "forceCanonicalVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a canonical 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 overriden, 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" : "canonical"
},
{
"name" : "manifest",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Specifies an asset-collection library that defines version bindings for code\nsystems and other canonical resources referenced by the value set(s) being expanded\nand other canonical resources referenced by the artifact. When specified, code\nsystems and other canonical resources identified as `depends-on` related artifacts \nin the manifest library have the same meaning as specifying that code system or other\ncanonical version in the `system-version` parameter of an expand or the `canonicalVersion` \nparameter.",
"type" : "canonical"
},
{
"name" : "include",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Specifies what contents should be included in the resulting package. The codes indicate which types of resources should be included, but note that\nthe set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts. Possible\nvalues are:\n* all (default) - all resource types\n* artifact - the specified artifact\n* canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)\n* terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)\n* conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)\n* profiles - profile definitions (i.e. StructureDefinition resources that define profiles)\n* extensions - extension definitions (i.e. StructureDefinition resources that define extensions) \n* knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)\n* tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)\n* examples - example resources (i.e. resources identified as examples in the implementation guide)",
"type" : "string"
},
{
"name" : "contentEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access content (i.e. libraries, activities, measures, questionnaires, and plans) referenced by the\nartifact. If no content endpoint is supplied the evaluation will attempt to\nretrieve content from the server on which the operation is being performed.",
"type" : "Endpoint"
},
{
"name" : "terminologyEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and\nmembership testing) referenced by the Resource. If no terminology endpoint is\nsupplied, the evaluation will attempt to use the server on which the operation\nis being performed as the terminology server.",
"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.",
"type" : "Bundle"
}
]
}
IG © 2022+ Clinical Decision Support WG. Package hl7.fhir.uv.crmi#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change