Canonical Resource Management Infrastructure Implementation Guide
2.0.0 - STU 2
Canonical Resource Management Infrastructure Implementation Guide
2.0.0 - STU 2
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 2.0.0 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/StructureDefinition/publishablecodesystem | Version: 4.0.2 | ||||
| Standards status: Trial-use | Maturity Level: 3 | Responsible: HL7 International / Terminology Infrastructure | Computable Name: PublishableCodeSystem | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.5.1129 | |||||
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
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CodeSystem |
C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1, pub-1 |
  meta |
Σ | 0..1 | Meta | Metadata about the resource |
   Slices for extension |
Content/Rules for all slices | |||
   extension:packageSource |
S | 0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
 extension:knowledgeCapability |
SC | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| extension:approvalDate |
S | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate |
| extension:lastReviewDate |
S | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate |
| extension:effectivePeriod |
S | 0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod |
| extension: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 |
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
 extension:relatedArtifact |
S | 0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
   extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
 value[x] |
1..1 | RelatedArtifact | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
| extension:publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
 type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. |
| extension:artifactComment |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
| extension:authoritativeSource |
S | 0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the code system (business identifier) |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| date |
SΣ | 1..1 | dateTime | Date last changed |
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
| 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 |
| content |
Σ | 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. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CodeSystem.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| CodeSystem.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| pub-1 | error | CodeSystem | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
| Id | Grade | Path(s) | Description | Expression |
| pub-1 | error | CodeSystem | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CodeSystem |
C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1, pub-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:packageSource |
S | 0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | ||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:knowledgeCapability |
SC | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| extension:approvalDate |
S | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | ||||
| extension:lastReviewDate |
S | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | ||||
| extension:effectivePeriod |
S | 0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | ||||
| extension: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 | ||||
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| extension:relatedArtifact |
S | 0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |||||
| value[x] |
1..1 | RelatedArtifact | Value of extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
| extension:publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
Σ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| extension:artifactComment |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |||||
| extension:authoritativeSource |
S | 0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..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 |
Σ | 0..1 | string | Business version of the code system (Coding.version) | ||||
| name |
ΣC | 0..1 | string | Name for this code system (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this code system (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..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 |
Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
| hierarchyMeaning |
Σ | 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 |
Σ | 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 |
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 |
1..1 | code | Code that identifies concept | |||||
| display |
0..1 | string | Text to display to the user | |||||
| definition |
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 |
0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CodeSystem.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| CodeSystem.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| CodeSystem.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CodeSystem.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| CodeSystem.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| CodeSystem.hierarchyMeaning | Base | required | CodeSystemHierarchyMeaning | 📍4.0.1 | FHIR Std. |
| CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std. |
| CodeSystem.filter.operator | Base | required | FilterOperator | 📍4.0.1 | FHIR Std. |
| CodeSystem.property.type | Base | required | PropertyType | 📍4.0.1 | FHIR Std. |
| CodeSystem.concept.designation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CodeSystem.concept.designation.use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| pub-1 | error | CodeSystem | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
Summary
Mandatory: 1 element
Must-Support: 20 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CodeSystem |
C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1, pub-1 |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
Content/Rules for all slices | |||
| extension:packageSource |
S | 0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:knowledgeCapability |
SC | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| extension:approvalDate |
S | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate |
| extension:lastReviewDate |
S | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate |
| extension:effectivePeriod |
S | 0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod |
| extension: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 |
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| extension:relatedArtifact |
S | 0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
| value[x] |
1..1 | RelatedArtifact | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
| extension:publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. |
| extension:artifactComment |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
| extension:authoritativeSource |
S | 0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the code system (business identifier) |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| date |
SΣ | 1..1 | dateTime | Date last changed |
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
| 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 |
| content |
Σ | 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. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CodeSystem.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| CodeSystem.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| pub-1 | error | CodeSystem | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
Differential View
| Id | Grade | Path(s) | Description | Expression |
| pub-1 | error | CodeSystem | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CodeSystem |
C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1, pub-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:packageSource |
S | 0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | ||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:knowledgeCapability |
SC | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| extension:approvalDate |
S | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | ||||
| extension:lastReviewDate |
S | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | ||||
| extension:effectivePeriod |
S | 0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | ||||
| extension: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 | ||||
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| extension:relatedArtifact |
S | 0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |||||
| value[x] |
1..1 | RelatedArtifact | Value of extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:publicationDate |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
| extension:publicationStatus |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
Σ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| extension:artifactComment |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |||||
| extension:authoritativeSource |
S | 0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..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 |
Σ | 0..1 | string | Business version of the code system (Coding.version) | ||||
| name |
ΣC | 0..1 | string | Name for this code system (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this code system (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..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 |
Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
| hierarchyMeaning |
Σ | 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 |
Σ | 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 |
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 |
1..1 | code | Code that identifies concept | |||||
| display |
0..1 | string | Text to display to the user | |||||
| definition |
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 |
0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CodeSystem.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| CodeSystem.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| CodeSystem.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CodeSystem.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| CodeSystem.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| CodeSystem.hierarchyMeaning | Base | required | CodeSystemHierarchyMeaning | 📍4.0.1 | FHIR Std. |
| CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std. |
| CodeSystem.filter.operator | Base | required | FilterOperator | 📍4.0.1 | FHIR Std. |
| CodeSystem.property.type | Base | required | PropertyType | 📍4.0.1 | FHIR Std. |
| CodeSystem.concept.designation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CodeSystem.concept.designation.use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| pub-1 | error | CodeSystem | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
Summary
Mandatory: 1 element
Must-Support: 20 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support.
Package hl7.fhir.uv.crmi#2.0.0 based on FHIR 4.0.1.
Generated
2026-05-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change