Specyfikacja interoperacyjności prototypu SSIDL
0.1.2 - ci-build
Specyfikacja interoperacyjności prototypu SSIDL, published by Uniwersytet Medyczny w Łodzi. This guide is not an authorized publication; it is the continuous build for version 0.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/SSIDL/ssidl-ig/ and changes regularly. See the Directory of published versions
Official URL: http://loinc-ssidl.umed.pl/fhir/ig/ssidl/StructureDefinition/ssidl-codeSystem | Version: 0.1.2 | |||
Draft as of 2025-10-09 | Computable Name: SsidlCodeSystem |
Słownik (system kodowania) zdefinowany w SSIDL
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 | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4 | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) Constraints: cnl-1 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the code system (Coding.version) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this code system (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this code system (human friendly) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | Symbol in syntax defined by the system Required Pattern: PL | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Representation defined by the system Required Pattern: Poland | ||||
![]() ![]() ![]() |
SΣ | 1..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
![]() ![]() ![]() |
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. Required Pattern: complete | ||||
![]() ![]() ![]() |
SΣ | 1..1 | unsignedInt | Total concepts in the code system | ||||
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Concepts in the code system | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code that identifies concept | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Text to display to the user | ||||
![]() ![]() ![]() ![]() |
SC | 0..* | BackboneElement | Additional representations for the concept Constraints: csd-5 | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
CodeSystem.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
CodeSystem.content | Base | required | Code System Content Mode | 📍5.0.0 | FHIR Std. |
CodeSystem.filter.operator | Base | required | Filter Operator | 📍5.0.0 | FHIR Std. |
CodeSystem.property.type | Base | required | Property Type | 📍5.0.0 | FHIR Std. |
CodeSystem.concept.designation.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
cnl-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
cnl-1 | warning | CodeSystem.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique |
concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
|
csd-2 | warning | CodeSystem | If there is an explicit hierarchy, a hierarchyMeaning should be provided |
concept.concept.exists() implies hierarchyMeaning.exists()
|
csd-3 | warning | CodeSystem | If there is an implicit hierarchy, a hierarchyMeaning should be provided |
concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
|
csd-4 | error | CodeSystem | If the code system content = supplement, it must nominate what it's a supplement for |
CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
|
csd-5 | error | CodeSystem.concept.designation | Must have a value for concept.designation.use if concept.designation.additionalUse is present |
additionalUse.exists() implies use.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 CodeSystem
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement | |
![]() ![]() ![]() |
S | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
![]() ![]() ![]() |
S | 1..1 | Identifier | Additional identifier for the code system (business identifier) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | string | Business version of the code system (Coding.version) |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | string | Name for this code system (computer friendly) |
![]() ![]() ![]() |
S | 1..1 | string | Name for this code system (human friendly) |
![]() ![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown Required Pattern: active |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | Intended jurisdiction for code system (if applicable) | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: PL |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system Required Pattern: Poland |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | not-present | example | fragment | complete | supplement Required Pattern: complete |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Total concepts in the code system |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Concepts in the code system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Code that identifies concept |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Text to display to the user |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional representations for the concept |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Human language of the designation |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4 | ||||
![]() ![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for 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 | ||||
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) Constraints: cnl-1 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the code system (Coding.version) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this code system (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this code system (human friendly) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | Symbol in syntax defined by the system Required Pattern: PL | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Representation defined by the system Required Pattern: Poland | ||||
![]() ![]() ![]() |
SΣ | 1..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
![]() ![]() ![]() |
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. Required Pattern: complete | ||||
![]() ![]() ![]() |
SΣ | 1..1 | unsignedInt | Total concepts in the code system | ||||
![]() ![]() ![]() |
SC | 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 | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code that identifies concept | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Text to display to the user | ||||
![]() ![]() ![]() ![]() |
SC | 0..* | BackboneElement | Additional representations for the concept Constraints: csd-5 | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
CodeSystem.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
CodeSystem.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
CodeSystem.content | Base | required | Code System Content Mode | 📍5.0.0 | FHIR Std. |
CodeSystem.filter.operator | Base | required | Filter Operator | 📍5.0.0 | FHIR Std. |
CodeSystem.property.type | Base | required | Property Type | 📍5.0.0 | FHIR Std. |
CodeSystem.concept.designation.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
cnl-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
cnl-1 | warning | CodeSystem.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique |
concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
|
csd-2 | warning | CodeSystem | If there is an explicit hierarchy, a hierarchyMeaning should be provided |
concept.concept.exists() implies hierarchyMeaning.exists()
|
csd-3 | warning | CodeSystem | If there is an implicit hierarchy, a hierarchyMeaning should be provided |
concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
|
csd-4 | error | CodeSystem | If the code system content = supplement, it must nominate what it's a supplement for |
CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
|
csd-5 | error | CodeSystem.concept.designation | Must have a value for concept.designation.use if concept.designation.additionalUse is present |
additionalUse.exists() implies use.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 CodeSystem
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4 | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) Constraints: cnl-1 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the code system (Coding.version) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this code system (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this code system (human friendly) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | Symbol in syntax defined by the system Required Pattern: PL | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Representation defined by the system Required Pattern: Poland | ||||
![]() ![]() ![]() |
SΣ | 1..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
![]() ![]() ![]() |
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. Required Pattern: complete | ||||
![]() ![]() ![]() |
SΣ | 1..1 | unsignedInt | Total concepts in the code system | ||||
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Concepts in the code system | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code that identifies concept | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Text to display to the user | ||||
![]() ![]() ![]() ![]() |
SC | 0..* | BackboneElement | Additional representations for the concept Constraints: csd-5 | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
CodeSystem.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
CodeSystem.content | Base | required | Code System Content Mode | 📍5.0.0 | FHIR Std. |
CodeSystem.filter.operator | Base | required | Filter Operator | 📍5.0.0 | FHIR Std. |
CodeSystem.property.type | Base | required | Property Type | 📍5.0.0 | FHIR Std. |
CodeSystem.concept.designation.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
cnl-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
cnl-1 | warning | CodeSystem.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique |
concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
|
csd-2 | warning | CodeSystem | If there is an explicit hierarchy, a hierarchyMeaning should be provided |
concept.concept.exists() implies hierarchyMeaning.exists()
|
csd-3 | warning | CodeSystem | If there is an implicit hierarchy, a hierarchyMeaning should be provided |
concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
|
csd-4 | error | CodeSystem | If the code system content = supplement, it must nominate what it's a supplement for |
CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
|
csd-5 | error | CodeSystem.concept.designation | Must have a value for concept.designation.use if concept.designation.additionalUse is present |
additionalUse.exists() implies use.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 CodeSystem
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement | |
![]() ![]() ![]() |
S | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
![]() ![]() ![]() |
S | 1..1 | Identifier | Additional identifier for the code system (business identifier) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | string | Business version of the code system (Coding.version) |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | string | Name for this code system (computer friendly) |
![]() ![]() ![]() |
S | 1..1 | string | Name for this code system (human friendly) |
![]() ![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown Required Pattern: active |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | Intended jurisdiction for code system (if applicable) | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: PL |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system Required Pattern: Poland |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | not-present | example | fragment | complete | supplement Required Pattern: complete |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Total concepts in the code system |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Concepts in the code system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Code that identifies concept |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Text to display to the user |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional representations for the concept |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Human language of the designation |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4 | ||||
![]() ![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for 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 | ||||
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) Constraints: cnl-1 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the code system (Coding.version) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this code system (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this code system (human friendly) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | Symbol in syntax defined by the system Required Pattern: PL | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Representation defined by the system Required Pattern: Poland | ||||
![]() ![]() ![]() |
SΣ | 1..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
![]() ![]() ![]() |
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. Required Pattern: complete | ||||
![]() ![]() ![]() |
SΣ | 1..1 | unsignedInt | Total concepts in the code system | ||||
![]() ![]() ![]() |
SC | 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 | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code that identifies concept | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Text to display to the user | ||||
![]() ![]() ![]() ![]() |
SC | 0..* | BackboneElement | Additional representations for the concept Constraints: csd-5 | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
CodeSystem.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
CodeSystem.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
CodeSystem.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
CodeSystem.content | Base | required | Code System Content Mode | 📍5.0.0 | FHIR Std. |
CodeSystem.filter.operator | Base | required | Filter Operator | 📍5.0.0 | FHIR Std. |
CodeSystem.property.type | Base | required | Property Type | 📍5.0.0 | FHIR Std. |
CodeSystem.concept.designation.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
cnl-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
cnl-1 | warning | CodeSystem.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique |
concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
|
csd-2 | warning | CodeSystem | If there is an explicit hierarchy, a hierarchyMeaning should be provided |
concept.concept.exists() implies hierarchyMeaning.exists()
|
csd-3 | warning | CodeSystem | If there is an implicit hierarchy, a hierarchyMeaning should be provided |
concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
|
csd-4 | error | CodeSystem | If the code system content = supplement, it must nominate what it's a supplement for |
CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
|
csd-5 | error | CodeSystem.concept.designation | Must have a value for concept.designation.use if concept.designation.additionalUse is present |
additionalUse.exists() implies use.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 CodeSystem
Other representations of profile: CSV, Excel, Schematron