Terminology Change Set Exchange, published by HL7 International / Terminology Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/termchangeset-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/changeset-profile | Version: 1.0.0 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: ChangeSet |
Profile of CodeSystem to enable lossless representation of a terminology change set aligned with Tinkar information model requirements
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable CodeSystem
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | 1..1 | Shareable 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). NOTE: Where not specified by an SDO-specific policy (such as SNOMED’s extension process), change sets associated with locally-maintained extensions should include a url clearly identifying the extension as published under the implementer’s authority, and not the SDO. | |
identifier | 1..1 | Identifier | Additional identifier for the code system (business identifier) | |
value | 0..1 | string | The value that is unique | |
version | 1..1 | string | Business version of the code system (Coding.version). NOTE: where not specified by an SDO-specific policy, it is recommended that implementers consider aligning to HL7 terminology versioning approach. | |
name | 1..1 | string | Name for this code system (computer friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | |
title | 1..1 | string | Name for this code system (human friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | |
description | 1..1 | markdown | Natural language description of the code system. Should provide a robust inventory of the contents of the Change Set | |
copyright | 1..1 | markdown | Use and/or publishing restrictions | |
hierarchyMeaning | 0..1 | code | NOTE: As a terminology change set should not be fundamentally altering the design and operation of the terminology as a whole, the hierarchyMeaning, if included, should be consistent with the value provided for a CodeSystem representing the entire terminology. | |
content | 1..1 | code | Change Set CodeSystem resources are most appropriately described as a FRAGMENT Fixed Value: fragment | |
supplements | 0..0 | |||
property | S | 0..* | BackboneElement | Additional information supplied about each concept. Property values should follow the guidance available in the terminology-specific links in the 'Use with HL7 Standards' column within the [HL7 Terminology External Code Systems page](https://terminology.hl7.org/external_terminologies.html). |
uri | 0..1 | uri | Formal identifier for the property | |
description | S | 0..1 | string | Why the property is defined, and/or what it conveys |
type | 1..1 | code | code | Coding | string | integer | boolean | dateTime | |
concept | 1..* | BackboneElement | Concepts in the change set for the code system | |
id | 0..1 | string | Unique internal identifier maintained by the entity distributing the change set for the concept represented by the terminology-specific concept.code | |
code | 1..1 | code | Code that identifies concept | |
display | 1..1 | string | Text to display to the user representing the concept | |
definition | 1..1 | string | Formal definition | |
designation | 0..* | BackboneElement | Additional representations for the concept | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
caseSensitivity | 0..1 | CodeableConcept | Description Case Sensitivity URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-case-sensitivity Binding: Case Significance Value Set (required) | |
acceptability | 0..1 | CodeableConcept | Description Acceptability URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-acceptability Binding: Description Acceptability Value Set (required) | |
dialect | 0..1 | CodeableConcept | Description Dialect URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-dialect Binding: Dialect Value Set (extensible) | |
language | 0..1 | code | Human language of the designation | |
use | 0..1 | Coding | Details how this designation would be used | |
value | 1..1 | string | The text value for this designation | |
property | S | 0..* | BackboneElement | Property value for the concept |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
DefiningRelationshipType | 0..1 | CodeableConcept | Defining Relationship Type URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/defining-relationship-type Binding: Defining Relationship Type Value Set (required) | |
elProfileSetOperator | 0..1 | CodeableConcept | EL Profile Set Operator URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/el-profile-set-operator Binding: EL Profile Set Operator Value Set (required) | |
roleGroup | 0..1 | integer | SNOMED Role Group URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/role-group | |
code | 1..1 | code | Reference to CodeSystem.property.code | |
value[x] | 1..1 | code, Coding, string, integer, boolean, dateTime, decimal | Value of the property for this concept | |
concept | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | C | 1..1 | Shareable 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 | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system). NOTE: Where not specified by an SDO-specific policy (such as SNOMED’s extension process), change sets associated with locally-maintained extensions should include a url clearly identifying the extension as published under the implementer’s authority, and not the SDO. | ||||
identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
version | Σ | 1..1 | string | Business version of the code system (Coding.version). NOTE: where not specified by an SDO-specific policy, it is recommended that implementers consider aligning to HL7 terminology versioning approach. | ||||
name | ΣC | 1..1 | string | Name for this code system (computer friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
title | Σ | 1..1 | string | Name for this code system (human friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
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. Should provide a robust inventory of the contents of the Change Set | |||||
copyright | 1..1 | markdown | Use and/or publishing restrictions | |||||
hierarchyMeaning | Σ | 0..1 | code | NOTE: As a terminology change set should not be fundamentally altering the design and operation of the terminology as a whole, the hierarchyMeaning, if included, should be consistent with the value provided for a CodeSystem representing the entire terminology. Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
content | Σ | 1..1 | code | Change Set CodeSystem resources are most appropriately described as a FRAGMENT 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. Fixed Value: fragment | ||||
property | SΣ | 0..* | BackboneElement | Additional information supplied about each concept. Property values should follow the guidance available in the terminology-specific links in the 'Use with HL7 Standards' column within the [HL7 Terminology External Code Systems page](https://terminology.hl7.org/external_terminologies.html). | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
uri | Σ | 0..1 | uri | Formal identifier for the property | ||||
description | SΣ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime Binding: PropertyType (required): The type of a property value. | ||||
concept | 1..* | BackboneElement | Concepts in the change set for the code system | |||||
id | 0..1 | string | Unique internal identifier maintained by the entity distributing the change set for the concept represented by the terminology-specific concept.code | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Code that identifies concept | |||||
display | 1..1 | string | Text to display to the user representing the concept | |||||
definition | 1..1 | string | Formal definition | |||||
designation | 0..* | BackboneElement | Additional representations for the concept | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
caseSensitivity | 0..1 | CodeableConcept | Description Case Sensitivity URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-case-sensitivity Binding: Case Significance Value Set (required) | |||||
acceptability | 0..1 | CodeableConcept | Description Acceptability URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-acceptability Binding: Description Acceptability Value Set (required) | |||||
dialect | 0..1 | CodeableConcept | Description Dialect URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-dialect Binding: Dialect Value Set (extensible) | |||||
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 | |||||
property | S | 0..* | BackboneElement | Property value for the concept | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
DefiningRelationshipType | 0..1 | CodeableConcept | Defining Relationship Type URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/defining-relationship-type Binding: Defining Relationship Type Value Set (required) | |||||
elProfileSetOperator | 0..1 | CodeableConcept | EL Profile Set Operator URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/el-profile-set-operator Binding: EL Profile Set Operator Value Set (required) | |||||
roleGroup | 0..1 | integer | SNOMED Role Group URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/role-group | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to CodeSystem.property.code | |||||
value[x] | 1..1 | Value of the property for this concept | ||||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CodeSystem.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 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 | Fixed Value: fragmenthttp://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 | ||||
CodeSystem.concept.designation.language | preferred | CommonLanguages
http://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 |
Id | Grade | Path(s) | Details | Requirements |
csd-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CodeSystem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | C | 1..1 | Shareable 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 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system). NOTE: Where not specified by an SDO-specific policy (such as SNOMED’s extension process), change sets associated with locally-maintained extensions should include a url clearly identifying the extension as published under the implementer’s authority, and not the SDO. | ||||
identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
version | Σ | 1..1 | string | Business version of the code system (Coding.version). NOTE: where not specified by an SDO-specific policy, it is recommended that implementers consider aligning to HL7 terminology versioning approach. | ||||
name | ΣC | 1..1 | string | Name for this code system (computer friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
title | Σ | 1..1 | string | Name for this code system (human friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | 1..1 | markdown | Natural language description of the code system. Should provide a robust inventory of the contents of the Change Set | |||||
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 | 1..1 | markdown | Use and/or publishing restrictions | |||||
caseSensitive | Σ | 0..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 | NOTE: As a terminology change set should not be fundamentally altering the design and operation of the terminology as a whole, the hierarchyMeaning, if included, should be consistent with the value provided for a CodeSystem representing the entire terminology. Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
versionNeeded | Σ | 0..1 | boolean | If definitions are not stable | ||||
content | Σ | 1..1 | code | Change Set CodeSystem resources are most appropriately described as a FRAGMENT 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. Fixed Value: fragment | ||||
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. Property values should follow the guidance available in the terminology-specific links in the 'Use with HL7 Standards' column within the [HL7 Terminology External Code Systems page](https://terminology.hl7.org/external_terminologies.html). | ||||
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 | Identifies the property on the concepts, and when referred to in operations | ||||
uri | Σ | 0..1 | uri | Formal identifier for the property | ||||
description | SΣ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime Binding: PropertyType (required): The type of a property value. | ||||
concept | 1..* | BackboneElement | Concepts in the change set for the code system | |||||
id | 0..1 | string | Unique internal identifier maintained by the entity distributing the change set for the concept represented by the terminology-specific concept.code | |||||
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 concept | |||||
display | 1..1 | string | Text to display to the user representing the concept | |||||
definition | 1..1 | string | Formal definition | |||||
designation | 0..* | BackboneElement | Additional representations for the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
caseSensitivity | 0..1 | CodeableConcept | Description Case Sensitivity URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-case-sensitivity Binding: Case Significance Value Set (required) | |||||
acceptability | 0..1 | CodeableConcept | Description Acceptability URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-acceptability Binding: Description Acceptability Value Set (required) | |||||
dialect | 0..1 | CodeableConcept | Description Dialect URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-dialect Binding: Dialect Value Set (extensible) | |||||
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 | |||||
property | S | 0..* | BackboneElement | Property value for the concept | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
DefiningRelationshipType | 0..1 | CodeableConcept | Defining Relationship Type URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/defining-relationship-type Binding: Defining Relationship Type Value Set (required) | |||||
elProfileSetOperator | 0..1 | CodeableConcept | EL Profile Set Operator URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/el-profile-set-operator Binding: EL Profile Set Operator Value Set (required) | |||||
roleGroup | 0..1 | integer | SNOMED Role Group URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/role-group | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to CodeSystem.property.code | |||||
value[x] | 1..1 | Value of the property for this concept | ||||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CodeSystem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CodeSystem.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CodeSystem.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type 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 | Fixed Value: fragmenthttp://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 | CommonLanguages
http://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 |
Id | Grade | Path(s) | Details | Requirements |
csd-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CodeSystem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Shareable CodeSystem
Summary
Mandatory: 5 elements
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Differential View
This structure is derived from Shareable CodeSystem
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | 1..1 | Shareable 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). NOTE: Where not specified by an SDO-specific policy (such as SNOMED’s extension process), change sets associated with locally-maintained extensions should include a url clearly identifying the extension as published under the implementer’s authority, and not the SDO. | |
identifier | 1..1 | Identifier | Additional identifier for the code system (business identifier) | |
value | 0..1 | string | The value that is unique | |
version | 1..1 | string | Business version of the code system (Coding.version). NOTE: where not specified by an SDO-specific policy, it is recommended that implementers consider aligning to HL7 terminology versioning approach. | |
name | 1..1 | string | Name for this code system (computer friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | |
title | 1..1 | string | Name for this code system (human friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | |
description | 1..1 | markdown | Natural language description of the code system. Should provide a robust inventory of the contents of the Change Set | |
copyright | 1..1 | markdown | Use and/or publishing restrictions | |
hierarchyMeaning | 0..1 | code | NOTE: As a terminology change set should not be fundamentally altering the design and operation of the terminology as a whole, the hierarchyMeaning, if included, should be consistent with the value provided for a CodeSystem representing the entire terminology. | |
content | 1..1 | code | Change Set CodeSystem resources are most appropriately described as a FRAGMENT Fixed Value: fragment | |
supplements | 0..0 | |||
property | S | 0..* | BackboneElement | Additional information supplied about each concept. Property values should follow the guidance available in the terminology-specific links in the 'Use with HL7 Standards' column within the [HL7 Terminology External Code Systems page](https://terminology.hl7.org/external_terminologies.html). |
uri | 0..1 | uri | Formal identifier for the property | |
description | S | 0..1 | string | Why the property is defined, and/or what it conveys |
type | 1..1 | code | code | Coding | string | integer | boolean | dateTime | |
concept | 1..* | BackboneElement | Concepts in the change set for the code system | |
id | 0..1 | string | Unique internal identifier maintained by the entity distributing the change set for the concept represented by the terminology-specific concept.code | |
code | 1..1 | code | Code that identifies concept | |
display | 1..1 | string | Text to display to the user representing the concept | |
definition | 1..1 | string | Formal definition | |
designation | 0..* | BackboneElement | Additional representations for the concept | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
caseSensitivity | 0..1 | CodeableConcept | Description Case Sensitivity URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-case-sensitivity Binding: Case Significance Value Set (required) | |
acceptability | 0..1 | CodeableConcept | Description Acceptability URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-acceptability Binding: Description Acceptability Value Set (required) | |
dialect | 0..1 | CodeableConcept | Description Dialect URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-dialect Binding: Dialect Value Set (extensible) | |
language | 0..1 | code | Human language of the designation | |
use | 0..1 | Coding | Details how this designation would be used | |
value | 1..1 | string | The text value for this designation | |
property | S | 0..* | BackboneElement | Property value for the concept |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
DefiningRelationshipType | 0..1 | CodeableConcept | Defining Relationship Type URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/defining-relationship-type Binding: Defining Relationship Type Value Set (required) | |
elProfileSetOperator | 0..1 | CodeableConcept | EL Profile Set Operator URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/el-profile-set-operator Binding: EL Profile Set Operator Value Set (required) | |
roleGroup | 0..1 | integer | SNOMED Role Group URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/role-group | |
code | 1..1 | code | Reference to CodeSystem.property.code | |
value[x] | 1..1 | code, Coding, string, integer, boolean, dateTime, decimal | Value of the property for this concept | |
concept | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | C | 1..1 | Shareable 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 | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system). NOTE: Where not specified by an SDO-specific policy (such as SNOMED’s extension process), change sets associated with locally-maintained extensions should include a url clearly identifying the extension as published under the implementer’s authority, and not the SDO. | ||||
identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
version | Σ | 1..1 | string | Business version of the code system (Coding.version). NOTE: where not specified by an SDO-specific policy, it is recommended that implementers consider aligning to HL7 terminology versioning approach. | ||||
name | ΣC | 1..1 | string | Name for this code system (computer friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
title | Σ | 1..1 | string | Name for this code system (human friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
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. Should provide a robust inventory of the contents of the Change Set | |||||
copyright | 1..1 | markdown | Use and/or publishing restrictions | |||||
hierarchyMeaning | Σ | 0..1 | code | NOTE: As a terminology change set should not be fundamentally altering the design and operation of the terminology as a whole, the hierarchyMeaning, if included, should be consistent with the value provided for a CodeSystem representing the entire terminology. Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
content | Σ | 1..1 | code | Change Set CodeSystem resources are most appropriately described as a FRAGMENT 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. Fixed Value: fragment | ||||
property | SΣ | 0..* | BackboneElement | Additional information supplied about each concept. Property values should follow the guidance available in the terminology-specific links in the 'Use with HL7 Standards' column within the [HL7 Terminology External Code Systems page](https://terminology.hl7.org/external_terminologies.html). | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
uri | Σ | 0..1 | uri | Formal identifier for the property | ||||
description | SΣ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime Binding: PropertyType (required): The type of a property value. | ||||
concept | 1..* | BackboneElement | Concepts in the change set for the code system | |||||
id | 0..1 | string | Unique internal identifier maintained by the entity distributing the change set for the concept represented by the terminology-specific concept.code | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Code that identifies concept | |||||
display | 1..1 | string | Text to display to the user representing the concept | |||||
definition | 1..1 | string | Formal definition | |||||
designation | 0..* | BackboneElement | Additional representations for the concept | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
caseSensitivity | 0..1 | CodeableConcept | Description Case Sensitivity URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-case-sensitivity Binding: Case Significance Value Set (required) | |||||
acceptability | 0..1 | CodeableConcept | Description Acceptability URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-acceptability Binding: Description Acceptability Value Set (required) | |||||
dialect | 0..1 | CodeableConcept | Description Dialect URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-dialect Binding: Dialect Value Set (extensible) | |||||
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 | |||||
property | S | 0..* | BackboneElement | Property value for the concept | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
DefiningRelationshipType | 0..1 | CodeableConcept | Defining Relationship Type URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/defining-relationship-type Binding: Defining Relationship Type Value Set (required) | |||||
elProfileSetOperator | 0..1 | CodeableConcept | EL Profile Set Operator URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/el-profile-set-operator Binding: EL Profile Set Operator Value Set (required) | |||||
roleGroup | 0..1 | integer | SNOMED Role Group URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/role-group | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to CodeSystem.property.code | |||||
value[x] | 1..1 | Value of the property for this concept | ||||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CodeSystem.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CodeSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 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 | Fixed Value: fragmenthttp://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 | ||||
CodeSystem.concept.designation.language | preferred | CommonLanguages
http://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 |
Id | Grade | Path(s) | Details | Requirements |
csd-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CodeSystem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | C | 1..1 | Shareable 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 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system). NOTE: Where not specified by an SDO-specific policy (such as SNOMED’s extension process), change sets associated with locally-maintained extensions should include a url clearly identifying the extension as published under the implementer’s authority, and not the SDO. | ||||
identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (business identifier) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
version | Σ | 1..1 | string | Business version of the code system (Coding.version). NOTE: where not specified by an SDO-specific policy, it is recommended that implementers consider aligning to HL7 terminology versioning approach. | ||||
name | ΣC | 1..1 | string | Name for this code system (computer friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
title | Σ | 1..1 | string | Name for this code system (human friendly). Should clearly identify the CodeSystem as a Change Set and ideally convey both the source terminology from which it was derived and a notion of its contents. | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | 1..1 | markdown | Natural language description of the code system. Should provide a robust inventory of the contents of the Change Set | |||||
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 | 1..1 | markdown | Use and/or publishing restrictions | |||||
caseSensitive | Σ | 0..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 | NOTE: As a terminology change set should not be fundamentally altering the design and operation of the terminology as a whole, the hierarchyMeaning, if included, should be consistent with the value provided for a CodeSystem representing the entire terminology. Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
versionNeeded | Σ | 0..1 | boolean | If definitions are not stable | ||||
content | Σ | 1..1 | code | Change Set CodeSystem resources are most appropriately described as a FRAGMENT 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. Fixed Value: fragment | ||||
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. Property values should follow the guidance available in the terminology-specific links in the 'Use with HL7 Standards' column within the [HL7 Terminology External Code Systems page](https://terminology.hl7.org/external_terminologies.html). | ||||
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 | Identifies the property on the concepts, and when referred to in operations | ||||
uri | Σ | 0..1 | uri | Formal identifier for the property | ||||
description | SΣ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime Binding: PropertyType (required): The type of a property value. | ||||
concept | 1..* | BackboneElement | Concepts in the change set for the code system | |||||
id | 0..1 | string | Unique internal identifier maintained by the entity distributing the change set for the concept represented by the terminology-specific concept.code | |||||
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 concept | |||||
display | 1..1 | string | Text to display to the user representing the concept | |||||
definition | 1..1 | string | Formal definition | |||||
designation | 0..* | BackboneElement | Additional representations for the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
caseSensitivity | 0..1 | CodeableConcept | Description Case Sensitivity URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-case-sensitivity Binding: Case Significance Value Set (required) | |||||
acceptability | 0..1 | CodeableConcept | Description Acceptability URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-acceptability Binding: Description Acceptability Value Set (required) | |||||
dialect | 0..1 | CodeableConcept | Description Dialect URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/description-dialect Binding: Dialect Value Set (extensible) | |||||
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 | |||||
property | S | 0..* | BackboneElement | Property value for the concept | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
DefiningRelationshipType | 0..1 | CodeableConcept | Defining Relationship Type URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/defining-relationship-type Binding: Defining Relationship Type Value Set (required) | |||||
elProfileSetOperator | 0..1 | CodeableConcept | EL Profile Set Operator URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/el-profile-set-operator Binding: EL Profile Set Operator Value Set (required) | |||||
roleGroup | 0..1 | integer | SNOMED Role Group URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/role-group | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to CodeSystem.property.code | |||||
value[x] | 1..1 | Value of the property for this concept | ||||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CodeSystem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CodeSystem.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CodeSystem.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type 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 | Fixed Value: fragmenthttp://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 | CommonLanguages
http://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 |
Id | Grade | Path(s) | Details | Requirements |
csd-0 | warning | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CodeSystem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Shareable CodeSystem
Summary
Mandatory: 5 elements
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron