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

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

Resource Profile: Profile_R2_ValueSet_R4_CodeSystem

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

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:extensible 0..1 boolean DSTU2: Whether this is intended to be used with an extensible binding (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.extensible
Constraints: ext-1
.... extension:codeSystem 0..1 (Complex) DSTU2: An inline code system, which is part of this value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem
Constraints: ext-1
.... extension:concept 1..* (Complex) DSTU2: Concepts in the code system (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:concept 0..* (Complex) DSTU2: Child Concepts (is-a/contains/categorizes) (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:import 0..* uri DSTU2: Import the contents of another value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.compose.import
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:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, 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:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, 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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: Metadata about the resource additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: Text summary of the resource, for human interpretation additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.text
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extensible 0..1 boolean DSTU2: Whether this is intended to be used with an extensible binding (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.extensible
.... extension:codeSystem 0..1 (Complex) DSTU2: An inline code system, which is part of this value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem
.... extension:concept 1..* (Complex) DSTU2: Concepts in the code system (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
.... extension:concept 0..* (Complex) DSTU2: Child Concepts (is-a/contains/categorizes) (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
.... extension:import 0..* uri DSTU2: Import the contents of another value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.compose.import
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier DSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.identifier
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string DSTU2: Name of an individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.name
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.telecom

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
.... 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:meta 0..1 Meta DSTU2: Metadata about the resource additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
.... 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:text 0..1 (Complex) DSTU2: Text summary of the resource, for human interpretation additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:extensible 0..1 boolean DSTU2: Whether this is intended to be used with an extensible binding (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.extensible
Constraints: ext-1
.... extension:codeSystem 0..1 (Complex) DSTU2: An inline code system, which is part of this value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem
Constraints: ext-1
.... extension:concept 1..* (Complex) DSTU2: Concepts in the code system (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:concept 0..* (Complex) DSTU2: Child Concepts (is-a/contains/categorizes) (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:import 0..* uri DSTU2: Import the contents of another value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.compose.import
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)
.... 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:identifier 0..1 Identifier DSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.identifier
Constraints: ext-1
.... 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 Σ 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
.... 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:name 0..1 string DSTU2: Name of an individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.name
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.telecom
Constraints: ext-1
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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.
.... 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
..... 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
..... 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.meta.security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
CodeSystem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CodeSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CodeSystem.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
CodeSystem.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CodeSystem.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 FHIR Std.
CodeSystem.property.​type Base required PropertyType 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
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.meta.extension, CodeSystem.meta.extension:meta, CodeSystem.meta.versionId, CodeSystem.meta.lastUpdated, CodeSystem.meta.source, CodeSystem.meta.profile, CodeSystem.meta.security, CodeSystem.meta.tag, CodeSystem.implicitRules, CodeSystem.language, CodeSystem.text, CodeSystem.text.extension, CodeSystem.text.extension:text, CodeSystem.text.status, CodeSystem.text.div, CodeSystem.extension, CodeSystem.extension:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, CodeSystem.modifierExtension, CodeSystem.url, CodeSystem.identifier, CodeSystem.identifier.extension, CodeSystem.identifier.extension:identifier, CodeSystem.identifier.use, CodeSystem.identifier.type, CodeSystem.identifier.system, CodeSystem.identifier.value, CodeSystem.identifier.period, CodeSystem.identifier.assigner, CodeSystem.version, CodeSystem.name, CodeSystem.title, CodeSystem.status, CodeSystem.experimental, CodeSystem.date, CodeSystem.publisher, CodeSystem.contact, CodeSystem.contact.extension, CodeSystem.contact.extension:name, CodeSystem.contact.extension:telecom, CodeSystem.contact.name, CodeSystem.contact.telecom, 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.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.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.meta.extension, CodeSystem.meta.extension:meta, CodeSystem.text.extension, CodeSystem.text.extension:text, CodeSystem.extension, CodeSystem.extension:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, CodeSystem.modifierExtension, CodeSystem.identifier.extension, CodeSystem.identifier.extension:identifier, CodeSystem.contact.extension, CodeSystem.contact.extension:name, CodeSystem.contact.extension:telecom, CodeSystem.filter.extension, CodeSystem.filter.modifierExtension, CodeSystem.property.extension, CodeSystem.property.modifierExtension, CodeSystem.concept.extension, CodeSystem.concept.modifierExtension, CodeSystem.concept.designation.extension, 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()
txt-1 error CodeSystem.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error CodeSystem.text.div The narrative SHALL have some non-whitespace content htmlChecks()

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 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:extensible 0..1 boolean DSTU2: Whether this is intended to be used with an extensible binding (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.extensible
Constraints: ext-1
.... extension:codeSystem 0..1 (Complex) DSTU2: An inline code system, which is part of this value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem
Constraints: ext-1
.... extension:concept 1..* (Complex) DSTU2: Concepts in the code system (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:concept 0..* (Complex) DSTU2: Child Concepts (is-a/contains/categorizes) (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:import 0..* uri DSTU2: Import the contents of another value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.compose.import
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:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, 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:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, 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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: Metadata about the resource additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: Text summary of the resource, for human interpretation additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.text
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extensible 0..1 boolean DSTU2: Whether this is intended to be used with an extensible binding (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.extensible
.... extension:codeSystem 0..1 (Complex) DSTU2: An inline code system, which is part of this value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem
.... extension:concept 1..* (Complex) DSTU2: Concepts in the code system (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
.... extension:concept 0..* (Complex) DSTU2: Child Concepts (is-a/contains/categorizes) (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
.... extension:import 0..* uri DSTU2: Import the contents of another value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.compose.import
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier DSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.identifier
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string DSTU2: Name of an individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.name
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.telecom

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
.... 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:meta 0..1 Meta DSTU2: Metadata about the resource additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
.... 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:text 0..1 (Complex) DSTU2: Text summary of the resource, for human interpretation additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:extensible 0..1 boolean DSTU2: Whether this is intended to be used with an extensible binding (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.extensible
Constraints: ext-1
.... extension:codeSystem 0..1 (Complex) DSTU2: An inline code system, which is part of this value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem
Constraints: ext-1
.... extension:concept 1..* (Complex) DSTU2: Concepts in the code system (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:concept 0..* (Complex) DSTU2: Child Concepts (is-a/contains/categorizes) (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.codeSystem.concept
Constraints: ext-1
.... extension:import 0..* uri DSTU2: Import the contents of another value set (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.compose.import
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)
.... 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:identifier 0..1 Identifier DSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.identifier
Constraints: ext-1
.... 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 Σ 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
.... 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:name 0..1 string DSTU2: Name of an individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.name
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ValueSet.contact.telecom
Constraints: ext-1
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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.
.... 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
..... 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
..... 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.meta.security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
CodeSystem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CodeSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CodeSystem.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
CodeSystem.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CodeSystem.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 FHIR Std.
CodeSystem.property.​type Base required PropertyType 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
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.meta.extension, CodeSystem.meta.extension:meta, CodeSystem.meta.versionId, CodeSystem.meta.lastUpdated, CodeSystem.meta.source, CodeSystem.meta.profile, CodeSystem.meta.security, CodeSystem.meta.tag, CodeSystem.implicitRules, CodeSystem.language, CodeSystem.text, CodeSystem.text.extension, CodeSystem.text.extension:text, CodeSystem.text.status, CodeSystem.text.div, CodeSystem.extension, CodeSystem.extension:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, CodeSystem.modifierExtension, CodeSystem.url, CodeSystem.identifier, CodeSystem.identifier.extension, CodeSystem.identifier.extension:identifier, CodeSystem.identifier.use, CodeSystem.identifier.type, CodeSystem.identifier.system, CodeSystem.identifier.value, CodeSystem.identifier.period, CodeSystem.identifier.assigner, CodeSystem.version, CodeSystem.name, CodeSystem.title, CodeSystem.status, CodeSystem.experimental, CodeSystem.date, CodeSystem.publisher, CodeSystem.contact, CodeSystem.contact.extension, CodeSystem.contact.extension:name, CodeSystem.contact.extension:telecom, CodeSystem.contact.name, CodeSystem.contact.telecom, 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.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.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.meta.extension, CodeSystem.meta.extension:meta, CodeSystem.text.extension, CodeSystem.text.extension:text, CodeSystem.extension, CodeSystem.extension:extensible, CodeSystem.extension:codeSystem, CodeSystem.extension:concept, CodeSystem.extension:concept, CodeSystem.extension:import, CodeSystem.modifierExtension, CodeSystem.identifier.extension, CodeSystem.identifier.extension:identifier, CodeSystem.contact.extension, CodeSystem.contact.extension:name, CodeSystem.contact.extension:telecom, CodeSystem.filter.extension, CodeSystem.filter.modifierExtension, CodeSystem.property.extension, CodeSystem.property.modifierExtension, CodeSystem.concept.extension, CodeSystem.concept.modifierExtension, CodeSystem.concept.designation.extension, 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()
txt-1 error CodeSystem.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error CodeSystem.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron