StructureDefinition Extension-UKCore-CodingSCTDescDisplay

Context of Use Coding

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplayactive1.2.02023-12-07

The description display term for a SNOMED CT concept.

This extension SHALL be used with the HL7 core-defined extension coding-sctdescid to support the exchange of the selected description display term for a SNOMED CT concept, where the selected display term is different to the preferred term. The description display term associated with the ID within the coding-sctdescid extension is important to enable the representation of the exact term that was entered by the clinician that recorded the data, or the exact term that a legacy code e.g. a Read v2 code has been translated to using an assured mapping table.


Tree View

id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring

Detailed Descriptions

Extension
DefinitionTo record the SNOMED CT Description Display term actually selected
Cardinality0...1
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • v2: N/A
Extension.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Extension.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay

Mappings
  • rim: N/A
Extension.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A

Table View

Extension..1
Extension.url..
Extension.value[x]string1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-CodingSCTDescDisplay" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay" />
    <version value="1.2.0" />
    <name value="ExtensionUKCoreCodingSCTDescDisplay" />
    <title value="Extension UK Core Coding SCT Desc Display" />
    <status value="active" />
    <date value="2023-12-07" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="The description display term for a SNOMED CT concept." />
    <purpose value="This extension SHALL be used with the HL7 core-defined extension [coding-sctdescid](https://hl7.org/fhir/R4/extension-coding-sctdescid.html) to support the exchange of the selected description display term for a SNOMED CT concept, where the selected display term is different to the preferred term. \nThe description display term associated with the ID within the coding-sctdescid extension is important to enable the representation of the exact term that was entered by the clinician that recorded the data, or the exact term that a legacy code e.g. a Read v2 code has been translated to using an assured mapping table." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Coding" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="SNOMED CT Description ID" />
            <definition value="To record the SNOMED CT Description Display term actually selected" />
            <max value="1" />
            <mapping>
                <identity value="v2" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <min value="1" />
            <type>
                <code value="string" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-CodingSCTDescDisplay",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay",
    "version": "1.2.0",
    "name": "ExtensionUKCoreCodingSCTDescDisplay",
    "title": "Extension UK Core Coding SCT Desc Display",
    "status": "active",
    "date": "2023-12-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "The description display term for a SNOMED CT concept.",
    "purpose": "This extension SHALL be used with the HL7 core-defined extension [coding-sctdescid](https://hl7.org/fhir/R4/extension-coding-sctdescid.html) to support the exchange of the selected description display term for a SNOMED CT concept, where the selected display term is different to the preferred term. \nThe description display term associated with the ID within the coding-sctdescid extension is important to enable the representation of the exact term that was entered by the clinician that recorded the data, or the exact term that a legacy code e.g. a Read v2 code has been translated to using an assured mapping table.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Coding"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "SNOMED CT Description ID",
                "definition": "To record the SNOMED CT Description Display term actually selected",
                "max": "1",
                "mapping":  [
                    {
                        "identity": "v2",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    }
                ]
            }
        ]
    }
}

Feedback

Click here to:

Report issue for Extension-UKCore-CodingSCTDescDisplay, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

Coding SNOMED CT Description Id- An example to illustrate the extension of adding a SNOMED CT description Id and display Term.
Example UKCore-Extension-CodingSCTDescId

Extension Specific Guidance

This extension is used alongside the HL7 core-defined coding-sctdescid to support the exchange of the selected description display term for a SNOMED CT concept, where the selected display term is different to the preferred term. Specific guidance on the usage of this extension can be found within the CodeableConcept Guidance