This page is part of the Structured Data Capture FHIR IG (v4.0.0-ballot: STU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem | Version: 4.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCCodeSystem | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.6 |
Defines how CodeSystem is used to reflect code lists found in data element defintions and form definitions to be used within the ONC's Structured Data Capture standard.
Code systems are referenced by ValueSets to define possible answer choices in a re-useable cross-questionnaire (and other data structure) manner. Codes might be drawn from standard international terminologies like LOINC or SNOMED CT or from regional code systems for drugs, billing codes, etc. The use of standardized codes is useful when data needs to be populated into the questionnaire or extracted from the questionnaire for other uses. It is also helpful when the set of possibilities is highly dynamic - for example drug codes where the set of available codes might change daily or weekly.
This profile sets expectations for use of the CodeSystem resource when used as a source for answers to questions in a Questionnaire. It identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the Questionnaire use-case.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CodeSystem
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement | |
Slices for modifierExtension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
modifierExtension:rendering-criticalExtension | S | 0..* | RenderingCriticalExtension | Extension that must be supported |
url | S | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
name | 0..1 | string | Name for this code system (computer friendly) | |
status | S | 1..1 | code | draft | active | retired | unknown |
experimental | S | 0..1 | boolean | For testing purposes, not real usage |
date | S | 0..1 | dateTime | Date last changed |
description | S | 0..1 | markdown | Natural language description of the code system |
caseSensitive | S | 1..1 | boolean | If code comparison is case sensitive |
compositional | 0..0 | |||
versionNeeded | 0..0 | |||
content | S | 1..1 | code | not-present | example | fragment | complete | supplement |
property | S | 0..* | BackboneElement | Additional information supplied about each concept |
code | S | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | S | 0..1 | uri | Formal identifier for the property |
type | S | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal |
concept | S | 0..* | BackboneElement | Concepts in the code system |
code | S | 1..1 | code | Code that identifies concept |
display | S | 0..1 | string | Text to display to the user |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
definition | S | 0..1 | string | Formal definition |
designation | ||||
value | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
property | S | 0..* | BackboneElement | Property value for the concept |
code | S | 1..1 | code | Reference to CodeSystem.property.code |
value[x] | S | 1..1 | code, Coding, string, integer, boolean, dateTime, decimal | Value of the property for this concept |
concept | S | 0..* | Child Concepts (is-a/contains/categorizes) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | SΣ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) ele-1: All FHIR elements must have a @value or children |
name | ΣC | 0..1 | string | Name for this code system (computer friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | SΣ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | SΣ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
description | S | 0..1 | markdown | Natural language description of the code system ele-1: All FHIR elements must have a @value or children |
caseSensitive | SΣ | 1..1 | boolean | If code comparison is case sensitive ele-1: All FHIR elements must have a @value or children |
content | SΣ | 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. ele-1: All FHIR elements must have a @value or children |
property | SΣ | 0..* | BackboneElement | Additional information supplied about each concept ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | SΣ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations ele-1: All FHIR elements must have a @value or children |
uri | SΣ | 0..1 | uri | Formal identifier for the property ele-1: All FHIR elements must have a @value or children |
type | SΣ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. ele-1: All FHIR elements must have a @value or children |
concept | S | 0..* | BackboneElement | Concepts in the code system ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | S | 1..1 | code | Code that identifies concept ele-1: All FHIR elements must have a @value or children |
display | S | 0..1 | string | Text to display to the user ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
definition | S | 0..1 | string | Formal definition ele-1: All FHIR elements must have a @value or children |
property | S | 0..* | BackboneElement | Property value for the concept ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | S | 1..1 | code | Reference to CodeSystem.property.code ele-1: All FHIR elements must have a @value or children |
value[x] | S | 1..1 | Value of the property for this concept ele-1: All FHIR elements must have a @value or children | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
concept | S | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1 from the FHIR Standard | |
CodeSystem.property.type | required | PropertyTypehttp://hl7.org/fhir/ValueSet/concept-property-type|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported | ||||
url | SΣ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the code system (business identifier) | ||||
version | Σ | 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 | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | S | 0..1 | markdown | Natural language description of the code system | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this code system is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
caseSensitive | SΣ | 1..1 | boolean | If code comparison is case sensitive | ||||
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
content | SΣ | 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 | SΣ | 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 | SΣ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
uri | SΣ | 0..1 | uri | Formal identifier for the property | ||||
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
type | SΣ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
concept | S | 0..* | BackboneElement | Concepts in the code system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | S | 1..1 | code | Code that identifies concept | ||||
display | S | 0..1 | string | Text to display to the user | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
definition | S | 0..1 | string | Formal definition | ||||
designation | 0..* | BackboneElement | Additional representations for the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
use | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
value | 1..1 | string | The text value for this designation | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
property | S | 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 | S | 1..1 | code | Reference to CodeSystem.property.code | ||||
value[x] | S | 1..1 | Value of the property for this concept | |||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
concept | S | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CodeSystem.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
CodeSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaninghttp://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1 from the FHIR Standard | ||||
CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1 from the FHIR Standard | ||||
CodeSystem.filter.operator | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1 from the FHIR Standard | ||||
CodeSystem.property.type | required | PropertyTypehttp://hl7.org/fhir/ValueSet/concept-property-type|4.0.1 from the FHIR Standard | ||||
CodeSystem.concept.designation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CodeSystem.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard |
This structure is derived from CodeSystem
Summary
Mandatory: 1 element
Must-Support: 20 elements
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Differential View
This structure is derived from CodeSystem
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement | |
Slices for modifierExtension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
modifierExtension:rendering-criticalExtension | S | 0..* | RenderingCriticalExtension | Extension that must be supported |
url | S | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
name | 0..1 | string | Name for this code system (computer friendly) | |
status | S | 1..1 | code | draft | active | retired | unknown |
experimental | S | 0..1 | boolean | For testing purposes, not real usage |
date | S | 0..1 | dateTime | Date last changed |
description | S | 0..1 | markdown | Natural language description of the code system |
caseSensitive | S | 1..1 | boolean | If code comparison is case sensitive |
compositional | 0..0 | |||
versionNeeded | 0..0 | |||
content | S | 1..1 | code | not-present | example | fragment | complete | supplement |
property | S | 0..* | BackboneElement | Additional information supplied about each concept |
code | S | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | S | 0..1 | uri | Formal identifier for the property |
type | S | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal |
concept | S | 0..* | BackboneElement | Concepts in the code system |
code | S | 1..1 | code | Code that identifies concept |
display | S | 0..1 | string | Text to display to the user |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
definition | S | 0..1 | string | Formal definition |
designation | ||||
value | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
property | S | 0..* | BackboneElement | Property value for the concept |
code | S | 1..1 | code | Reference to CodeSystem.property.code |
value[x] | S | 1..1 | code, Coding, string, integer, boolean, dateTime, decimal | Value of the property for this concept |
concept | S | 0..* | Child Concepts (is-a/contains/categorizes) | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | SΣ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) ele-1: All FHIR elements must have a @value or children |
name | ΣC | 0..1 | string | Name for this code system (computer friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | SΣ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | SΣ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
description | S | 0..1 | markdown | Natural language description of the code system ele-1: All FHIR elements must have a @value or children |
caseSensitive | SΣ | 1..1 | boolean | If code comparison is case sensitive ele-1: All FHIR elements must have a @value or children |
content | SΣ | 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. ele-1: All FHIR elements must have a @value or children |
property | SΣ | 0..* | BackboneElement | Additional information supplied about each concept ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | SΣ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations ele-1: All FHIR elements must have a @value or children |
uri | SΣ | 0..1 | uri | Formal identifier for the property ele-1: All FHIR elements must have a @value or children |
type | SΣ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. ele-1: All FHIR elements must have a @value or children |
concept | S | 0..* | BackboneElement | Concepts in the code system ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | S | 1..1 | code | Code that identifies concept ele-1: All FHIR elements must have a @value or children |
display | S | 0..1 | string | Text to display to the user ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
definition | S | 0..1 | string | Formal definition ele-1: All FHIR elements must have a @value or children |
property | S | 0..* | BackboneElement | Property value for the concept ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | S | 1..1 | code | Reference to CodeSystem.property.code ele-1: All FHIR elements must have a @value or children |
value[x] | S | 1..1 | Value of the property for this concept ele-1: All FHIR elements must have a @value or children | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
concept | S | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1 from the FHIR Standard | |
CodeSystem.property.type | required | PropertyTypehttp://hl7.org/fhir/ValueSet/concept-property-type|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported | ||||
url | SΣ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the code system (business identifier) | ||||
version | Σ | 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 | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | S | 0..1 | markdown | Natural language description of the code system | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this code system is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
caseSensitive | SΣ | 1..1 | boolean | If code comparison is case sensitive | ||||
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
content | SΣ | 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 | SΣ | 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 | SΣ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
uri | SΣ | 0..1 | uri | Formal identifier for the property | ||||
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
type | SΣ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
concept | S | 0..* | BackboneElement | Concepts in the code system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | S | 1..1 | code | Code that identifies concept | ||||
display | S | 0..1 | string | Text to display to the user | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
definition | S | 0..1 | string | Formal definition | ||||
designation | 0..* | BackboneElement | Additional representations for the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
use | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
value | 1..1 | string | The text value for this designation | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
conceptDisplayLabel-renderingStyle | 0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
conceptDisplayLabel-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
property | S | 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 | S | 1..1 | code | Reference to CodeSystem.property.code | ||||
value[x] | S | 1..1 | Value of the property for this concept | |||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
concept | S | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CodeSystem.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
CodeSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaninghttp://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1 from the FHIR Standard | ||||
CodeSystem.content | required | CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1 from the FHIR Standard | ||||
CodeSystem.filter.operator | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1 from the FHIR Standard | ||||
CodeSystem.property.type | required | PropertyTypehttp://hl7.org/fhir/ValueSet/concept-property-type|4.0.1 from the FHIR Standard | ||||
CodeSystem.concept.designation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CodeSystem.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard |
This structure is derived from CodeSystem
Summary
Mandatory: 1 element
Must-Support: 20 elements
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron