Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
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/StructureDefinition/crmi-publishablecodesystem | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIPublishableCodeSystem | ||
Defines and enforces the minimum expectations for publication and distribution of a code system, typically as part of an artifact repository or implementation guide publication
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CRMIShareableCodeSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CodeSystem | C | 1..1 | CRMIShareableCodeSystem | Declares the existence of and describes a code system or code system supplement |
  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): The algorithm used to compare versions for the artifact |
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact |
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference | |
| otherName | 0..* | (Complex) | Alternative names URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName | |
 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 | SΣ | 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 | SΣ | 1..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 1..1 | markdown | Natural language description of the code system |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 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 | S | 0..1 | markdown | Why this code system is defined |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| 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 |
| CodeSystem.status | required | PublicationStatus |
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet |
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning |
| CodeSystem.content | required | CodeSystemContentMode |
| 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 | CRMIShareableCodeSystem | Declares the existence of and describes a code system or code system supplement | ||||
| 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): The algorithm used to compare versions for the artifact | ||||
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact | ||||
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference | |||||
| otherName | 0..* | (Complex) | Alternative names URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName | |||||
| 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 | SΣ | 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 | SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..1 | markdown | Natural language description of the code system | ||||
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | SΣ | 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 | S | 0..1 | markdown | Why this code system is defined | ||||
| copyright | S | 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 | ||||
| CodeSystem.language | preferred | CommonLanguages
| ||||
| CodeSystem.status | required | PublicationStatus | ||||
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning | ||||
| CodeSystem.content | required | CodeSystemContentMode | ||||
| CodeSystem.filter.operator | required | FilterOperator | ||||
| CodeSystem.property.type | required | PropertyType | ||||
| CodeSystem.concept.designation.language | preferred | CommonLanguages
| ||||
| CodeSystem.concept.designation.use | extensible | DesignationUse |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from CRMIShareableCodeSystem
Summary
Mandatory: 1 element
Must-Support: 17 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from CRMIShareableCodeSystem
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CodeSystem | C | 1..1 | CRMIShareableCodeSystem | Declares the existence of and describes a code system or code system supplement |
| 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): The algorithm used to compare versions for the artifact |
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact |
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference | |
| otherName | 0..* | (Complex) | Alternative names URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName | |
| 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 | SΣ | 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 | SΣ | 1..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 1..1 | markdown | Natural language description of the code system |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 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 | S | 0..1 | markdown | Why this code system is defined |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| 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 |
| CodeSystem.status | required | PublicationStatus |
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet |
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning |
| CodeSystem.content | required | CodeSystemContentMode |
| 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 | CRMIShareableCodeSystem | Declares the existence of and describes a code system or code system supplement | ||||
| 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): The algorithm used to compare versions for the artifact | ||||
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact | ||||
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference | |||||
| otherName | 0..* | (Complex) | Alternative names URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName | |||||
| 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 | SΣ | 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 | SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..1 | markdown | Natural language description of the code system | ||||
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | SΣ | 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 | S | 0..1 | markdown | Why this code system is defined | ||||
| copyright | S | 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 | ||||
| CodeSystem.language | preferred | CommonLanguages
| ||||
| CodeSystem.status | required | PublicationStatus | ||||
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning | ||||
| CodeSystem.content | required | CodeSystemContentMode | ||||
| CodeSystem.filter.operator | required | FilterOperator | ||||
| CodeSystem.property.type | required | PropertyType | ||||
| CodeSystem.concept.designation.language | preferred | CommonLanguages
| ||||
| CodeSystem.concept.designation.use | extensible | DesignationUse |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from CRMIShareableCodeSystem
Summary
Mandatory: 1 element
Must-Support: 17 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Clinical Decision Support WG. Package hl7.fhir.uv.crmi#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change