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
Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-package | Version: 1.0.0-ballot | |||
Draft as of 2023-03-12 | Computable Name: CRMIPackage |
Packages a specified canonical resource with dependencies.
See $package and $data-requirements
URL: [base]/ActivityDefinition/$crmi.package
URL: [base]/ActivityDefinition/[id]/$crmi.package
URL: [base]/CapabilityStatement/$crmi.package
URL: [base]/CapabilityStatement/[id]/$crmi.package
URL: [base]/ChargeItemDefinition/$crmi.package
URL: [base]/ChargeItemDefinition/[id]/$crmi.package
URL: [base]/CodeSystem/$crmi.package
URL: [base]/CodeSystem/[id]/$crmi.package
URL: [base]/CompartmentDefinition/$crmi.package
URL: [base]/CompartmentDefinition/[id]/$crmi.package
URL: [base]/ConceptMap/$crmi.package
URL: [base]/ConceptMap/[id]/$crmi.package
URL: [base]/EffectEvidenceSynthesis/$crmi.package
URL: [base]/EffectEvidenceSynthesis/[id]/$crmi.package
URL: [base]/EventDefinition/$crmi.package
URL: [base]/EventDefinition/[id]/$crmi.package
URL: [base]/Evidence/$crmi.package
URL: [base]/Evidence/[id]/$crmi.package
URL: [base]/EvidenceVariable/$crmi.package
URL: [base]/EvidenceVariable/[id]/$crmi.package
URL: [base]/ExampleScenario/$crmi.package
URL: [base]/ExampleScenario/[id]/$crmi.package
URL: [base]/GraphDefinition/$crmi.package
URL: [base]/GraphDefinition/[id]/$crmi.package
URL: [base]/ImplementationGuide/$crmi.package
URL: [base]/ImplementationGuide/[id]/$crmi.package
URL: [base]/Library/$crmi.package
URL: [base]/Library/[id]/$crmi.package
URL: [base]/Measure/$crmi.package
URL: [base]/Measure/[id]/$crmi.package
URL: [base]/MessageDefinition/$crmi.package
URL: [base]/MessageDefinition/[id]/$crmi.package
URL: [base]/NamingSystem/$crmi.package
URL: [base]/NamingSystem/[id]/$crmi.package
URL: [base]/OperationDefinition/$crmi.package
URL: [base]/OperationDefinition/[id]/$crmi.package
URL: [base]/PlanDefinition/$crmi.package
URL: [base]/PlanDefinition/[id]/$crmi.package
URL: [base]/Questionnaire/$crmi.package
URL: [base]/Questionnaire/[id]/$crmi.package
URL: [base]/ResearchDefinition/$crmi.package
URL: [base]/ResearchDefinition/[id]/$crmi.package
URL: [base]/ResearchElementDefinition/$crmi.package
URL: [base]/ResearchElementDefinition/[id]/$crmi.package
URL: [base]/RiskEvidenceSynthesis/$crmi.package
URL: [base]/RiskEvidenceSynthesis/[id]/$crmi.package
URL: [base]/SearchParameter/$crmi.package
URL: [base]/SearchParameter/[id]/$crmi.package
URL: [base]/StructureDefinition/$crmi.package
URL: [base]/StructureDefinition/[id]/$crmi.package
URL: [base]/StructureMap/$crmi.package
URL: [base]/StructureMap/[id]/$crmi.package
URL: [base]/TerminologyCapabilities/$crmi.package
URL: [base]/TerminologyCapabilities/[id]/$crmi.package
URL: [base]/TestScript/$crmi.package
URL: [base]/TestScript/[id]/$crmi.package
URL: [base]/ValueSet/$crmi.package
URL: [base]/ValueSet/[id]/$crmi.package
Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | id | 0..1 | string | The logical id of an existing Resource to package on the server. | ||
IN | url | 0..1 | uri | A canonical reference to a Resource to package on the server. | ||
IN | version | 0..1 | string | The version of the Resource | ||
IN | identifier | 0..1 | string (token) | A business identifier of the Resource. | ||
IN | capability | 0..* | string | A desired capability of the resulting package. | ||
IN | canonicalVersion | 0..* | canonical | 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 | ||
IN | checkCanonicalVersion | 0..* | canonical | 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 | ||
IN | forceCanonicalVersion | 0..* | canonical | 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
| ||
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 | ||
IN | offset | 0..1 | integer | Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages) | ||
IN | count | 0..1 | integer | Paging support - how many resources should be provided in a partial page view. If count = 0, the client is asking how large the package is. | ||
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:
| ||
IN | packageOnly | 0..1 | boolean | True to indicate that the resulting package should only include resources that are defined in the implementation guide or specification that defines the artifact being packaged. False (default) to indicate that the resulting package should include resources regardless of what implementation guide or specification they are defined in. | ||
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 | Bundle | The result of the packaging. Servers generating packages SHALL include all the dependency resources referenced by the artifact that are known to the server and specified by the include parameters. For example, a measure repository SHALL include all the required library resources, but would not necessarily have the ValueSet resources referenced by the measure. |
TODO: More documentation about the operation, including inline examples:
{
"resourceType": "Bundle"
}