This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Terminology Infrastructure Work Group | Maturity Level: N | Normative (from v4.0.0) | Security Category: Anonymous | Compartments: No defined compartments |
Detailed Descriptions for the elements in the CodeSystem resource.
CodeSystem | |||||||||||||||||||||||||
Element Id | CodeSystem | ||||||||||||||||||||||||
Definition | The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content. | ||||||||||||||||||||||||
Short Display | Declares the existence of and describes a code system or code system supplement | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | MetadataResource | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.url | |||||||||||||||||||||||||
Element Id | CodeSystem.url | ||||||||||||||||||||||||
Definition | An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system. | ||||||||||||||||||||||||
Short Display | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Requirements | Allows the code system to be referenced by a single globally unique identifier. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.identifier | |||||||||||||||||||||||||
Element Id | CodeSystem.identifier | ||||||||||||||||||||||||
Definition | A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||||||||||||||||||
Short Display | Additional identifier for the code system (business identifier) | ||||||||||||||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code. | ||||||||||||||||||||||||
CodeSystem.version | |||||||||||||||||||||||||
Element Id | CodeSystem.version | ||||||||||||||||||||||||
Definition | The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version. | ||||||||||||||||||||||||
Short Display | Business version of the code system (Coding.version) | ||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||||||||||||||
CodeSystem.versionAlgorithm[x] | |||||||||||||||||||||||||
Element Id | CodeSystem.versionAlgorithm[x] | ||||||||||||||||||||||||
Definition | Indicates the mechanism used to compare versions to determine which CodeSystem is more current. | ||||||||||||||||||||||||
Short Display | How to compare versions | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||||||||||||||||||
Type | string|Coding | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. | ||||||||||||||||||||||||
CodeSystem.name | |||||||||||||||||||||||||
Element Id | CodeSystem.name | ||||||||||||||||||||||||
Definition | A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||||||||||||||||||
Short Display | Name for this code system (computer friendly) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.title | |||||||||||||||||||||||||
Element Id | CodeSystem.title | ||||||||||||||||||||||||
Definition | A short, descriptive, user-friendly title for the code system. | ||||||||||||||||||||||||
Short Display | Name for this code system (human friendly) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||
CodeSystem.status | |||||||||||||||||||||||||
Element Id | CodeSystem.status | ||||||||||||||||||||||||
Definition | The status of this code system. Enables tracking the life-cycle of the content. | ||||||||||||||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration) | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Allows filtering of code systems that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.experimental | |||||||||||||||||||||||||
Element Id | CodeSystem.experimental | ||||||||||||||||||||||||
Definition | A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||||||||||||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Allows filtering of code systems that are appropriate for use versus not. | ||||||||||||||||||||||||
CodeSystem.date | |||||||||||||||||||||||||
Element Id | CodeSystem.date | ||||||||||||||||||||||||
Definition | The date (and optionally time) when the code system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes. | ||||||||||||||||||||||||
Short Display | Date last changed | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.publisher | |||||||||||||||||||||||||
Element Id | CodeSystem.publisher | ||||||||||||||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the code system. | ||||||||||||||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the code system. May also allow for contact. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context. | ||||||||||||||||||||||||
CodeSystem.contact | |||||||||||||||||||||||||
Element Id | CodeSystem.contact | ||||||||||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||||||||||
Short Display | Contact details for the publisher | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.description | |||||||||||||||||||||||||
Element Id | CodeSystem.description | ||||||||||||||||||||||||
Definition | A free text natural language description of the code system from a consumer's perspective. | ||||||||||||||||||||||||
Short Display | Natural language description of the code system | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||
Alternate Names | Scope; Purpose | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created). | ||||||||||||||||||||||||
CodeSystem.useContext | |||||||||||||||||||||||||
Element Id | CodeSystem.useContext | ||||||||||||||||||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances. | ||||||||||||||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||
CodeSystem.jurisdiction | |||||||||||||||||||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||||||||||||||||||
Element Id | CodeSystem.jurisdiction | ||||||||||||||||||||||||
Definition | A legal or geographic region in which the code system is intended to be used. | ||||||||||||||||||||||||
Short Display | Intended jurisdiction for code system (if applicable) | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | ||||||||||||||||||||||||
CodeSystem.purpose | |||||||||||||||||||||||||
Element Id | CodeSystem.purpose | ||||||||||||||||||||||||
Definition | Explanation of why this code system is needed and why it has been designed as it has. | ||||||||||||||||||||||||
Short Display | Why this code system is defined | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system. | ||||||||||||||||||||||||
CodeSystem.copyright | |||||||||||||||||||||||||
Element Id | CodeSystem.copyright | ||||||||||||||||||||||||
Definition | A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system. | ||||||||||||||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the code system and/or its content. | ||||||||||||||||||||||||
Alternate Names | License; Restrictions | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | ... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required. | ||||||||||||||||||||||||
CodeSystem.copyrightLabel | |||||||||||||||||||||||||
Element Id | CodeSystem.copyrightLabel | ||||||||||||||||||||||||
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||||||||||||||||||
Short Display | Copyright holder and year(s) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | ||||||||||||||||||||||||
CodeSystem.approvalDate | |||||||||||||||||||||||||
Element Id | CodeSystem.approvalDate | ||||||||||||||||||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||||||||||||||||||
Short Display | When the CodeSystem was approved by publisher | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.lastReviewDate | |||||||||||||||||||||||||
Element Id | CodeSystem.lastReviewDate | ||||||||||||||||||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||||||||||||||||||
Short Display | When the CodeSystem was last reviewed by the publisher | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.effectivePeriod | |||||||||||||||||||||||||
Element Id | CodeSystem.effectivePeriod | ||||||||||||||||||||||||
Definition | The period during which the CodeSystem content was or is planned to be in active use. | ||||||||||||||||||||||||
Short Display | When the CodeSystem is expected to be used | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the CodeSystem are or are expected to be used instead. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The effective period for a CodeSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a system intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.topic | |||||||||||||||||||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||||||||||||||||||
Element Id | CodeSystem.topic | ||||||||||||||||||||||||
Definition | Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching. | ||||||||||||||||||||||||
Short Display | E.g. Education, Treatment, Assessment, etc | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | Definition Topic (Example) | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Repositories must be able to determine how to categorize the CodeSystem so that it can be found by topical and keyword searches. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) | ||||||||||||||||||||||||
CodeSystem.author | |||||||||||||||||||||||||
Element Id | CodeSystem.author | ||||||||||||||||||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the CodeSystem. | ||||||||||||||||||||||||
Short Display | Who authored the CodeSystem | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.editor | |||||||||||||||||||||||||
Element Id | CodeSystem.editor | ||||||||||||||||||||||||
Definition | An individual or organization primarily responsible for internal coherence of the CodeSystem. | ||||||||||||||||||||||||
Short Display | Who edited the CodeSystem | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.reviewer | |||||||||||||||||||||||||
Element Id | CodeSystem.reviewer | ||||||||||||||||||||||||
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem. | ||||||||||||||||||||||||
Short Display | Who reviewed the CodeSystem | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.endorser | |||||||||||||||||||||||||
Element Id | CodeSystem.endorser | ||||||||||||||||||||||||
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting. | ||||||||||||||||||||||||
Short Display | Who endorsed the CodeSystem | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||
CodeSystem.relatedArtifact | |||||||||||||||||||||||||
Element Id | CodeSystem.relatedArtifact | ||||||||||||||||||||||||
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. | ||||||||||||||||||||||||
Short Display | Additional documentation, citations, etc | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | RelatedArtifact | ||||||||||||||||||||||||
Requirements | A CodeSystem must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||||||||||||||||||
CodeSystem.caseSensitive | |||||||||||||||||||||||||
Element Id | CodeSystem.caseSensitive | ||||||||||||||||||||||||
Definition | If code comparison is case sensitive when codes within this system are compared to each other. | ||||||||||||||||||||||||
Short Display | If code comparison is case sensitive | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software. Case-insensitive comparisons do not take locale into account, and will result in unsatisfactory results for certain locales. Character case definitions and conversions are out of scope for the FHIR standard, and the results of such operations are implementation dependent. | ||||||||||||||||||||||||
CodeSystem.valueSet | |||||||||||||||||||||||||
Element Id | CodeSystem.valueSet | ||||||||||||||||||||||||
Definition | Canonical reference to the value set that contains all codes in the code system independent of code status. | ||||||||||||||||||||||||
Short Display | Canonical reference to the value set with entire code system | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions. | ||||||||||||||||||||||||
CodeSystem.hierarchyMeaning | |||||||||||||||||||||||||
Element Id | CodeSystem.hierarchyMeaning | ||||||||||||||||||||||||
Definition | The meaning of the hierarchy of concepts as represented in this resource. | ||||||||||||||||||||||||
Short Display | grouped-by | is-a | part-of | classified-with | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Code System Hierarchy Meaning (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Note that other representations might have a different hierarchy or none at all, and represent the information using properties. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.compositional | |||||||||||||||||||||||||
Element Id | CodeSystem.compositional | ||||||||||||||||||||||||
Definition | The code system defines a compositional (post-coordination) grammar. | ||||||||||||||||||||||||
Short Display | If code system defines a compositional grammar | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Alternate Names | grammar | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Note that the code system resource does not define what the compositional grammar is, only whether or not there is one. Note that the code system resource does not define what the compositional grammar is, only whether or not there is one. Review the Using Code System X with HL7 Standards (where Code System X is a specific code system) pages at terminology.hl7.org to learn about a code system's post coordination support. Coding.code has some more information about how a post coordinated expression may be exchanged in a code element. | ||||||||||||||||||||||||
CodeSystem.versionNeeded | |||||||||||||||||||||||||
Element Id | CodeSystem.versionNeeded | ||||||||||||||||||||||||
Definition | This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system. | ||||||||||||||||||||||||
Short Display | If definitions are not stable | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'. Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property. | ||||||||||||||||||||||||
CodeSystem.content | |||||||||||||||||||||||||
Element Id | CodeSystem.content | ||||||||||||||||||||||||
Definition | The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. | ||||||||||||||||||||||||
Short Display | not-present | example | fragment | complete | supplement | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Code System Content Mode (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.supplements | |||||||||||||||||||||||||
Element Id | CodeSystem.supplements | ||||||||||||||||||||||||
Definition | The canonical URL of the code system that this code system supplement is adding designations and properties to. | ||||||||||||||||||||||||
Short Display | Canonical URL of Code System this adds designations and properties to | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The most common use of a code system supplement is to add additional language support. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.count | |||||||||||||||||||||||||
Element Id | CodeSystem.count | ||||||||||||||||||||||||
Definition | The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward. | ||||||||||||||||||||||||
Short Display | Total concepts in the code system | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | unsignedInt | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element. | ||||||||||||||||||||||||
CodeSystem.filter | |||||||||||||||||||||||||
Element Id | CodeSystem.filter | ||||||||||||||||||||||||
Definition | A filter that can be used in a value set compose statement when selecting concepts using a filter. | ||||||||||||||||||||||||
Short Display | Filter that can be used in a value set | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies. | ||||||||||||||||||||||||
CodeSystem.filter.code | |||||||||||||||||||||||||
Element Id | CodeSystem.filter.code | ||||||||||||||||||||||||
Definition | The code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter. | ||||||||||||||||||||||||
Short Display | Code that identifies the filter | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.filter.description | |||||||||||||||||||||||||
Element Id | CodeSystem.filter.description | ||||||||||||||||||||||||
Definition | A description of how or why the filter is used. | ||||||||||||||||||||||||
Short Display | How or why the filter is used | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.filter.operator | |||||||||||||||||||||||||
Element Id | CodeSystem.filter.operator | ||||||||||||||||||||||||
Definition | A list of operators that can be used with the filter. | ||||||||||||||||||||||||
Short Display | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists | ||||||||||||||||||||||||
Cardinality | 1..* | ||||||||||||||||||||||||
Terminology Binding | Filter Operator (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.filter.value | |||||||||||||||||||||||||
Element Id | CodeSystem.filter.value | ||||||||||||||||||||||||
Definition | A description of what the value for the filter should be. | ||||||||||||||||||||||||
Short Display | What to use for the value | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.property | |||||||||||||||||||||||||
Element Id | CodeSystem.property | ||||||||||||||||||||||||
Definition | A property defines an additional slot through which additional information can be provided about a concept. | ||||||||||||||||||||||||
Short Display | Additional information supplied about each concept | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept. | ||||||||||||||||||||||||
CodeSystem.property.code | |||||||||||||||||||||||||
Element Id | CodeSystem.property.code | ||||||||||||||||||||||||
Definition | A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters. | ||||||||||||||||||||||||
Short Display | Identifies the property on the concepts, and when referred to in operations | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.property.uri | |||||||||||||||||||||||||
Element Id | CodeSystem.property.uri | ||||||||||||||||||||||||
Definition | Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system. | ||||||||||||||||||||||||
Short Display | Formal identifier for the property | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.property.description | |||||||||||||||||||||||||
Element Id | CodeSystem.property.description | ||||||||||||||||||||||||
Definition | A description of the property- why it is defined, and how its value might be used. | ||||||||||||||||||||||||
Short Display | Why the property is defined, and/or what it conveys | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.property.type | |||||||||||||||||||||||||
Element Id | CodeSystem.property.type | ||||||||||||||||||||||||
Definition | The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept). | ||||||||||||||||||||||||
Short Display | code | Coding | string | integer | boolean | dateTime | decimal | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Property Type (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
CodeSystem.concept | |||||||||||||||||||||||||
Element Id | CodeSystem.concept | ||||||||||||||||||||||||
Definition | Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. | ||||||||||||||||||||||||
Short Display | Concepts in the code system | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | If this is empty, it means that the code system resource does not represent the content of the code system. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.concept.code | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.code | ||||||||||||||||||||||||
Definition | A code - a text symbol - that uniquely identifies the concept within the code system. | ||||||||||||||||||||||||
Short Display | Code that identifies concept | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.concept.display | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.display | ||||||||||||||||||||||||
Definition | A human readable string that is the recommended default way to present this concept to a user. | ||||||||||||||||||||||||
Short Display | Text to display to the user | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.concept.definition | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.definition | ||||||||||||||||||||||||
Definition | The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept. | ||||||||||||||||||||||||
Short Display | Formal definition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.concept.designation | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.designation | ||||||||||||||||||||||||
Definition | Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. | ||||||||||||||||||||||||
Short Display | Additional representations for the concept | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Requirements | Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | Concepts have both a | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.concept.designation.language | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.designation.language | ||||||||||||||||||||||||
Definition | The language this designation is defined for. | ||||||||||||||||||||||||
Short Display | Human language of the designation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | All Languages (Required)
| ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | In the absence of a language, the resource language applies. | ||||||||||||||||||||||||
CodeSystem.concept.designation.use | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.designation.use | ||||||||||||||||||||||||
Definition | A code that details how this designation would be used. | ||||||||||||||||||||||||
Short Display | Details how this designation would be used | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Designation Use (Extensible) | ||||||||||||||||||||||||
Type | Coding | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | If no use is provided, the designation can be assumed to be suitable for general display to a human user. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.concept.designation.additionalUse | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.designation.additionalUse | ||||||||||||||||||||||||
Definition | Additional codes that detail how this designation would be used, if there is more than one use. | ||||||||||||||||||||||||
Short Display | Additional ways how this designation would be used | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | Designation Use (Extensible) | ||||||||||||||||||||||||
Type | Coding | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.concept.designation.value | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.designation.value | ||||||||||||||||||||||||
Definition | The text value for this designation. | ||||||||||||||||||||||||
Short Display | The text value for this designation | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.concept.property | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.property | ||||||||||||||||||||||||
Definition | A property value for this concept. | ||||||||||||||||||||||||
Short Display | Property value for the concept | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.concept.property.code | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.property.code | ||||||||||||||||||||||||
Definition | A code that is a reference to CodeSystem.property.code. | ||||||||||||||||||||||||
Short Display | Reference to CodeSystem.property.code | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
CodeSystem.concept.property.value[x] | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.property.value[x] | ||||||||||||||||||||||||
Definition | The value of this property. | ||||||||||||||||||||||||
Short Display | Value of the property for this concept | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code|Coding|string|integer|boolean|dateTime|decimal | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
CodeSystem.concept.concept | |||||||||||||||||||||||||
Element Id | CodeSystem.concept.concept | ||||||||||||||||||||||||
Definition | Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning. | ||||||||||||||||||||||||
Short Display | Child Concepts (is-a/contains/categorizes) | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | See CodeSystem.concept | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
|