UK Core Implementation Guide 0.3.0 STU1

StructureDefinition-UKCore-Composition

Defines the UK Core constraints and extensions on the Composition resource to enable a generic and flexible approach to FHIR document structures.

Profile Purpose

This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type="document", and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc..).

Snapshot View

careSettingTypeI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
typeΣ1..1CodeableConceptBinding
categoryΣ0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
dateΣ1..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
titleΣ1..1string
confidentialityΣ0..1codeBinding
mode1..1codeBinding
time0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(UK Core Composition)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
title0..1string
code0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Differential View

careSettingTypeI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
typeΣ1..1CodeableConceptBinding
categoryΣ0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
dateΣ1..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
titleΣ1..1string
confidentialityΣ0..1codeBinding
mode1..1codeBinding
time0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(UK Core Composition)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
title0..1string
code0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Hybrid View

careSettingTypeI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
typeΣ1..1CodeableConceptBinding
categoryΣ0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
dateΣ1..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
titleΣ1..1string
confidentialityΣ0..1codeBinding
mode1..1codeBinding
time0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(UK Core Composition)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
title0..1string
code0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Table View

Composition..
Composition.extension0..
Composition.extensionExtension0..1
Composition.identifier..
Composition.identifier.assignerReference(UK Core Organization)..
Composition.type..
Composition.category..
Composition.subject..
Composition.subject.identifier..
Composition.subject.identifier.assignerReference(UK Core Organization)..
Composition.encounterReference(UK Core Encounter)..
Composition.encounter.identifier..
Composition.encounter.identifier.assignerReference(UK Core Organization)..
Composition.authorReference(UK Core Practitioner | UK Core PractitionerRole | UK Core Patient | UK Core RelatedPerson | UK Core Organization | UK Core Device)..
Composition.author.identifier..
Composition.author.identifier.assignerReference(UK Core Organization)..
Composition.attester..
Composition.attester.partyReference(UK Core Patient | UK Core RelatedPerson | UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)..
Composition.attester.party.identifier..
Composition.attester.party.identifier.assignerReference(UK Core Organization)..
Composition.custodianReference(UK Core Organization)..
Composition.custodian.identifier..
Composition.custodian.identifier.assignerReference(UK Core Organization)..
Composition.relatesTo..
Composition.relatesTo.target[x]Identifier, Reference(UK Core Composition)..
Composition.event..
Composition.event.detail..
Composition.event.detail.identifier..
Composition.event.detail.identifier.assignerReference(UK Core Organization)..
Composition.section..
Composition.section.code..
Composition.section.authorReference(UK Core Practitioner | UK Core PractitionerRole | UK Core Patient | UK Core RelatedPerson | UK Core Organization | UK Core Device)..
Composition.section.author.identifier..
Composition.section.author.identifier.assignerReference(UK Core Organization)..
Composition.section.focus..
Composition.section.focus.identifier..
Composition.section.focus.identifier.assignerReference(UK Core Organization)..
Composition.section.entry..
Composition.section.entry.identifier..
Composition.section.entry.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Composition" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition" />
    <version value="2.1.0" />
    <name value="UKCoreComposition" />
    <title value="UK Core Composition" />
    <status value="active" />
    <date value="2022-01-07" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the Composition resource to enable a generic and flexible approach to FHIR document structures." />
    <purpose value="This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc." />
    <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="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="cda" />
        <uri value="http://hl7.org/v3/cda" />
        <name value="CDA (R2)" />
    </mapping>
    <mapping>
        <identity value="fhirdocumentreference" />
        <uri value="http://hl7.org/fhir/documentreference" />
        <name value="FHIR DocumentReference" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Composition" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Composition" />
    <derivation value="constraint" />
    <differential>
        <element id="Composition">
            <path value="Composition" />
            <definition value="A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc." />
        </element>
        <element id="Composition.extension">
            <path value="Composition.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Composition.extension:careSettingType">
            <path value="Composition.extension" />
            <sliceName value="careSettingType" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" />
            </type>
        </element>
        <element id="Composition.identifier.assigner">
            <path value="Composition.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.type">
            <path value="Composition.type" />
            <short value="Kind of composition (SNOMED CT)" />
            <binding>
                <strength value="extensible" />
                <description value="SNOMED CT Document Type" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType" />
            </binding>
        </element>
        <element id="Composition.category">
            <path value="Composition.category" />
            <definition value="A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.\nFurther investgation is required about the usage of this element for UK Core." />
            <binding>
                <strength value="preferred" />
                <description value="A ValueSet to identify the category of a composition." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionCategory" />
            </binding>
        </element>
        <element id="Composition.subject.identifier.assigner">
            <path value="Composition.subject.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.encounter">
            <path value="Composition.encounter" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" />
            </type>
        </element>
        <element id="Composition.encounter.identifier.assigner">
            <path value="Composition.encounter.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.author">
            <path value="Composition.author" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
            </type>
        </element>
        <element id="Composition.author.identifier.assigner">
            <path value="Composition.author.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.attester.party">
            <path value="Composition.attester.party" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.attester.party.identifier.assigner">
            <path value="Composition.attester.party.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.custodian">
            <path value="Composition.custodian" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.custodian.identifier.assigner">
            <path value="Composition.custodian.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.relatesTo.target[x]">
            <path value="Composition.relatesTo.target[x]" />
            <type>
                <code value="Identifier" />
            </type>
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition" />
            </type>
        </element>
        <element id="Composition.event.detail.identifier.assigner">
            <path value="Composition.event.detail.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.section.code">
            <path value="Composition.section.code" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionSectionCode" />
            </binding>
        </element>
        <element id="Composition.section.author">
            <path value="Composition.section.author" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
            </type>
        </element>
        <element id="Composition.section.author.identifier.assigner">
            <path value="Composition.section.author.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.section.focus.identifier.assigner">
            <path value="Composition.section.focus.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Composition.section.entry.identifier.assigner">
            <path value="Composition.section.entry.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Composition",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition",
    "version": "2.1.0",
    "name": "UKCoreComposition",
    "title": "UK Core Composition",
    "status": "active",
    "date": "2022-01-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the Composition resource to enable a generic and flexible approach to FHIR document structures.",
    "purpose": "This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc.",
    "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": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "cda",
            "uri": "http://hl7.org/v3/cda",
            "name": "CDA (R2)"
        },
        {
            "identity": "fhirdocumentreference",
            "uri": "http://hl7.org/fhir/documentreference",
            "name": "FHIR DocumentReference"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Composition",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Composition",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Composition",
                "path": "Composition",
                "definition": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc."
            },
            {
                "id": "Composition.extension",
                "path": "Composition.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Composition.extension:careSettingType",
                "path": "Composition.extension",
                "sliceName": "careSettingType",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.identifier.assigner",
                "path": "Composition.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.type",
                "path": "Composition.type",
                "short": "Kind of composition (SNOMED CT)",
                "binding": {
                    "strength": "extensible",
                    "description": "SNOMED CT Document Type",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType"
                }
            },
            {
                "id": "Composition.category",
                "path": "Composition.category",
                "definition": "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.\nFurther investgation is required about the usage of this element for UK Core.",
                "binding": {
                    "strength": "preferred",
                    "description": "A ValueSet to identify the category of a composition.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionCategory"
                }
            },
            {
                "id": "Composition.subject.identifier.assigner",
                "path": "Composition.subject.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.encounter",
                "path": "Composition.encounter",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.encounter.identifier.assigner",
                "path": "Composition.encounter.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.author",
                "path": "Composition.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.author.identifier.assigner",
                "path": "Composition.author.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.attester.party",
                "path": "Composition.attester.party",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.attester.party.identifier.assigner",
                "path": "Composition.attester.party.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.custodian",
                "path": "Composition.custodian",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.custodian.identifier.assigner",
                "path": "Composition.custodian.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.relatesTo.target[x]",
                "path": "Composition.relatesTo.target[x]",
                "type":  [
                    {
                        "code": "Identifier"
                    },
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.event.detail.identifier.assigner",
                "path": "Composition.event.detail.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.section.code",
                "path": "Composition.section.code",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionSectionCode"
                }
            },
            {
                "id": "Composition.section.author",
                "path": "Composition.section.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.section.author.identifier.assigner",
                "path": "Composition.section.author.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.section.focus.identifier.assigner",
                "path": "Composition.section.focus.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Composition.section.entry.identifier.assigner",
                "path": "Composition.section.entry.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Example Usage Scenarios

The following are example usage scenarios for the UK Core Composition profile:

  • Query for a specific patient document or document type
  • Query for recent patient documents
  • Create a new document or update an existing document

Profile specific implementation guidance:

extension:caresettingtype

More information about this extension can be found using the link below.

Extension UKCore-CareSettingType


identifier

A version-independent identifier for the Composition.

Provider Systems

It is recommended that the identifier value is a Universally Unique Identifier (UUID) as there is no nationally recognised business identifier for an instance of a recorded composition.

Consumer Systems

Consumer systems MUST consume this data.


status

The status of the document MUST be present and use a value from the CodeSystem below:

HTML View

This code system http://hl7.org/fhir/composition-status defines the following codes:

CodeDisplayDefinition
preliminaryPreliminaryThis is a preliminary composition or document (also known as initial or interim). The content may be incomplete or unverified.
finalFinalThis version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition.
amendedAmendedThe composition content or the referenced resources have been modified (edited or added to) subsequent to being released as "final" and the composition is complete and verified by an authorized person.
entered-in-errorEntered in ErrorThe composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid.

Table View

CodeSystem.id[0]composition-status
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]sd
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]3
CodeSystem.url[0]http://hl7.org/fhir/composition-status
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.242
CodeSystem.version[0]4.0.1
CodeSystem.name[0]CompositionStatus
CodeSystem.title[0]CompositionStatus
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The workflow/clinical status of the composition.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/composition-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]preliminary
CodeSystem.concept[0].display[0]Preliminary
CodeSystem.concept[0].definition[0]This is a preliminary composition or document (also known as initial or interim). The content may be incomplete or unverified.
CodeSystem.concept[1].code[0]final
CodeSystem.concept[1].display[0]Final
CodeSystem.concept[1].definition[0]This version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition.
CodeSystem.concept[2].code[0]amended
CodeSystem.concept[2].display[0]Amended
CodeSystem.concept[2].definition[0]The composition content or the referenced resources have been modified (edited or added to) subsequent to being released as "final" and the composition is complete and verified by an authorized person.
CodeSystem.concept[3].code[0]entered-in-error
CodeSystem.concept[3].display[0]Entered in Error
CodeSystem.concept[3].definition[0]The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="composition-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="sd" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="3" />
    </extension>
    <url value="http://hl7.org/fhir/composition-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.242" />
    </identifier>
    <version value="4.0.1" />
    <name value="CompositionStatus" />
    <title value="CompositionStatus" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The workflow/clinical status of the composition." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/composition-status" />
    <content value="complete" />
    <concept>
        <code value="preliminary" />
        <display value="Preliminary" />
        <definition value="This is a preliminary composition or document (also known as initial or interim). The content may be incomplete or unverified." />
    </concept>
    <concept>
        <code value="final" />
        <display value="Final" />
        <definition value="This version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition." />
    </concept>
    <concept>
        <code value="amended" />
        <display value="Amended" />
        <definition value="The composition content or the referenced resources have been modified (edited or added to) subsequent to being released as &quot;final&quot; and the composition is complete and verified by an authorized person." />
    </concept>
    <concept>
        <code value="entered-in-error" />
        <display value="Entered in Error" />
        <definition value="The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "composition-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "sd"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        }
    ],
    "url": "http://hl7.org/fhir/composition-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.242"
        }
    ],
    "version": "4.0.1",
    "name": "CompositionStatus",
    "title": "CompositionStatus",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The workflow/clinical status of the composition.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/composition-status",
    "content": "complete",
    "concept":  [
        {
            "code": "preliminary",
            "display": "Preliminary",
            "definition": "This is a preliminary composition or document (also known as initial or interim). The content may be incomplete or unverified."
        },
        {
            "code": "final",
            "display": "Final",
            "definition": "This version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition."
        },
        {
            "code": "amended",
            "display": "Amended",
            "definition": "The composition content or the referenced resources have been modified (edited or added to) subsequent to being released as \"final\" and the composition is complete and verified by an authorized person."
        },
        {
            "code": "entered-in-error",
            "display": "Entered in Error",
            "definition": "The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid."
        }
    ]
}

type

The type of document which MUST be present and should use a value from ValueSet UKCore-DocumentType.


category

A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. A binding to a ValueSet containing a set of SNOMED concepts has been suggested as a starting point for the UK Core (hence the "Preferred" binding strength): ValueSet UKCore-CompositionCategory.


subject

Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). Use in the UK is usually only with patient as the subject for documents using a reference.

The resource being referenced should conform to one of the following:


encounter

Describes the clinical encounter or type of care this documentation is associated with using a reference. The resource being referenced should conform to


date

The composition editing time, when the composition was last logically changed by the author. This element MUST be present.


author

Identifies who is responsible for the information in the composition, not necessarily who typed it in. This element MUST be present.


title

Official human-readable label for the composition. This element MUST be present and may be derived from the composition.type and composition.extension:caresettingtype.


confidentiality

The code specifying the level of confidentiality of the Composition. The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for this specification, and delegated to implementation profiles (see security section). This element is labelled as a modifier because highly confidential documents must not be treated as if they are not. As there is currently no national agreement on the use of this element it is not recommended for use in the UK.


attester

A participant who has attested to the accuracy of the composition/document.

Where the attester element is used the attester.mode is mandated.

The party who/ which is attesting to the document is done by reference. The resource being referenced should conform to one of the following:


custodian

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

The resource being referenced should conform to the following:


relatesTo

Relationships that this composition has with other compositions or documents that already exist. If used this MUST use a code from:

HTML View

This code system http://hl7.org/fhir/document-relationship-type defines the following codes:

CodeDisplayDefinition
replacesReplacesThis document logically replaces or supersedes the target document.
transformsTransformsThis document was generated by transforming the target document (e.g. format or language conversion).
signsSignsThis document is a signature of the target document.
appendsAppendsThis document adds additional information to the target document.

Table View

CodeSystem.id[0]document-relationship-type
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]sd
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]3
CodeSystem.url[0]http://hl7.org/fhir/document-relationship-type
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.245
CodeSystem.version[0]4.0.1
CodeSystem.name[0]DocumentRelationshipType
CodeSystem.title[0]DocumentRelationshipType
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The type of relationship between documents.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/document-relationship-type
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]replaces
CodeSystem.concept[0].display[0]Replaces
CodeSystem.concept[0].definition[0]This document logically replaces or supersedes the target document.
CodeSystem.concept[1].code[0]transforms
CodeSystem.concept[1].display[0]Transforms
CodeSystem.concept[1].definition[0]This document was generated by transforming the target document (e.g. format or language conversion).
CodeSystem.concept[2].code[0]signs
CodeSystem.concept[2].display[0]Signs
CodeSystem.concept[2].definition[0]This document is a signature of the target document.
CodeSystem.concept[3].code[0]appends
CodeSystem.concept[3].display[0]Appends
CodeSystem.concept[3].definition[0]This document adds additional information to the target document.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="document-relationship-type" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="sd" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="3" />
    </extension>
    <url value="http://hl7.org/fhir/document-relationship-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.245" />
    </identifier>
    <version value="4.0.1" />
    <name value="DocumentRelationshipType" />
    <title value="DocumentRelationshipType" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The type of relationship between documents." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/document-relationship-type" />
    <content value="complete" />
    <concept>
        <code value="replaces" />
        <display value="Replaces" />
        <definition value="This document logically replaces or supersedes the target document." />
    </concept>
    <concept>
        <code value="transforms" />
        <display value="Transforms" />
        <definition value="This document was generated by transforming the target document (e.g. format or language conversion)." />
    </concept>
    <concept>
        <code value="signs" />
        <display value="Signs" />
        <definition value="This document is a signature of the target document." />
    </concept>
    <concept>
        <code value="appends" />
        <display value="Appends" />
        <definition value="This document adds additional information to the target document." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "document-relationship-type",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "sd"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        }
    ],
    "url": "http://hl7.org/fhir/document-relationship-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.245"
        }
    ],
    "version": "4.0.1",
    "name": "DocumentRelationshipType",
    "title": "DocumentRelationshipType",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The type of relationship between documents.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/document-relationship-type",
    "content": "complete",
    "concept":  [
        {
            "code": "replaces",
            "display": "Replaces",
            "definition": "This document logically replaces or supersedes the target document."
        },
        {
            "code": "transforms",
            "display": "Transforms",
            "definition": "This document was generated by transforming the target document (e.g. format or language conversion)."
        },
        {
            "code": "signs",
            "display": "Signs",
            "definition": "This document is a signature of the target document."
        },
        {
            "code": "appends",
            "display": "Appends",
            "definition": "This document adds additional information to the target document."
        }
    ]
}

event

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

There is currently no UK Core defined set of values for events related to compositions.


section

The root of the sections that make up the composition. Section may be nested as required.

The following child elements should be used:

  • Composition.section.title The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
  • Composition.section.code A code identifying the kind of content contained within the section. This must be consistent with the section title. This should use a code from ValueSet UKCore-CompositionSectionCode.
  • Composition.section.text A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
  • Composition.section.entry A reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.
  • Composition.section.emptyReason If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Invariants that affect this element: cmp-2 Rule: A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()


back to top