Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild International flag

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

Resource Profile: CRMI Operation Profile: Canonical Version Bindable

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-canonical-version-bindable-operation Version: 1.1.0-cibuild
Active as of 2024-08-29 Computable Name: CanonicalVersionBindableOperation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.5

Operation where default canonical version(s) can be specified

NOTE: This profile is here for backwards compatibility, see ArtifactVersionBindableOperation profile as a successor.

  • canonicalVersion: 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
  • checkCanonicalVersion: 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
  • forceCanonicalVersion: 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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
... Slices for parameter 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
.... parameter:canonicalVersion S 0..* BackboneElement Parameters for the operation/query
..... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: canonicalVersion
..... use 1..1 code in | out
Required Pattern: in
..... min 1..1 integer Minimum Cardinality
Required Pattern: 0
..... max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: *
..... type 0..1 code What type this parameter has
Required Pattern: canonical
.... parameter:checkCanonicalVersion S 0..* BackboneElement Parameters for the operation/query
..... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: checkCanonicalVersion
..... use 1..1 code in | out
Required Pattern: in
..... min 1..1 integer Minimum Cardinality
Required Pattern: 0
..... max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: *
..... type 0..1 code What type this parameter has
Required Pattern: canonical
.... parameter:forceCanonicalVersion S 0..* BackboneElement Parameters for the operation/query
..... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: forceCanonicalVersion
..... use 1..1 code in | out
Required Pattern: in
..... min 1..1 integer Minimum Cardinality
Required Pattern: 0
..... max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: *
..... type 0..1 code What type this parameter has
Required Pattern: canonical

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron