This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Vocabulary Work Group | Maturity Level: 2 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/shareablecodesystem
Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets
This profile was published on [no date] as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from CodeSystem.
This structure is derived from CodeSystem.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement | |
url | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | |
version | 1..1 | string | Business version of the code system (Coding.version) | |
name | 1..1 | string | Name for this code system (computer friendly) | |
status | 1..1 | code | draft | active | retired | unknown | |
experimental | 1..1 | boolean | For testing purposes, not real usage | |
publisher | 1..1 | string | Name of the publisher (organization or individual) | |
description | 1..1 | markdown | Natural language description of the code system | |
caseSensitive | 0..1 | boolean | If code comparison is case sensitive | |
concept | 1..* | BackboneElement | Concepts in the code system | |
code | 1..1 | code | Code that identifies concept | |
display | 0..1 | string | Text to display to the user | |
definition | 0..1 | string | Formal definition | |
concept | 0..* | Unknown reference to #CodeSystem.concept Child Concepts (is-a/contains/categorizes) | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | I | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
identifier | ΣI | 0..* | Identifier | Additional identifier for the code system (business identifier) |
version | ΣI | 1..1 | string | Business version of the code system (Coding.version) |
name | ΣI | 1..1 | string | Name for this code system (computer friendly) |
title | ΣI | 0..1 | string | Name for this code system (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | I | 1..1 | markdown | Natural language description of the code system |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction (extensible) |
purpose | I | 0..1 | markdown | Why this code system is defined |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
caseSensitive | ΣI | 0..1 | boolean | If code comparison is case sensitive |
valueSet | ΣI | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system |
hierarchyMeaning | ΣI | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required) |
compositional | ΣI | 0..1 | boolean | If code system defines a compositional grammar |
versionNeeded | ΣI | 0..1 | boolean | If definitions are not stable |
content | ΣI | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required) |
supplements | ΣI | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to |
count | ΣI | 0..1 | unsignedInt | Total concepts in the code system |
filter | ΣI | 0..* | BackboneElement | Filter that can be used in a value set |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | code | Code that identifies the filter |
description | ΣI | 0..1 | string | How or why the filter is used |
operator | ΣI | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | ΣI | 1..1 | string | What to use for the value |
property | ΣI | 0..* | BackboneElement | Additional information supplied about each concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | ΣI | 0..1 | uri | Formal identifier for the property |
description | ΣI | 0..1 | string | Why the property is defined, and/or what it conveys |
type | ΣI | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required) |
concept | I | 1..* | BackboneElement | Concepts in the code system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Code that identifies concept |
display | I | 0..1 | string | Text to display to the user |
definition | I | 0..1 | string | Formal definition |
designation | I | 0..* | BackboneElement | Additional representations for the concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | I | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) Max Binding: All Languages |
use | I | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) |
value | I | 1..1 | string | The text value for this designation |
property | I | 0..* | BackboneElement | Property value for the concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Reference to CodeSystem.property.code |
value[x] | I | 1..1 | Value of the property for this concept | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
concept | I | 0..* | Unknown reference to #CodeSystem.concept Child Concepts (is-a/contains/categorizes) | |
Documentation for this format |
<!-- Shareable CodeSystem --> <CodeSystem xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 1..1 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) --></identifier> <version value="[string]"/><!-- 1..1 Business version of the code system (Coding.version) --> <name value="[string]"/><!-- 1..1 Name for this code system (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this code system (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 1..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 1..1 Natural language description of the code system --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for code system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this code system is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <caseSensitive value="[boolean]"/><!-- 0..1 If code comparison is case sensitive --> <valueSet value="[canonical]"/><!-- 0..1 Canonical reference to the value set with entire code system --> <hierarchyMeaning value="[code]"/><!-- 0..1 grouped-by | is-a | part-of | classified-with --> <compositional value="[boolean]"/><!-- 0..1 If code system defines a compositional grammar --> <versionNeeded value="[boolean]"/><!-- 0..1 If definitions are not stable --> <content value="[code]"/><!-- 1..1 not-present | example | fragment | complete | supplement --> <supplements value="[canonical]"/><!-- 0..1 Canonical URL of Code System this adds designations and properties to --> <count value="[unsignedInt]"/><!-- 0..1 Total concepts in the code system --> <filter> 0..* BackboneElement <!-- 0..* Filter that can be used in a value set --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Code that identifies the filter --> <description value="[string]"/><!-- 0..1 How or why the filter is used --> <operator value="[code]"/><!-- 1..* = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists --> <value value="[string]"/><!-- 1..1 What to use for the value --> </filter> <property> 0..* BackboneElement <!-- 0..* Additional information supplied about each concept --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Identifies the property on the concepts, and when referred to in operations --> <uri value="[uri]"/><!-- 0..1 Formal identifier for the property --> <description value="[string]"/><!-- 0..1 Why the property is defined, and/or what it conveys --> <type value="[code]"/><!-- 1..1 code | Coding | string | integer | boolean | dateTime | decimal --> </property> <concept> 1..* BackboneElement <!-- 1..* Concepts in the code system --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Code that identifies concept --> <display value="[string]"/><!-- 0..1 Text to display to the user --> <definition value="[string]"/><!-- 0..1 Formal definition --> <designation> 0..* BackboneElement <!-- 0..* Additional representations for the concept --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!-- 0..1 Human language of the designation --> <use><!-- 0..1 Coding Details how this designation would be used --></use> <value value="[string]"/><!-- 1..1 The text value for this designation --> </designation> <property> 0..* BackboneElement <!-- 0..* Property value for the concept --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Reference to CodeSystem.property.code --> <value[x]><!-- 1..1 code|Coding|string|integer| boolean|dateTime|decimal Value of the property for this concept --></value[x]> </property> <concept><!-- See #CodeSystem.concept Child Concepts (is-a/contains/categorizes) --></concept> </concept> </CodeSystem>
{ // Shareable CodeSystem // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "url" : "<uri>", // C? R! Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) "identifier" : [{ Identifier }], // C?Additional identifier for the code system (business identifier) "version" : "<string>", // C? R! Business version of the code system (Coding.version) "name" : "<string>", // C? R! Name for this code system (computer friendly) "title" : "<string>", // C?Name for this code system (human friendly) "status" : "<code>", // C? R! draft | active | retired | unknown "experimental" : <boolean>, // C? R! For testing purposes, not real usage "date" : "<dateTime>", // C?Date last changed "publisher" : "<string>", // C? R! Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C? R! Natural language description of the code system "useContext" : [{ UsageContext }], // C?The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for code system (if applicable) "purpose" : "<markdown>", // C?Why this code system is defined "copyright" : "<markdown>", // C?Use and/or publishing restrictions "caseSensitive" : <boolean>, // C?If code comparison is case sensitive "valueSet" : "<canonical>", // C?Canonical reference to the value set with entire code system "hierarchyMeaning" : "<code>", // C?grouped-by | is-a | part-of | classified-with "compositional" : <boolean>, // C?If code system defines a compositional grammar "versionNeeded" : <boolean>, // C?If definitions are not stable "content" : "<code>", // C? R! not-present | example | fragment | complete | supplement "supplements" : "<canonical>", // C?Canonical URL of Code System this adds designations and properties to "count" : "<unsignedInt>", // C?Total concepts in the code system "filter" : [{ BackboneElement }], // C?Filter that can be used in a value set "property" : [{ BackboneElement }], // C?Additional information supplied about each concept "concept" : [{ BackboneElement }] // C? R! Concepts in the code system }
This structure is derived from CodeSystem.
Differential View
This structure is derived from CodeSystem.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement | |
url | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | |
version | 1..1 | string | Business version of the code system (Coding.version) | |
name | 1..1 | string | Name for this code system (computer friendly) | |
status | 1..1 | code | draft | active | retired | unknown | |
experimental | 1..1 | boolean | For testing purposes, not real usage | |
publisher | 1..1 | string | Name of the publisher (organization or individual) | |
description | 1..1 | markdown | Natural language description of the code system | |
caseSensitive | 0..1 | boolean | If code comparison is case sensitive | |
concept | 1..* | BackboneElement | Concepts in the code system | |
code | 1..1 | code | Code that identifies concept | |
display | 0..1 | string | Text to display to the user | |
definition | 0..1 | string | Formal definition | |
concept | 0..* | Unknown reference to #CodeSystem.concept Child Concepts (is-a/contains/categorizes) | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | I | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
identifier | ΣI | 0..* | Identifier | Additional identifier for the code system (business identifier) |
version | ΣI | 1..1 | string | Business version of the code system (Coding.version) |
name | ΣI | 1..1 | string | Name for this code system (computer friendly) |
title | ΣI | 0..1 | string | Name for this code system (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | I | 1..1 | markdown | Natural language description of the code system |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction (extensible) |
purpose | I | 0..1 | markdown | Why this code system is defined |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
caseSensitive | ΣI | 0..1 | boolean | If code comparison is case sensitive |
valueSet | ΣI | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system |
hierarchyMeaning | ΣI | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required) |
compositional | ΣI | 0..1 | boolean | If code system defines a compositional grammar |
versionNeeded | ΣI | 0..1 | boolean | If definitions are not stable |
content | ΣI | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required) |
supplements | ΣI | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to |
count | ΣI | 0..1 | unsignedInt | Total concepts in the code system |
filter | ΣI | 0..* | BackboneElement | Filter that can be used in a value set |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | code | Code that identifies the filter |
description | ΣI | 0..1 | string | How or why the filter is used |
operator | ΣI | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | ΣI | 1..1 | string | What to use for the value |
property | ΣI | 0..* | BackboneElement | Additional information supplied about each concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | ΣI | 0..1 | uri | Formal identifier for the property |
description | ΣI | 0..1 | string | Why the property is defined, and/or what it conveys |
type | ΣI | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required) |
concept | I | 1..* | BackboneElement | Concepts in the code system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Code that identifies concept |
display | I | 0..1 | string | Text to display to the user |
definition | I | 0..1 | string | Formal definition |
designation | I | 0..* | BackboneElement | Additional representations for the concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | I | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) Max Binding: All Languages |
use | I | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) |
value | I | 1..1 | string | The text value for this designation |
property | I | 0..* | BackboneElement | Property value for the concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Reference to CodeSystem.property.code |
value[x] | I | 1..1 | Value of the property for this concept | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
concept | I | 0..* | Unknown reference to #CodeSystem.concept Child Concepts (is-a/contains/categorizes) | |
Documentation for this format |
XML Template
<!-- Shareable CodeSystem --> <CodeSystem xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 1..1 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) --></identifier> <version value="[string]"/><!-- 1..1 Business version of the code system (Coding.version) --> <name value="[string]"/><!-- 1..1 Name for this code system (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this code system (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 1..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 1..1 Natural language description of the code system --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for code system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this code system is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <caseSensitive value="[boolean]"/><!-- 0..1 If code comparison is case sensitive --> <valueSet value="[canonical]"/><!-- 0..1 Canonical reference to the value set with entire code system --> <hierarchyMeaning value="[code]"/><!-- 0..1 grouped-by | is-a | part-of | classified-with --> <compositional value="[boolean]"/><!-- 0..1 If code system defines a compositional grammar --> <versionNeeded value="[boolean]"/><!-- 0..1 If definitions are not stable --> <content value="[code]"/><!-- 1..1 not-present | example | fragment | complete | supplement --> <supplements value="[canonical]"/><!-- 0..1 Canonical URL of Code System this adds designations and properties to --> <count value="[unsignedInt]"/><!-- 0..1 Total concepts in the code system --> <filter> 0..* BackboneElement <!-- 0..* Filter that can be used in a value set --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Code that identifies the filter --> <description value="[string]"/><!-- 0..1 How or why the filter is used --> <operator value="[code]"/><!-- 1..* = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists --> <value value="[string]"/><!-- 1..1 What to use for the value --> </filter> <property> 0..* BackboneElement <!-- 0..* Additional information supplied about each concept --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Identifies the property on the concepts, and when referred to in operations --> <uri value="[uri]"/><!-- 0..1 Formal identifier for the property --> <description value="[string]"/><!-- 0..1 Why the property is defined, and/or what it conveys --> <type value="[code]"/><!-- 1..1 code | Coding | string | integer | boolean | dateTime | decimal --> </property> <concept> 1..* BackboneElement <!-- 1..* Concepts in the code system --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Code that identifies concept --> <display value="[string]"/><!-- 0..1 Text to display to the user --> <definition value="[string]"/><!-- 0..1 Formal definition --> <designation> 0..* BackboneElement <!-- 0..* Additional representations for the concept --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!-- 0..1 Human language of the designation --> <use><!-- 0..1 Coding Details how this designation would be used --></use> <value value="[string]"/><!-- 1..1 The text value for this designation --> </designation> <property> 0..* BackboneElement <!-- 0..* Property value for the concept --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- 1..1 Reference to CodeSystem.property.code --> <value[x]><!-- 1..1 code|Coding|string|integer| boolean|dateTime|decimal Value of the property for this concept --></value[x]> </property> <concept><!-- See #CodeSystem.concept Child Concepts (is-a/contains/categorizes) --></concept> </concept> </CodeSystem>
JSON Template
{ // Shareable CodeSystem // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "url" : "<uri>", // C? R! Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) "identifier" : [{ Identifier }], // C?Additional identifier for the code system (business identifier) "version" : "<string>", // C? R! Business version of the code system (Coding.version) "name" : "<string>", // C? R! Name for this code system (computer friendly) "title" : "<string>", // C?Name for this code system (human friendly) "status" : "<code>", // C? R! draft | active | retired | unknown "experimental" : <boolean>, // C? R! For testing purposes, not real usage "date" : "<dateTime>", // C?Date last changed "publisher" : "<string>", // C? R! Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C? R! Natural language description of the code system "useContext" : [{ UsageContext }], // C?The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for code system (if applicable) "purpose" : "<markdown>", // C?Why this code system is defined "copyright" : "<markdown>", // C?Use and/or publishing restrictions "caseSensitive" : <boolean>, // C?If code comparison is case sensitive "valueSet" : "<canonical>", // C?Canonical reference to the value set with entire code system "hierarchyMeaning" : "<code>", // C?grouped-by | is-a | part-of | classified-with "compositional" : <boolean>, // C?If code system defines a compositional grammar "versionNeeded" : <boolean>, // C?If definitions are not stable "content" : "<code>", // C? R! not-present | example | fragment | complete | supplement "supplements" : "<canonical>", // C?Canonical URL of Code System this adds designations and properties to "count" : "<unsignedInt>", // C?Total concepts in the code system "filter" : [{ BackboneElement }], // C?Filter that can be used in a value set "property" : [{ BackboneElement }], // C?Additional information supplied about each concept "concept" : [{ BackboneElement }] // C? R! Concepts in the code system }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
CodeSystem.language | Common Languages | preferred | Common Languages |
CodeSystem.status | PublicationStatus | required | PublicationStatus |
CodeSystem.jurisdiction | Jurisdiction | extensible | Jurisdiction |
CodeSystem.hierarchyMeaning | CodeSystemHierarchyMeaning | required | CodeSystemHierarchyMeaning |
CodeSystem.content | CodeSystemContentMode | required | CodeSystemContentMode |
CodeSystem.filter.operator | FilterOperator | required | FilterOperator |
CodeSystem.property.type | PropertyType | required | PropertyType |
CodeSystem.concept.designation.language | Common Languages | preferred | Common Languages |
CodeSystem.concept.designation.use | Designation Use | extensible | Designation Use |