UK Core Implementation Guide STU3 Sequence - Sprint 6 Review

StructureDefinition Extension-UKCore-DeathNotificationStatus

The patient's death notification status.

Purpose

This extension extends the Patient resource to support the exchange of the patient's death notification status, which is currently not supported by the FHIR standard.

Context of Use
Use on element Patient

Snapshot View

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueDateTimedateTime
url1..1System.StringFixed Value

Differential View

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueDateTimedateTime
url1..1System.StringFixed Value

Hybrid View

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueDateTimedateTime
url1..1System.StringFixed Value

Table View

Extension..1
Extension.extension..
Extension.extension1..1
Extension.extension.url..
Extension.extension.value[x]CodeableConcept1..
Extension.extension..1
Extension.extension.url..
Extension.extension.value[x]dateTime1..
Extension.url..
Extension.value[x]..0


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-DeathNotificationStatus" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" />
    <version value="2.1.0" />
    <name value="ExtensionUKCoreDeathNotificationStatus" />
    <title value="Extension UK Core Death Notification Status" />
    <status value="active" />
    <date value="2021-09-10" />
    <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 patient&#39;s death notification status." />
    <purpose value="This extension extends the Patient resource to support the exchange of the patient&#39;s death notification status, 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="Patient" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="The patient&#39;s death notification status." />
            <definition value="The patient&#39;s death notification status." />
            <max value="1" />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Extension.extension:deathNotificationStatus">
            <path value="Extension.extension" />
            <sliceName value="deathNotificationStatus" />
            <short value="The patient&#39;s death notification status." />
            <definition value="The patient&#39;s death notification status." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:deathNotificationStatus.url">
            <path value="Extension.extension.url" />
            <fixedUri value="deathNotificationStatus" />
        </element>
        <element id="Extension.extension:deathNotificationStatus.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="The patient&#39;s death notification status." />
            <definition value="The patient&#39;s death notification status." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DeathNotificationStatus" />
            </binding>
        </element>
        <element id="Extension.extension:systemEffectiveDate">
            <path value="Extension.extension" />
            <sliceName value="systemEffectiveDate" />
            <short value="System effective date for patient&#39;s death notification status." />
            <definition value="System effective date for patient&#39;s death notification status." />
            <max value="1" />
        </element>
        <element id="Extension.extension:systemEffectiveDate.url">
            <path value="Extension.extension.url" />
            <fixedUri value="systemEffectiveDate" />
        </element>
        <element id="Extension.extension:systemEffectiveDate.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="System effective date for patient&#39;s death notification status." />
            <definition value="System effective date for patient&#39;s death notification status." />
            <min value="1" />
            <type>
                <code value="dateTime" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-DeathNotificationStatus",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus",
    "version": "2.1.0",
    "name": "ExtensionUKCoreDeathNotificationStatus",
    "title": "Extension UK Core Death Notification Status",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "The patient's death notification status.",
    "purpose": "This extension extends the Patient resource to support the exchange of the patient's death notification status, 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": "Patient"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "The patient's death notification status.",
                "definition": "The patient's death notification status.",
                "max": "1"
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Extension.extension:deathNotificationStatus",
                "path": "Extension.extension",
                "sliceName": "deathNotificationStatus",
                "short": "The patient's death notification status.",
                "definition": "The patient's death notification status.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:deathNotificationStatus.url",
                "path": "Extension.extension.url",
                "fixedUri": "deathNotificationStatus"
            },
            {
                "id": "Extension.extension:deathNotificationStatus.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "The patient's death notification status.",
                "definition": "The patient's death notification status.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DeathNotificationStatus"
                }
            },
            {
                "id": "Extension.extension:systemEffectiveDate",
                "path": "Extension.extension",
                "sliceName": "systemEffectiveDate",
                "short": "System effective date for patient's death notification status.",
                "definition": "System effective date for patient's death notification status.",
                "max": "1"
            },
            {
                "id": "Extension.extension:systemEffectiveDate.url",
                "path": "Extension.extension.url",
                "fixedUri": "systemEffectiveDate"
            },
            {
                "id": "Extension.extension:systemEffectiveDate.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "System effective date for patient's death notification status.",
                "definition": "System effective date for patient's death notification status.",
                "min": 1,
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

Death notification Status- An example to illustrate the extension to indicate the death notification status of the patient.
Example UKCore-Patient-Extension-DeathNotificationStatus


back to top