StructureDefinition Extension-UKCore-CopyCorrespondenceIndicator

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

Indicates that a Patient contact or RelatedPerson SHALL be copied in to Patient correspondence.

This extension extends the Patient and RelatedPerson resources, to support the exchange of information to indicate that a Patient contact or RelatedPerson SHALL be copied in to Patient correspondence.


Context of Use RelatedPerson
Patient.contact

Tree View

url1..1System.StringFixed Value
valueBooleanboolean

Table View

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


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-CopyCorrespondenceIndicator" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" />
    <version value="2.2.0" />
    <name value="ExtensionUKCoreCopyCorrespondenceIndicator" />
    <title value="Extension UK Core Copy Correspondence Indicator" />
    <status value="active" />
    <date value="2022-08-26" />
    <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="Indicates that a Patient contact or RelatedPerson SHALL be copied in to Patient correspondence." />
    <purpose value="This extension extends the Patient and RelatedPerson resources, to support the exchange of information to indicate that a Patient contact or RelatedPerson SHALL be copied in to Patient correspondence." />
    <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.contact" />
    </context>
    <context>
        <type value="element" />
        <expression value="RelatedPerson" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Indicator showing that a patient&#39;s contact or related person SHALL be copied in to patient correspondence" />
            <definition value="Extension carrying a boolean indicator showing that a patient&#39;s contact or related person SHALL be copied in to patient correspondence." />
            <max value="1" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="Copy Correspondence Indicator" />
            <definition value="Boolean element representing Copy Correspondence Indicator." />
            <min value="1" />
            <type>
                <code value="boolean" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-CopyCorrespondenceIndicator",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator",
    "version": "2.2.0",
    "name": "ExtensionUKCoreCopyCorrespondenceIndicator",
    "title": "Extension UK Core Copy Correspondence Indicator",
    "status": "active",
    "date": "2022-08-26",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Indicates that a Patient contact or RelatedPerson SHALL be copied in to Patient correspondence.",
    "purpose": "This extension extends the Patient and RelatedPerson resources, to support the exchange of information to indicate that a Patient contact or RelatedPerson SHALL be copied in to Patient correspondence.",
    "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.contact"
        },
        {
            "type": "element",
            "expression": "RelatedPerson"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence",
                "definition": "Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.",
                "max": "1"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "Copy Correspondence Indicator",
                "definition": "Boolean element representing Copy Correspondence Indicator.",
                "min": 1,
                "type":  [
                    {
                        "code": "boolean"
                    }
                ]
            }
        ]
    }
}

Examples

Copy Correspondence Indicator- This shows the extension that uses a Boolean value of true to indicate that the person named should be sent a copy of the correspondence.
Example UKCore-Extension-CopyCorrespondenceIndicator