Sharing Valuesets, Codes, and Maps (SVCM)
1.5.2-current - ci-build
Sharing Valuesets, Codes, and Maps (SVCM), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.5.2-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.SVCM/ and changes regularly. See the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.CodeSystem | Version: 1.5.2-current | |||
Active as of 2025-10-07 | Computable Name: SVCMCodeSystem |
A profile on the CodeSystem resource for SVCM.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | uri | For existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL. |
![]() ![]() ![]() |
Σ | 0..* | Identifier | The identifier shall contain any business identifiers this code system is identified by. |
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the code system (Coding.version) |
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this code system (computer friendly) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() |
1..1 | markdown | Natural language description of the code system | |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() |
1..* | BackboneElement | Concepts in the code system | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | code | Code that identifies concept | |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.status | Base | required | PublicationStatus | 📍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()
|
This structure is derived from Shareable CodeSystem
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | Shareable CodeSystem | Declares the existence of and describes a code system or code system supplement | |
![]() ![]() ![]() |
1..1 | uri | For existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL. | |
![]() ![]() ![]() |
0..* | Identifier | The identifier shall contain any business identifiers this code system is identified by. | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | For existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL. | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | The identifier shall contain any business identifiers this code system is identified by. | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the code system (Coding.version) | ||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this code system (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this code system (human friendly) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
1..1 | markdown | Natural language description of the code system | |||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this code system is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If definitions are not stable | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Filter that can be used in a value set | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Code that identifies the filter | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | How or why the filter is used | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | What to use for the value | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Additional information supplied about each concept | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Formal identifier for the property | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Concepts in the code system | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | Code that identifies concept | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text to display to the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Formal definition | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Additional representations for the concept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Property value for the concept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Reference to CodeSystem.property.code | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Value of the property for this concept | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() |
0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.language | Base | preferred | Common Languages | 📍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()
|
This structure is derived from Shareable CodeSystem
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | uri | For existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL. |
![]() ![]() ![]() |
Σ | 0..* | Identifier | The identifier shall contain any business identifiers this code system is identified by. |
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the code system (Coding.version) |
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this code system (computer friendly) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() |
1..1 | markdown | Natural language description of the code system | |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() |
1..* | BackboneElement | Concepts in the code system | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | code | Code that identifies concept | |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.status | Base | required | PublicationStatus | 📍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()
|
Differential View
This structure is derived from Shareable CodeSystem
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | Shareable CodeSystem | Declares the existence of and describes a code system or code system supplement | |
![]() ![]() ![]() |
1..1 | uri | For existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL. | |
![]() ![]() ![]() |
0..* | Identifier | The identifier shall contain any business identifiers this code system is identified by. | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | For existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL. | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | The identifier shall contain any business identifiers this code system is identified by. | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the code system (Coding.version) | ||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this code system (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this code system (human friendly) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
1..1 | markdown | Natural language description of the code system | |||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this code system is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If definitions are not stable | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Filter that can be used in a value set | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Code that identifies the filter | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | How or why the filter is used | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | What to use for the value | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Additional information supplied about each concept | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Formal identifier for the property | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Concepts in the code system | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | Code that identifies concept | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text to display to the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Formal definition | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Additional representations for the concept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Property value for the concept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Reference to CodeSystem.property.code | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Value of the property for this concept | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() |
0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.language | Base | preferred | Common Languages | 📍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()
|
This structure is derived from Shareable CodeSystem
Other representations of profile: CSV, Excel, Schematron