Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_CodeSystem_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-CodeSystem Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_CodeSystem_R4

This cross-version profile allows R5 CodeSystem content to be represented via FHIR R4 CodeSystem resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem(4.0.1) Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the CodeSystem was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the CodeSystem was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the CodeSystem is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 CodeSystem.implicitRules, CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension, CodeSystem.status, CodeSystem.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem 0..* CodeSystem(4.0.1) Declares the existence of and describes a code system or code system supplement
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date R5: When the CodeSystem was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date R5: When the CodeSystem was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period R5: When the CodeSystem is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor 0..* ContactDetail R5: Who edited the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser 0..* ContactDetail R5: Who endorsed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... filter
.... operator
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:operator 0..* code R5: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.filter.operator
Binding: R5FilterOperatorForR4 (0.1.0) (required): The kind of operation to perform as a part of a property based filter.
... concept
.... designation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:additionalUse 0..* Coding R5: Additional ways how this designation would be used (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.designation.additionalUse

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem(4.0.1) Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the CodeSystem was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the CodeSystem was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the CodeSystem is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version Σ 0..1 string Business version of the code system (Coding.version)
... name ΣC 0..1 string Name for this code system (computer friendly)
... title Σ 0..1 string Name for this code system (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this code system is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... caseSensitive Σ 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 grouped-by | is-a | part-of | classified-with
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 not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
... supplements Σ 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
... count Σ 0..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:operator 0..* code R5: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.filter.operator
Binding: R5FilterOperatorForR4 (0.1.0) (required): The kind of operation to perform as a part of a property based filter.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... value Σ 1..1 string What to use for the value
... property Σ 0..* BackboneElement Additional information supplied about each concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 Σ 0..1 string Why the property is defined, and/or what it conveys
.... type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
... concept 0..* BackboneElement Concepts in the code system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 1..1 code Code that identifies concept
.... display 0..1 string Text to display to the user
.... definition 0..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
Constraints: ext-1
...... extension:additionalUse 0..* Coding R5: Additional ways how this designation would be used (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.designation.additionalUse
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... language 0..1 code Human language of the designation
Binding: CommonLanguages . (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... 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 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
.... concept 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
CodeSystem.hierarchyMeaning Base required CodeSystemHierarchyMeaning 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.
CodeSystem.filter.operator Base required FilterOperator . 📍4.0.1 tx.fhir.org
CodeSystem.property.​type Base required PropertyType 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
CodeSystem.concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 CodeSystem.meta, CodeSystem.implicitRules, CodeSystem.language, CodeSystem.text, CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension, CodeSystem.url, CodeSystem.identifier, CodeSystem.version, CodeSystem.name, CodeSystem.title, CodeSystem.status, CodeSystem.experimental, CodeSystem.date, CodeSystem.publisher, CodeSystem.contact, CodeSystem.description, CodeSystem.useContext, CodeSystem.jurisdiction, CodeSystem.purpose, CodeSystem.copyright, CodeSystem.caseSensitive, CodeSystem.valueSet, CodeSystem.hierarchyMeaning, CodeSystem.compositional, CodeSystem.versionNeeded, CodeSystem.content, CodeSystem.supplements, CodeSystem.count, CodeSystem.filter, CodeSystem.filter.extension, CodeSystem.filter.modifierExtension, CodeSystem.filter.code, CodeSystem.filter.description, CodeSystem.filter.operator, CodeSystem.filter.operator.extension, CodeSystem.filter.operator.extension:operator, CodeSystem.filter.value, CodeSystem.property, CodeSystem.property.extension, CodeSystem.property.modifierExtension, CodeSystem.property.code, CodeSystem.property.uri, CodeSystem.property.description, CodeSystem.property.type, CodeSystem.concept, CodeSystem.concept.extension, CodeSystem.concept.modifierExtension, CodeSystem.concept.code, CodeSystem.concept.display, CodeSystem.concept.definition, CodeSystem.concept.designation, CodeSystem.concept.designation.extension, CodeSystem.concept.designation.extension:additionalUse, CodeSystem.concept.designation.modifierExtension, CodeSystem.concept.designation.language, CodeSystem.concept.designation.use, CodeSystem.concept.designation.value, CodeSystem.concept.property, CodeSystem.concept.property.extension, CodeSystem.concept.property.modifierExtension, CodeSystem.concept.property.code, CodeSystem.concept.property.value[x], CodeSystem.concept.concept All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension, CodeSystem.filter.extension, CodeSystem.filter.modifierExtension, CodeSystem.filter.operator.extension, CodeSystem.filter.operator.extension:operator, CodeSystem.property.extension, CodeSystem.property.modifierExtension, CodeSystem.concept.extension, CodeSystem.concept.modifierExtension, CodeSystem.concept.designation.extension, CodeSystem.concept.designation.extension:additionalUse, CodeSystem.concept.designation.modifierExtension, CodeSystem.concept.property.extension, CodeSystem.concept.property.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem(4.0.1) Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the CodeSystem was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the CodeSystem was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the CodeSystem is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 CodeSystem.implicitRules, CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension, CodeSystem.status, CodeSystem.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem 0..* CodeSystem(4.0.1) Declares the existence of and describes a code system or code system supplement
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date R5: When the CodeSystem was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date R5: When the CodeSystem was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period R5: When the CodeSystem is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor 0..* ContactDetail R5: Who edited the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser 0..* ContactDetail R5: Who endorsed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... filter
.... operator
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:operator 0..* code R5: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.filter.operator
Binding: R5FilterOperatorForR4 (0.1.0) (required): The kind of operation to perform as a part of a property based filter.
... concept
.... designation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:additionalUse 0..* Coding R5: Additional ways how this designation would be used (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.designation.additionalUse

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem(4.0.1) Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the CodeSystem was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the CodeSystem was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the CodeSystem is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the CodeSystem (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version Σ 0..1 string Business version of the code system (Coding.version)
... name ΣC 0..1 string Name for this code system (computer friendly)
... title Σ 0..1 string Name for this code system (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this code system is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... caseSensitive Σ 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 grouped-by | is-a | part-of | classified-with
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 not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
... supplements Σ 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
... count Σ 0..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:operator 0..* code R5: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.filter.operator
Binding: R5FilterOperatorForR4 (0.1.0) (required): The kind of operation to perform as a part of a property based filter.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... value Σ 1..1 string What to use for the value
... property Σ 0..* BackboneElement Additional information supplied about each concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 Σ 0..1 string Why the property is defined, and/or what it conveys
.... type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
... concept 0..* BackboneElement Concepts in the code system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 1..1 code Code that identifies concept
.... display 0..1 string Text to display to the user
.... definition 0..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
Constraints: ext-1
...... extension:additionalUse 0..* Coding R5: Additional ways how this designation would be used (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.designation.additionalUse
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... language 0..1 code Human language of the designation
Binding: CommonLanguages . (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... 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 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
.... concept 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
CodeSystem.hierarchyMeaning Base required CodeSystemHierarchyMeaning 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.
CodeSystem.filter.operator Base required FilterOperator . 📍4.0.1 tx.fhir.org
CodeSystem.property.​type Base required PropertyType 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
CodeSystem.concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 CodeSystem.meta, CodeSystem.implicitRules, CodeSystem.language, CodeSystem.text, CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension, CodeSystem.url, CodeSystem.identifier, CodeSystem.version, CodeSystem.name, CodeSystem.title, CodeSystem.status, CodeSystem.experimental, CodeSystem.date, CodeSystem.publisher, CodeSystem.contact, CodeSystem.description, CodeSystem.useContext, CodeSystem.jurisdiction, CodeSystem.purpose, CodeSystem.copyright, CodeSystem.caseSensitive, CodeSystem.valueSet, CodeSystem.hierarchyMeaning, CodeSystem.compositional, CodeSystem.versionNeeded, CodeSystem.content, CodeSystem.supplements, CodeSystem.count, CodeSystem.filter, CodeSystem.filter.extension, CodeSystem.filter.modifierExtension, CodeSystem.filter.code, CodeSystem.filter.description, CodeSystem.filter.operator, CodeSystem.filter.operator.extension, CodeSystem.filter.operator.extension:operator, CodeSystem.filter.value, CodeSystem.property, CodeSystem.property.extension, CodeSystem.property.modifierExtension, CodeSystem.property.code, CodeSystem.property.uri, CodeSystem.property.description, CodeSystem.property.type, CodeSystem.concept, CodeSystem.concept.extension, CodeSystem.concept.modifierExtension, CodeSystem.concept.code, CodeSystem.concept.display, CodeSystem.concept.definition, CodeSystem.concept.designation, CodeSystem.concept.designation.extension, CodeSystem.concept.designation.extension:additionalUse, CodeSystem.concept.designation.modifierExtension, CodeSystem.concept.designation.language, CodeSystem.concept.designation.use, CodeSystem.concept.designation.value, CodeSystem.concept.property, CodeSystem.concept.property.extension, CodeSystem.concept.property.modifierExtension, CodeSystem.concept.property.code, CodeSystem.concept.property.value[x], CodeSystem.concept.concept All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CodeSystem.extension, CodeSystem.extension:versionAlgorithm, CodeSystem.extension:copyrightLabel, CodeSystem.extension:approvalDate, CodeSystem.extension:lastReviewDate, CodeSystem.extension:effectivePeriod, CodeSystem.extension:topic, CodeSystem.extension:author, CodeSystem.extension:editor, CodeSystem.extension:reviewer, CodeSystem.extension:endorser, CodeSystem.extension:relatedArtifact, CodeSystem.modifierExtension, CodeSystem.filter.extension, CodeSystem.filter.modifierExtension, CodeSystem.filter.operator.extension, CodeSystem.filter.operator.extension:operator, CodeSystem.property.extension, CodeSystem.property.modifierExtension, CodeSystem.concept.extension, CodeSystem.concept.modifierExtension, CodeSystem.concept.designation.extension, CodeSystem.concept.designation.extension:additionalUse, CodeSystem.concept.designation.modifierExtension, CodeSystem.concept.property.extension, CodeSystem.concept.property.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron