StructureDefinition-UKCore-Flag

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Flag1.2.02022-12-16

This profile defines the UK constraints and extensions on the International FHIR resource Flag.


Profile_Purpose

A flag is a warning or notification of some sort presented to the user - who may be a clinician or some other person involve in patient care. It usually represents something of sufficient significance to warrant a special display of some sort - rather than just a note in the resource. A flag has a subject representing the resource that will trigger its display.

This subject can be of different types, as described in the examples below:

  • A note that a patient has an overdue account, which the provider may wish to discuss with them - in case of hardship, for example (subject = Patient)
  • An outbreak of Ebola in a particular region (subject = Location) so that all patients from that region have a higher risk of having that condition
  • A particular provider is unavailable for referrals over a given period (subject = Practitioner)
  • A patient who is enrolled in a clinical trial (subject = Group)
  • Special guidance or caveats to be aware of when following a protocol (subject = PlanDefinition)
  • Warnings about using a drug in a formulary requires special approval (subject = Medication)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
categoryΣ0..*CodeableConcept
codeΣ1..1CodeableConcept
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
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
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

Table View

Flag..
Flag.identifier..
Flag.identifier.assignerReference(UK Core Organization)..
Flag.subjectReference(UK Core Location | UK Core Medication | UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core Procedure | Group | PlanDefinition)..
Flag.subject.identifier..
Flag.subject.identifier.assignerReference(UK Core Organization)..
Flag.encounterReference(UK Core Encounter)..
Flag.encounter.identifier..
Flag.encounter.identifier.assignerReference(UK Core Organization)..
Flag.authorReference(UK Core Device | UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole)..
Flag.author.identifier..
Flag.author.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Flag" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Flag" />
    <version value="1.2.0" />
    <name value="UKCoreFlag" />
    <title value="UK Core Flag" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Flag](https://hl7.org/fhir/R4/Flag.html)." />
    <purpose value="A flag is a warning or notification of some sort presented to the user - who may be a clinician or some other person involve in patient care. It usually represents something of sufficient significance to warrant a special display of some sort - rather than just a note in the resource. A flag has a subject representing the resource that will trigger its display.   \n\nThis subject can be of different types, as described in the examples below:   \n\n- A note that a patient has an overdue account, which the provider may wish to discuss with them - in case of hardship, for example (`subject = Patient`)   \n- An outbreak of Ebola in a particular region (`subject = Location`) so that all patients from that region have a higher risk of having that condition   \n- A particular provider is unavailable for referrals over a given period (`subject = Practitioner`)   \n- A patient who is enrolled in a clinical trial (`subject = Group`)   \n- Special guidance or caveats to be aware of when following a protocol (`subject = PlanDefinition`)   \n- Warnings about using a drug in a formulary requires special approval (`subject = Medication`)" />
    <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="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Flag" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Flag" />
    <derivation value="constraint" />
    <differential>
        <element id="Flag.identifier.assigner">
            <path value="Flag.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Flag.subject">
            <path value="Flag.subject" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <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-Procedure" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition" />
            </type>
        </element>
        <element id="Flag.subject.identifier.assigner">
            <path value="Flag.subject.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Flag.encounter">
            <path value="Flag.encounter" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" />
            </type>
        </element>
        <element id="Flag.encounter.identifier.assigner">
            <path value="Flag.encounter.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Flag.author">
            <path value="Flag.author" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <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" />
            </type>
        </element>
        <element id="Flag.author.identifier.assigner">
            <path value="Flag.author.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-Flag",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Flag",
    "version": "1.2.0",
    "name": "UKCoreFlag",
    "title": "UK Core Flag",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Flag](https://hl7.org/fhir/R4/Flag.html).",
    "purpose": "A flag is a warning or notification of some sort presented to the user - who may be a clinician or some other person involve in patient care. It usually represents something of sufficient significance to warrant a special display of some sort - rather than just a note in the resource. A flag has a subject representing the resource that will trigger its display.   \n\nThis subject can be of different types, as described in the examples below:   \n\n- A note that a patient has an overdue account, which the provider may wish to discuss with them - in case of hardship, for example (`subject = Patient`)   \n- An outbreak of Ebola in a particular region (`subject = Location`) so that all patients from that region have a higher risk of having that condition   \n- A particular provider is unavailable for referrals over a given period (`subject = Practitioner`)   \n- A patient who is enrolled in a clinical trial (`subject = Group`)   \n- Special guidance or caveats to be aware of when following a protocol (`subject = PlanDefinition`)   \n- Warnings about using a drug in a formulary requires special approval (`subject = Medication`)",
    "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": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Flag",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Flag",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Flag.identifier.assigner",
                "path": "Flag.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Flag.subject",
                "path": "Flag.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure",
                            "http://hl7.org/fhir/StructureDefinition/Group",
                            "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
                        ]
                    }
                ]
            },
            {
                "id": "Flag.subject.identifier.assigner",
                "path": "Flag.subject.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Flag.encounter",
                "path": "Flag.encounter",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter"
                        ]
                    }
                ]
            },
            {
                "id": "Flag.encounter.identifier.assigner",
                "path": "Flag.encounter.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Flag.author",
                "path": "Flag.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "Flag.author.identifier.assigner",
                "path": "Flag.author.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Food Allergy - An example to illustrate a flag regarding a food allergy.
Example UKCore-Flag-FoodAllergy

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:

Example Usage Scenarios

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

  • Query for flag information for a given Patient
  • Exchange flag information within a FHIR document or message.

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHALL support are the following elements.

Element Reason
Flag.status Supports basic workflow.
Flag.code The coded value or textual component of the flag to display to the user.
Flag.subject The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.

encounter

The resource being referenced SHALL conform to the Profile UKCore-Encounter.