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 Shareable CodeSystem

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem Version: 1.1.0-cibuild
Standards status: Trial-use Maturity Level: 4 Computable Name: CRMIShareableCodeSystem
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.47

Enforces the minimum information set for the code system metadata required by HL7 and other organizations that share and publish code systems

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning
scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... versionAlgorithm S 0..1 string, Coding ​How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... version SΣ 1..1 string Business version of the code system (Coding.version)
ele-1: All FHIR elements must have a @value or children
... name SΣC 0..1 string Name for this code system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Name for this code system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher (organization or individual)
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the code system
ele-1: All FHIR elements must have a @value or children
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
ele-1: All FHIR elements must have a @value or children
... hierarchyMeaning SΣC 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.


ele-1: All FHIR elements must have a @value or children
... content SΣC 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.


ele-1: All FHIR elements must have a @value or children
... concept SC 0..* BackboneElement Concepts in the code system
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code S 1..1 code Code that identifies concept
ele-1: All FHIR elements must have a @value or children
.... display S 0..1 string Text to display to the user
ele-1: All FHIR elements must have a @value or children
.... definition S 0..1 string Formal definition
ele-1: All FHIR elements must have a @value or children
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1
from the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
scs-1errorCodeSystemIf a codesystem contains nested concepts, it must specify hierarchyMeaning
: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2errorCodeSystemIf a codesystem contains example, fragment, or complete content, it must have at least one concept
: content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()

 

Other representations of profile: CSV, Excel, Schematron