UK Core Implementation Guide STU3 Sequence - Sprint 6 Review

StructureDefinition Extension-UKCore-ListWarningCode

An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.

Purpose

This extension extends the List Resource to support the exchange of information representing warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit, which is currently not supported by the FHIR standard.

Context of Use
Use on element List

Snapshot View

url1..1System.StringFixed Value
valueCodecode

Differential View

url1..1System.StringFixed Value
valueCodecode

Hybrid View

url1..1System.StringFixed Value
valueCodecode

Table View

Extension..
Extension.url..
Extension.value[x]code1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-ListWarningCode" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" />
    <version value="2.1.0" />
    <name value="ExtensionUKCoreListWarningCode" />
    <title value="Extension UK Core List Warning Code" />
    <status value="active" />
    <date value="2022-01-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="An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit." />
    <purpose value="This extension extends the List Resource to support the exchange of information representing warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit, which is currently not supported by the FHIR standard." />
    <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="List" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="To capture warnings that the list may be incomplete" />
            <definition value="To capture warnings that the list may be incomplete." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="To capture warnings that the list may be incomplete" />
            <definition value="To capture warnings that the list may be incomplete." />
            <min value="1" />
            <type>
                <code value="code" />
            </type>
            <binding>
                <strength value="extensible" />
                <description value="To identify the reason a list may be incomplete." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ListWarningCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-ListWarningCode",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode",
    "version": "2.1.0",
    "name": "ExtensionUKCoreListWarningCode",
    "title": "Extension UK Core List Warning Code",
    "status": "active",
    "date": "2022-01-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.",
    "purpose": "This extension extends the List Resource to support the exchange of information representing warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit, which is currently not supported by the FHIR standard.",
    "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": "List"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "To capture warnings that the list may be incomplete",
                "definition": "To capture warnings that the list may be incomplete."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "To capture warnings that the list may be incomplete",
                "definition": "To capture warnings that the list may be incomplete.",
                "min": 1,
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "description": "To identify the reason a list may be incomplete.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ListWarningCode"
                }
            }
        ]
    }
}

Examples

List Warning Code- An example to illustrate a warning being provided in a List resource.
Example UKCore-List-Extension-ListWarningCode


back to top