Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

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

Resource Profile: Profile_R4B_CodeSystem_R3

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

This cross-version profile allows R4B CodeSystem content to be represented via FHIR STU3 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 A set of codes drawn from one or more code systems
Constraints: 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
.... extension:supplements 0..1 uri R4B: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.supplements
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... content Σ 1..1 code not-present | example | fragment | complete
Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 code R4B: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.content
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 📍3.0.2 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique (concept.code | descendants().concept.code).isDistinct()
dom-1 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem 0..* CodeSystem A set of codes drawn from one or more code systems
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:supplements 0..1 uri R4B: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.supplements
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: Additional identifier for the code system (business identifier) additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.identifier
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.contact
... useContext
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.useContext
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 code R4B: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.content
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.
... property
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R4B: code | Coding | string | integer | boolean | dateTime | decimal
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.property.type
Binding: PropertyType (required): The type of a property value.
... concept
.... property
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 decimal R4B: value additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.concept.property.value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem A set of codes drawn from one or more code systems
Constraints: csd-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.meta
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 0..* uri 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: Common Tags (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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages 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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.text
.... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:supplements 0..1 uri R4B: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.supplements
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this code system (globally unique) (Coding.system)
... identifier Σ 0..1 Identifier Additional identifier for the code system
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: Additional identifier for the code system (business identifier) additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary (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 Σ 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 a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date this was 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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.contact
.... 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 Context the content is intended to support
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.useContext
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
... 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 uri Canonical URL for 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 post-composition grammar
... versionNeeded Σ 0..1 boolean If definitions are not stable
... content Σ 1..1 code not-present | example | fragment | complete
Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 code R4B: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.content
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.
.... value 0..1 code Primitive value for code
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 1..* code Operators that can be used with filter
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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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
Binding: PropertyType (required): The type of a property value
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R4B: code | Coding | string | integer | boolean | dateTime | decimal
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.property.type
Binding: PropertyType (required): The type of a property value.
..... value 0..1 code Primitive value for code
... concept 0..* BackboneElement Concepts in the code system
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... language 0..1 code Human language of the designation
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
..... use 0..1 Coding Details how this designation would be used
Binding: Designation Use (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 xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 decimal R4B: value additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.concept.property.value
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... 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
.... 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 All Security Labels 📍3.0.2 FHIR Std.
CodeSystem.meta.tag Base example Common Tags 📍3.0.2 FHIR Std.
CodeSystem.language Base extensible Common Languages 📍3.0.2 FHIR Std.
CodeSystem.text.status Base required NarrativeStatus 📍3.0.2 FHIR Std.
CodeSystem.identifier.​use Base required IdentifierUse 📍3.0.2 FHIR Std.
CodeSystem.identifier.​type Base extensible Identifier Type Codes 📍3.0.2 FHIR Std.
CodeSystem.status Base required PublicationStatus 📍3.0.2 FHIR Std.
CodeSystem.useContext.​code Base extensible UsageContextType 📍3.0.2 FHIR Std.
CodeSystem.useContext.​value[x] Base example Context of Use ValueSet 📍3.0.2 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
CodeSystem.hierarchyMeaning Base required CodeSystemHierarchyMeaning 📍3.0.2 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍3.0.2 FHIR Std.
CodeSystem.filter.operator Base required FilterOperator 📍3.0.2 FHIR Std.
CodeSystem.property.​type Base required PropertyType 📍3.0.2 FHIR Std.
CodeSystem.concept.designation.​language Base extensible Common Languages 📍3.0.2 FHIR Std.
CodeSystem.concept.designation.​use Base extensible Designation Use 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique (concept.code | descendants().concept.code).isDistinct()
dom-1 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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 A set of codes drawn from one or more code systems
Constraints: 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
.... extension:supplements 0..1 uri R4B: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.supplements
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... content Σ 1..1 code not-present | example | fragment | complete
Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 code R4B: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.content
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 📍3.0.2 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique (concept.code | descendants().concept.code).isDistinct()
dom-1 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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 A set of codes drawn from one or more code systems
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:supplements 0..1 uri R4B: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.supplements
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: Additional identifier for the code system (business identifier) additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.identifier
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.contact
... useContext
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.useContext
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 code R4B: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.content
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.
... property
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R4B: code | Coding | string | integer | boolean | dateTime | decimal
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.property.type
Binding: PropertyType (required): The type of a property value.
... concept
.... property
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 decimal R4B: value additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.concept.property.value

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem A set of codes drawn from one or more code systems
Constraints: csd-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.meta
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 0..* uri 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: Common Tags (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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages 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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.text
.... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:supplements 0..1 uri R4B: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.supplements
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this code system (globally unique) (Coding.system)
... identifier Σ 0..1 Identifier Additional identifier for the code system
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier R4B: Additional identifier for the code system (business identifier) additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary (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 Σ 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 a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date this was 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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.contact
.... 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 Context the content is intended to support
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.useContext
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
... 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 uri Canonical URL for 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 post-composition grammar
... versionNeeded Σ 0..1 boolean If definitions are not stable
... content Σ 1..1 code not-present | example | fragment | complete
Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 code R4B: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.content
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.
.... value 0..1 code Primitive value for code
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 1..* code Operators that can be used with filter
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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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
Binding: PropertyType (required): The type of a property value
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R4B: code | Coding | string | integer | boolean | dateTime | decimal
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.property.type
Binding: PropertyType (required): The type of a property value.
..... value 0..1 code Primitive value for code
... concept 0..* BackboneElement Concepts in the code system
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... language 0..1 code Human language of the designation
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
..... use 0..1 Coding Details how this designation would be used
Binding: Designation Use (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 xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 decimal R4B: value additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CodeSystem.concept.property.value
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... 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
.... 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 All Security Labels 📍3.0.2 FHIR Std.
CodeSystem.meta.tag Base example Common Tags 📍3.0.2 FHIR Std.
CodeSystem.language Base extensible Common Languages 📍3.0.2 FHIR Std.
CodeSystem.text.status Base required NarrativeStatus 📍3.0.2 FHIR Std.
CodeSystem.identifier.​use Base required IdentifierUse 📍3.0.2 FHIR Std.
CodeSystem.identifier.​type Base extensible Identifier Type Codes 📍3.0.2 FHIR Std.
CodeSystem.status Base required PublicationStatus 📍3.0.2 FHIR Std.
CodeSystem.useContext.​code Base extensible UsageContextType 📍3.0.2 FHIR Std.
CodeSystem.useContext.​value[x] Base example Context of Use ValueSet 📍3.0.2 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
CodeSystem.hierarchyMeaning Base required CodeSystemHierarchyMeaning 📍3.0.2 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍3.0.2 FHIR Std.
CodeSystem.filter.operator Base required FilterOperator 📍3.0.2 FHIR Std.
CodeSystem.property.​type Base required PropertyType 📍3.0.2 FHIR Std.
CodeSystem.concept.designation.​language Base extensible Common Languages 📍3.0.2 FHIR Std.
CodeSystem.concept.designation.​use Base extensible Designation Use 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique (concept.code | descendants().concept.code).isDistinct()
dom-1 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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