Canonical Resource 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 1.1.0-cibuild 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
Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-package | Version: 1.1.0-cibuild | |||
Active as of 2024-08-29 | Computable Name: CRMIPackage | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.33.5 |
Packages a specified canonical resource for use in a target environment, optionally including related content such as dependencies, components, and testing cases and data.
See $package and $data-requirements
Generated Narrative: OperationDefinition crmi-package
URL: [base]/ActivityDefinition/$package
URL: [base]/ActivityDefinition/[id]/$package
URL: [base]/CapabilityStatement/$package
URL: [base]/CapabilityStatement/[id]/$package
URL: [base]/CodeSystem/$package
URL: [base]/CodeSystem/[id]/$package
URL: [base]/CompartmentDefinition/$package
URL: [base]/CompartmentDefinition/[id]/$package
URL: [base]/ConceptMap/$package
URL: [base]/ConceptMap/[id]/$package
URL: [base]/ExampleScenario/$package
URL: [base]/ExampleScenario/[id]/$package
URL: [base]/GraphDefinition/$package
URL: [base]/GraphDefinition/[id]/$package
URL: [base]/ImplementationGuide/$package
URL: [base]/ImplementationGuide/[id]/$package
URL: [base]/Library/$package
URL: [base]/Library/[id]/$package
URL: [base]/Measure/$package
URL: [base]/Measure/[id]/$package
URL: [base]/Medication/$package
URL: [base]/Medication/[id]/$package
URL: [base]/MedicationKnowledge/$package
URL: [base]/MedicationKnowledge/[id]/$package
URL: [base]/MessageDefinition/$package
URL: [base]/MessageDefinition/[id]/$package
URL: [base]/NamingSystem/$package
URL: [base]/NamingSystem/[id]/$package
URL: [base]/OperationDefinition/$package
URL: [base]/OperationDefinition/[id]/$package
URL: [base]/PlanDefinition/$package
URL: [base]/PlanDefinition/[id]/$package
URL: [base]/Questionnaire/$package
URL: [base]/Questionnaire/[id]/$package
URL: [base]/SearchParameter/$package
URL: [base]/SearchParameter/[id]/$package
URL: [base]/StructureDefinition/$package
URL: [base]/StructureDefinition/[id]/$package
URL: [base]/StructureMap/$package
URL: [base]/StructureMap/[id]/$package
URL: [base]/Substance/$package
URL: [base]/Substance/[id]/$package
URL: [base]/TerminologyCapabilities/$package
URL: [base]/TerminologyCapabilities/[id]/$package
URL: [base]/TestScript/$package
URL: [base]/TestScript/[id]/$package
URL: [base]/ValueSet/$package
URL: [base]/ValueSet/[id]/$package
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 or artifact 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 | terminologyCapabilities | 0..1 | TerminologyCapabilities | A TerminologyCapabilities resource describing the expected terminology capabilities of the target environment. For example, an environment may be capable of processing specific types of value set definitions, but not others (e.g. LOINC panel definitions, but not SNOMED hierarchies). | ||
IN | artifactVersion | 0..* | 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 | ||
IN | checkArtifactVersion | 0..* | 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 | ||
IN | forceArtifactVersion | 0..* | 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
| ||
IN | manifest | 0..1 | canonical (CRMI Manifest Library) | Specifies a reference to 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). If offset > 0 the resulting bundle will be of type | ||
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. If count > 0 but less than the total number of resources, the result will be a bundle of type | ||
IN | include | 0..* | code | Specifies what contents should only 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 either a code to mean a category of resource types:
Or a valid FHIR resource Type (e.g. | ||
IN | includeUri | 0..* | uri | Specifies what contents should be included in the resulting package by canonical
URL, can take the form | ||
IN | exclude | 0..* | code | Specifies what contents should be excluded in the resulting package. The codes indicate which types of resources should be excluded, 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 either a code to mean a category of resource types:
Or a valid FHIR resource Type (e.g. | ||
IN | excludeUri | 0..* | uri | Specifies what contents should be excluded in the resulting package by canonical
URL, can take the form | ||
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 | artifactEndpointConfiguration | 0..* | Configuration information to resolve canonical artifacts
Processing semantics: Create a canonical-like reference (e.g.
Rank each
NOTE: For evenly ranked | |||
IN | artifactEndpointConfiguration.artifactRoute | 0..1 | uri | |||
IN | artifactEndpointConfiguration.endpointUri | 0..1 | uri | |||
IN | artifactEndpointConfiguration.endpoint | 0..1 | Endpoint | |||
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. If the resulting bundle is paged using 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. |
The package operation supports producing a complete package of a particular artifact supporting the capabilities expected to be available in a particular target environment. For example, a Questionnaire may be packaged together with the value sets referenced by elements of the questionnaire, and those value sets may be definitions (Computable) or expansions (Expanded), depending on the parameters to the operation.