UK Core Implementation Guide 0.3.0 STU1

StructureDefinition-UKCore-List

Defines the UK Core constraints and extensions on the List resource for the minimal set of data to query and retrieve a list of information.

Profile Purpose

This profile allows exchange of a flat, possibly ordered collection of records. The list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. The list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Conditions, AllergyIntolerances, recent Procedures, etc.).

Snapshot View

careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
modeΣ ?!1..1codeBinding
titleΣ0..1string
codeΣ0..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
dateΣ0..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
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..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
emptyReasonI0..1CodeableConceptBinding

Differential View

careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
modeΣ ?!1..1codeBinding
titleΣ0..1string
codeΣ0..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
dateΣ0..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
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..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
emptyReasonI0..1CodeableConceptBinding

Hybrid View

careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
modeΣ ?!1..1codeBinding
titleΣ0..1string
codeΣ0..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
dateΣ0..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
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..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
emptyReasonI0..1CodeableConceptBinding

Table View

List..
List.extension0..
List.extensionExtension0..1
List.extensionExtension0..
List.extensionExtension0..1
List.identifier..
List.identifier.assignerReference(UK Core Organization)..
List.code..
List.subjectReference(Group | UK Core Patient | UK Core Location | UK Core Device)..
List.subject.identifier..
List.subject.identifier.assignerReference(UK Core Organization)..
List.encounterReference(UK Core Encounter)..
List.encounter.identifier..
List.encounter.identifier.assignerReference(UK Core Organization)..
List.sourceReference(UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core Device)..
List.source.identifier..
List.source.identifier.assignerReference(UK Core Organization)..
List.note..
List.note.author[x]Reference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson), string..
List.entry..
List.entry.item..
List.entry.item.identifier..
List.entry.item.identifier.assignerReference(UK Core Organization)..
List.emptyReason..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-List" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" />
    <version value="2.1.0" />
    <name value="UKCoreList" />
    <title value="UK Core List" />
    <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 List resource for the minimal set of data to query and retrieve a list of information." />
    <purpose value="This profile allows exchange of a flat, possibly ordered collection of records. The list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. The list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Conditions, AllergyIntolerances, recent Procedures, 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="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </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="List" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/List" />
    <derivation value="constraint" />
    <differential>
        <element id="List.extension">
            <path value="List.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="List.extension:careSettingType">
            <path value="List.extension" />
            <sliceName value="careSettingType" />
            <short value="An extension to carry the Care setting type." />
            <definition value="An extension to carry the Care setting type." />
            <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="List.extension:listWarningCode">
            <path value="List.extension" />
            <sliceName value="listWarningCode" />
            <short value="To capture warnings that the list may be incomplete." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" />
            </type>
        </element>
        <element id="List.extension:relatedProblemHeader">
            <path value="List.extension" />
            <sliceName value="relatedProblemHeader" />
            <short value="A reference to another related problem header condition (target) whose relationship is defined by the relationship type code." />
            <definition value="A reference to another related problem header condition (target) whose relationship is defined by the relationship type code." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RelatedProblemHeader" />
            </type>
        </element>
        <element id="List.identifier.assigner">
            <path value="List.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="List.code">
            <path value="List.code" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ListCode" />
            </binding>
        </element>
        <element id="List.subject">
            <path value="List.subject" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
            </type>
        </element>
        <element id="List.subject.identifier.assigner">
            <path value="List.subject.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="List.encounter">
            <path value="List.encounter" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" />
            </type>
        </element>
        <element id="List.encounter.identifier.assigner">
            <path value="List.encounter.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="List.source">
            <path value="List.source" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <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-Device" />
            </type>
        </element>
        <element id="List.source.identifier.assigner">
            <path value="List.source.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="List.note.author[x]">
            <path value="List.note.author[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
            <type>
                <code value="string" />
            </type>
        </element>
        <element id="List.entry.item.identifier.assigner">
            <path value="List.entry.item.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="List.emptyReason">
            <path value="List.emptyReason" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ListEmptyReasonCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-List",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List",
    "version": "2.1.0",
    "name": "UKCoreList",
    "title": "UK Core List",
    "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 List resource for the minimal set of data to query and retrieve a list of information.",
    "purpose": "This profile allows exchange of a flat, possibly ordered collection of records. The list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. The list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Conditions, AllergyIntolerances, recent Procedures, 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": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "List",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/List",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "List.extension",
                "path": "List.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "List.extension:careSettingType",
                "path": "List.extension",
                "sliceName": "careSettingType",
                "short": "An extension to carry the Care setting type.",
                "definition": "An extension to carry the Care setting type.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType"
                        ]
                    }
                ]
            },
            {
                "id": "List.extension:listWarningCode",
                "path": "List.extension",
                "sliceName": "listWarningCode",
                "short": "To capture warnings that the list may be incomplete.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode"
                        ]
                    }
                ]
            },
            {
                "id": "List.extension:relatedProblemHeader",
                "path": "List.extension",
                "sliceName": "relatedProblemHeader",
                "short": "A reference to another related problem header condition (target) whose relationship is defined by the relationship type code.",
                "definition": "A reference to another related problem header condition (target) whose relationship is defined by the relationship type code.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RelatedProblemHeader"
                        ]
                    }
                ]
            },
            {
                "id": "List.identifier.assigner",
                "path": "List.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "List.code",
                "path": "List.code",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ListCode"
                }
            },
            {
                "id": "List.subject",
                "path": "List.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Group",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "List.subject.identifier.assigner",
                "path": "List.subject.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "List.encounter",
                "path": "List.encounter",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter"
                        ]
                    }
                ]
            },
            {
                "id": "List.encounter.identifier.assigner",
                "path": "List.encounter.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "List.source",
                "path": "List.source",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "List.source.identifier.assigner",
                "path": "List.source.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "List.note.author[x]",
                "path": "List.note.author[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    },
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "List.entry.item.identifier.assigner",
                "path": "List.entry.item.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "List.emptyReason",
                "path": "List.emptyReason",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ListEmptyReasonCode"
                }
            }
        ]
    }
}

Examples

This example shows the use of an empty List to indicate that there is no content. This is not supposed to represent actual system behavior.

Example UKCore-List-EmptyList

This example is an example FHIR Bundle that could be returned following a query for the allergies for a patient. Note: the use of List and Bundle is not mandated and is used to illustrate a possible use of the List Profile and is not expected system behaviour.

Example UKCore-Bundle-BundledAllergyList

Example Usage Scenarios

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

  • A list of allergies for a Patient
  • A list of current medication for a Patient
  • Record or update a list of information for Patient

Profile specific implementation guidance:

extension:caresettingtype

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

Extension UKCore-CareSettingType


extension:listwarningcode

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

Extension UKCore-ListWarningCode


identifier

Business Identifier(s) relevant for this List.

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 List.

Consumer Systems

Consumer systems MUST consume this data.


status

A code to indicate the status of the List.

This element must be present and use a value from the CodeSystem below:

HTML View

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

CodeDisplayDefinition
currentCurrentThe list is considered to be an active part of the patient's record.
retiredRetiredThe list is "old" and should no longer be considered accurate or relevant.
entered-in-errorEntered In ErrorThe list was never accurate. It is retained for medico-legal purposes only.

Table View

CodeSystem.id[0]list-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]fhir
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]1
CodeSystem.url[0]http://hl7.org/fhir/list-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.327
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ListStatus
CodeSystem.title[0]ListStatus
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 current state of the list.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/list-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]current
CodeSystem.concept[0].display[0]Current
CodeSystem.concept[0].definition[0]The list is considered to be an active part of the patient's record.
CodeSystem.concept[1].code[0]retired
CodeSystem.concept[1].display[0]Retired
CodeSystem.concept[1].definition[0]The list is "old" and should no longer be considered accurate or relevant.
CodeSystem.concept[2].code[0]entered-in-error
CodeSystem.concept[2].display[0]Entered In Error
CodeSystem.concept[2].definition[0]The list was never accurate. It is retained for medico-legal purposes only.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="list-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </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="1" />
    </extension>
    <url value="http://hl7.org/fhir/list-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.327" />
    </identifier>
    <version value="4.0.1" />
    <name value="ListStatus" />
    <title value="ListStatus" />
    <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 current state of the list." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/list-status" />
    <content value="complete" />
    <concept>
        <code value="current" />
        <display value="Current" />
        <definition value="The list is considered to be an active part of the patient&#39;s record." />
    </concept>
    <concept>
        <code value="retired" />
        <display value="Retired" />
        <definition value="The list is &quot;old&quot; and should no longer be considered accurate or relevant." />
    </concept>
    <concept>
        <code value="entered-in-error" />
        <display value="Entered In Error" />
        <definition value="The list was never accurate.  It is retained for medico-legal purposes only." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "list-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://hl7.org/fhir/list-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.327"
        }
    ],
    "version": "4.0.1",
    "name": "ListStatus",
    "title": "ListStatus",
    "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 current state of the list.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/list-status",
    "content": "complete",
    "concept":  [
        {
            "code": "current",
            "display": "Current",
            "definition": "The list is considered to be an active part of the patient's record."
        },
        {
            "code": "retired",
            "display": "Retired",
            "definition": "The list is \"old\" and should no longer be considered accurate or relevant."
        },
        {
            "code": "entered-in-error",
            "display": "Entered In Error",
            "definition": "The list was never accurate.  It is retained for medico-legal purposes only."
        }
    ]
}

This element is labelled as a modifier because the status contains codes that mark the resource as not currently valid.


mode

How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

This element must be present and use a value from the CodeSystem below:

HTML View

This code system http://hl7.org/fhir/list-mode defines the following codes:

CodeDisplayDefinition
workingWorking ListThis list is the master list, maintained in an ongoing fashion with regular updates as the real world list it is tracking changes.
snapshotSnapshot ListThis list was prepared as a snapshot. It should not be assumed to be current.
changesChange ListA point-in-time list that shows what changes have been made or recommended. E.g. a discharge medication list showing what was added and removed during an encounter.

Table View

CodeSystem.id[0]list-mode
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]2
CodeSystem.url[0]http://hl7.org/fhir/list-mode
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.319
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ListMode
CodeSystem.title[0]ListMode
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 processing mode that applies to this list.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/list-mode
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]working
CodeSystem.concept[0].display[0]Working List
CodeSystem.concept[0].definition[0]This list is the master list, maintained in an ongoing fashion with regular updates as the real world list it is tracking changes.
CodeSystem.concept[1].code[0]snapshot
CodeSystem.concept[1].display[0]Snapshot List
CodeSystem.concept[1].definition[0]This list was prepared as a snapshot. It should not be assumed to be current.
CodeSystem.concept[2].code[0]changes
CodeSystem.concept[2].display[0]Change List
CodeSystem.concept[2].definition[0]A point-in-time list that shows what changes have been made or recommended. E.g. a discharge medication list showing what was added and removed during an encounter.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="list-mode" />
    <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="2" />
    </extension>
    <url value="http://hl7.org/fhir/list-mode" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.319" />
    </identifier>
    <version value="4.0.1" />
    <name value="ListMode" />
    <title value="ListMode" />
    <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 processing mode that applies to this list." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/list-mode" />
    <content value="complete" />
    <concept>
        <code value="working" />
        <display value="Working List" />
        <definition value="This list is the master list, maintained in an ongoing fashion with regular updates as the real world list it is tracking changes." />
    </concept>
    <concept>
        <code value="snapshot" />
        <display value="Snapshot List" />
        <definition value="This list was prepared as a snapshot. It should not be assumed to be current." />
    </concept>
    <concept>
        <code value="changes" />
        <display value="Change List" />
        <definition value="A point-in-time list that shows what changes have been made or recommended.  E.g. a discharge medication list showing what was added and removed during an encounter." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "list-mode",
    "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": 2
        }
    ],
    "url": "http://hl7.org/fhir/list-mode",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.319"
        }
    ],
    "version": "4.0.1",
    "name": "ListMode",
    "title": "ListMode",
    "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 processing mode that applies to this list.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/list-mode",
    "content": "complete",
    "concept":  [
        {
            "code": "working",
            "display": "Working List",
            "definition": "This list is the master list, maintained in an ongoing fashion with regular updates as the real world list it is tracking changes."
        },
        {
            "code": "snapshot",
            "display": "Snapshot List",
            "definition": "This list was prepared as a snapshot. It should not be assumed to be current."
        },
        {
            "code": "changes",
            "display": "Change List",
            "definition": "A point-in-time list that shows what changes have been made or recommended.  E.g. a discharge medication list showing what was added and removed during an encounter."
        }
    ]
}

title

A label for the list assigned by the author.


code

This code defines the purpose of the list - why it was created. This should use a code from ValueSet UKCore-ListCode if possible.


subject

The common subject (or patient) of the resources that are in the list if there is one. The resource being referenced should conform to the following:


encounter

The encounter that is the context in which this list was created. The resource being referenced should conform to the following:


date

The date that the list was prepared.


source

The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. The resource being referenced should conform to the following:


orderedBy

What order applies to the items in the list.


note

Comments that apply to the overall list.


entry

Entries in this list by reference to any FHIR resource where a UK Core profile exists the resource being referenced should conform to the profile. If there are no entries in the list, an emptyReason should be provided

Invariants affect this element

  • lst-1 Rule A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()

emptyReason

If the list is empty, why the list is empty.

This should use a code from ValueSet UkCore-ListEmptyReasonCode if possible.


back to top