Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot
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.0.0-snapshot 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/StructureDefinition/crmi-shareablecodesystem | Version: 1.0.0-snapshot | |||
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CodeSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CodeSystem |
C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement 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 |
  knowledgeRepresentationLevel |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| versionAlgorithm |
S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| 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 |
 url |
S | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
 version |
S | 1..1 | string | Business version of the code system (Coding.version) |
| name |
S | 0..1 | string | Name for this code system (computer friendly) |
| title |
S | 1..1 | string | Name for this code system (human friendly) |
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
S | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
S | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the code system |
| caseSensitive |
S | 1..1 | boolean | If code comparison is case sensitive |
| hierarchyMeaning |
SC | 0..1 | code | grouped-by | is-a | part-of | classified-with |
| content |
SC | 1..1 | code | not-present | example | fragment | complete | supplement |
 concept |
SC | 0..* | BackboneElement | Concepts in the code system |
 code |
S | 1..1 | code | Code that identifies concept |
| display |
S | 0..1 | string | Text to display to the user |
| definition |
S | 0..1 | string | Formal definition |
 concept |
SC | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| scs-1 | error | CodeSystem | If a codesystem contains nested concepts, it must specify hierarchyMeaning : concept.concept.exists() implies hierarchyMeaning.exists() | |
| scs-2 | error | CodeSystem | If a codesystem contains example, fragment, or complete content, it must have at least one concept : content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 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 |
| knowledgeRepresentationLevel |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| versionAlgorithm |
S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| 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 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
| version |
SΣ | 1..1 | string | Business version of the code system (Coding.version) |
| name |
SΣC | 0..1 | string | Name for this code system (computer friendly) |
| title |
SΣ | 1..1 | string | Name for this code system (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the code system |
| caseSensitive |
SΣ | 1..1 | boolean | If code comparison is case sensitive |
| 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. |
| 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. |
 concept |
SC | 0..* | BackboneElement | Concepts in the code system |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 1..1 | code | Code that identifies concept |
| display |
S | 0..1 | string | Text to display to the user |
| definition |
S | 0..1 | string | Formal definition |
| concept |
SC | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaninghttp://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1from the FHIR Standard | |
| CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| csd-0 | warning | CodeSystem | Name 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-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
| dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CodeSystem | 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 : 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-4 | error | CodeSystem | If 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-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| scs-1 | error | CodeSystem | If a codesystem contains nested concepts, it must specify hierarchyMeaning : concept.concept.exists() implies hierarchyMeaning.exists() | |
| scs-2 | error | CodeSystem | If a codesystem contains example, fragment, or complete content, it must have at least one concept : content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| knowledgeRepresentationLevel |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| versionAlgorithm |
S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | ||||
| 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 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the code system (business identifier) | ||||
| version |
SΣ | 1..1 | string | Business version of the code system (Coding.version) | ||||
| name |
SΣC | 0..1 | string | Name for this code system (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this code system (human friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 1..1 | markdown | Natural language description of the code system | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this code system is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| caseSensitive |
SΣ | 1..1 | boolean | If code comparison is case sensitive | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
| 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. | ||||
| compositional |
Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
| versionNeeded |
Σ | 0..1 | boolean | If definitions are not stable | ||||
| 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. | ||||
| supplements |
Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | ||||
| count |
Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
 filter |
Σ | 0..* | BackboneElement | Filter that can be used in a value set | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | code | Code that identifies the filter | ||||
| description |
Σ | 0..1 | string | How or why the filter is used | ||||
| operator |
Σ | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
| value |
Σ | 1..1 | string | What to use for the value | ||||
| property |
Σ | 0..* | BackboneElement | Additional information supplied about each concept | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
| uri |
Σ | 0..1 | uri | Formal identifier for the property | ||||
| description |
Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
| type |
Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
| concept |
SC | 0..* | BackboneElement | Concepts in the code system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Code that identifies concept | ||||
| display |
S | 0..1 | string | Text to display to the user | ||||
| definition |
S | 0..1 | string | Formal definition | ||||
| designation |
0..* | BackboneElement | Additional representations for the concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| use |
0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value |
1..1 | string | The text value for this designation | |||||
| property |
0..* | BackboneElement | Property value for the concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | code | Reference to CodeSystem.property.code | |||||
 value[x] |
1..1 | Value of the property for this concept | ||||||
| valueCode |
code | |||||||
| valueCoding |
Coding | |||||||
| valueString |
string | |||||||
| valueInteger |
integer | |||||||
| valueBoolean |
boolean | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| concept |
SC | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CodeSystem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaninghttp://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1from the FHIR Standard | ||||
| CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1from the FHIR Standard | ||||
| CodeSystem.filter.operator | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard | ||||
| CodeSystem.property.type | required | PropertyTypehttp://hl7.org/fhir/ValueSet/concept-property-type|4.0.1from the FHIR Standard | ||||
| CodeSystem.concept.designation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CodeSystem.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| csd-0 | warning | CodeSystem | Name 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-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
| dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CodeSystem | 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 : 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-4 | error | CodeSystem | If 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-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| scs-1 | error | CodeSystem | If a codesystem contains nested concepts, it must specify hierarchyMeaning : concept.concept.exists() implies hierarchyMeaning.exists() | |
| scs-2 | error | CodeSystem | If a codesystem contains example, fragment, or complete content, it must have at least one concept : content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists() |
This structure is derived from CodeSystem
Summary
Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Differential View
This structure is derived from CodeSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CodeSystem |
C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement 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 |
| knowledgeRepresentationLevel |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| versionAlgorithm |
S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| 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 |
| url |
S | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
| version |
S | 1..1 | string | Business version of the code system (Coding.version) |
| name |
S | 0..1 | string | Name for this code system (computer friendly) |
| title |
S | 1..1 | string | Name for this code system (human friendly) |
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
S | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
S | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the code system |
| caseSensitive |
S | 1..1 | boolean | If code comparison is case sensitive |
| hierarchyMeaning |
SC | 0..1 | code | grouped-by | is-a | part-of | classified-with |
| content |
SC | 1..1 | code | not-present | example | fragment | complete | supplement |
| concept |
SC | 0..* | BackboneElement | Concepts in the code system |
| code |
S | 1..1 | code | Code that identifies concept |
| display |
S | 0..1 | string | Text to display to the user |
| definition |
S | 0..1 | string | Formal definition |
| concept |
SC | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| scs-1 | error | CodeSystem | If a codesystem contains nested concepts, it must specify hierarchyMeaning : concept.concept.exists() implies hierarchyMeaning.exists() | |
| scs-2 | error | CodeSystem | If a codesystem contains example, fragment, or complete content, it must have at least one concept : content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 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 |
| knowledgeRepresentationLevel |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| versionAlgorithm |
S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| 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 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
| version |
SΣ | 1..1 | string | Business version of the code system (Coding.version) |
| name |
SΣC | 0..1 | string | Name for this code system (computer friendly) |
| title |
SΣ | 1..1 | string | Name for this code system (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the code system |
| caseSensitive |
SΣ | 1..1 | boolean | If code comparison is case sensitive |
| 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. |
| 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. |
| concept |
SC | 0..* | BackboneElement | Concepts in the code system |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 1..1 | code | Code that identifies concept |
| display |
S | 0..1 | string | Text to display to the user |
| definition |
S | 0..1 | string | Formal definition |
| concept |
SC | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaninghttp://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1from the FHIR Standard | |
| CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| csd-0 | warning | CodeSystem | Name 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-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
| dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CodeSystem | 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 : 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-4 | error | CodeSystem | If 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-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| scs-1 | error | CodeSystem | If a codesystem contains nested concepts, it must specify hierarchyMeaning : concept.concept.exists() implies hierarchyMeaning.exists() | |
| scs-2 | error | CodeSystem | If a codesystem contains example, fragment, or complete content, it must have at least one concept : content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| knowledgeRepresentationLevel |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| versionAlgorithm |
S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | ||||
| 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 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the code system (business identifier) | ||||
| version |
SΣ | 1..1 | string | Business version of the code system (Coding.version) | ||||
| name |
SΣC | 0..1 | string | Name for this code system (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this code system (human friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 1..1 | markdown | Natural language description of the code system | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this code system is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| caseSensitive |
SΣ | 1..1 | boolean | If code comparison is case sensitive | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
| 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. | ||||
| compositional |
Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
| versionNeeded |
Σ | 0..1 | boolean | If definitions are not stable | ||||
| 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. | ||||
| supplements |
Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | ||||
| count |
Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
| filter |
Σ | 0..* | BackboneElement | Filter that can be used in a value set | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | code | Code that identifies the filter | ||||
| description |
Σ | 0..1 | string | How or why the filter is used | ||||
| operator |
Σ | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
| value |
Σ | 1..1 | string | What to use for the value | ||||
| property |
Σ | 0..* | BackboneElement | Additional information supplied about each concept | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
| uri |
Σ | 0..1 | uri | Formal identifier for the property | ||||
| description |
Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
| type |
Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
| concept |
SC | 0..* | BackboneElement | Concepts in the code system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Code that identifies concept | ||||
| display |
S | 0..1 | string | Text to display to the user | ||||
| definition |
S | 0..1 | string | Formal definition | ||||
| designation |
0..* | BackboneElement | Additional representations for the concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| use |
0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value |
1..1 | string | The text value for this designation | |||||
| property |
0..* | BackboneElement | Property value for the concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | code | Reference to CodeSystem.property.code | |||||
| value[x] |
1..1 | Value of the property for this concept | ||||||
| valueCode |
code | |||||||
| valueCoding |
Coding | |||||||
| valueString |
string | |||||||
| valueInteger |
integer | |||||||
| valueBoolean |
boolean | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| concept |
SC | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CodeSystem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaninghttp://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1from the FHIR Standard | ||||
| CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1from the FHIR Standard | ||||
| CodeSystem.filter.operator | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard | ||||
| CodeSystem.property.type | required | PropertyTypehttp://hl7.org/fhir/ValueSet/concept-property-type|4.0.1from the FHIR Standard | ||||
| CodeSystem.concept.designation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CodeSystem.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| csd-0 | warning | CodeSystem | Name 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-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
| dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CodeSystem | 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 : 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-4 | error | CodeSystem | If 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-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| scs-1 | error | CodeSystem | If a codesystem contains nested concepts, it must specify hierarchyMeaning : concept.concept.exists() implies hierarchyMeaning.exists() | |
| scs-2 | error | CodeSystem | If a codesystem contains example, fragment, or complete content, it must have at least one concept : content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists() |
This structure is derived from CodeSystem
Summary
Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.0.0-snapshot based on FHIR 4.0.1. Generated 2024-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change