StructureDefinition Extension-UKCore-CompositionReference

Canonical_URLDescriptionProfile_Purpose
http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition

This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.

This is a use case from Genomics to backport R5 functionality and align with HL7 EU laboratory IG.

Context of Use DiagnosticReport

Tree View

url1..1System.StringFixed Value
valueReferenceReference(UK Core Composition)

Table View

Extension..
Extension.url..
Extension.value[x]Reference(UK Core Composition)1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-CompositionReference" />
    <url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" />
    <version value="1.0.0" />
    <name value="ExtensionUKCoreCompositionReference" />
    <title value="Extension UK Core Composition Reference" />
    <status value="active" />
    <date value="2023-04-28" />
    <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="This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." />
    <purpose value="This is a use case from Genomics to backport R5 functionality and align with HL7 EU laboratory IG." />
    <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="DiagnosticReport" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="A Composition reference for a DiagnosticReport." />
            <definition value="A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="Reference to a Composition resource for the DiagnosticReport structure" />
            <definition value="The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report." />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-CompositionReference",
    "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition",
    "version": "1.0.0",
    "name": "ExtensionUKCoreCompositionReference",
    "title": "Extension UK Core Composition Reference",
    "status": "active",
    "date": "2023-04-28",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.",
    "purpose": "This is a use case from Genomics to backport R5 functionality and align with HL7 EU laboratory IG.",
    "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": "DiagnosticReport"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "A Composition reference for a DiagnosticReport.",
                "definition": "A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "Reference to a Composition resource for the DiagnosticReport structure",
                "definition": "The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Composition Reference - An example to illustrate the pre-adopted R5 element via an extension, which is used to send a composition resource with a diagnostic report.
Example UKCore-Extension-CompositionReference