Flag
Introduction
Scope and Usage
A flag is a warning or notification of some sort presented to the user - who may be a clinician or some other person involved 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)
- etc.
A flag is typically presented as a label in a prominent location in the record to notify the clinician of the potential issues, though it may also appear in other contexts; e.g. notes applicable to a radiology technician, or to a clinician performing a home visit. For patients, the information in the flag will often be derived from the record, and therefore, for a thorough and careful clinician, who has the time to review the notes will be redundant. However, given the volume of information frequently found in patients' records and the potentially serious consequences of losing sight of some facts, this redundancy is deemed appropriate. As well, some flags may reflect information not captured by any other resource in the record. (E.g. "Patient has large dog at home")
In line with its purpose, a flag is concise, highlighting a small set of high-priority issues among the much larger set of data in the chart. Readers who want more detail should consult the chart or other source of information. Caution should be exercised in creating Flag instances. If entries are created for information that could be gleaned in a sufficiently timely fashion by reviewing the patient record, the flag list will itself become overwhelming and will cease to serve its intended purpose.
Flags are expected to persist in a record for some period of time and are, at most, targeted to particular types of practitioners or to practitioners in a particular system.
Examples of Patient related issues that might appear in flags:
- Risks to the patient (functional risk of falls, spousal restraining order, latex allergy)
- Patient's needs for special accommodations (hard of hearing, need for easy-open caps)
- Risks to providers (dog in house, patient may bite, infection control precautions)
- Administrative concerns (incomplete information, prepayment required due to credit risk)
Examples of issues that should not appear only in flags:
- Potential allergy or drug interaction to planned therapy (use DetectedIssue)
- Known adverse reaction to a substance (use AllergyIntolerance)
Note that we include "latex allergy" in the "in scope" list, and "allergy" in the "not in scope" list. The Flag resource is not designed to replace the normal order checking process, and one should not expect to see all allergies in Flags. However, if there is an activity that might occur prior to careful evaluation of the record (e.g. donning of latex gloves) and that activity might pose a risk to the patient, that is the sort of eventuality the Flag is intended to support.
Specific guidelines about what type of information is appropriate to expose using Flag, as well as what categories of individuals should see particular flags, will vary by interoperability community.
Boundaries and Relationships
Flags may highlight a highly condensed view of information found in the AllergyIntolerance, Condition, Observation, Procedure and possibly other resources. A common extension allows the linkage of a Flag to the supporting detail resource. The purpose of these other resources is to provide detailed clinical information. The purpose of a Flag is to alert practitioners to information that is important to influence their interaction with a Patient prior to detailed review of the record.
Flags are not used to convey information to a specific individual or organization (e.g. an abnormal lab result reported to the ordering clinician, reporting of an adverse reaction to a regulatory authority). These are handled using CommunicationRequest and Communication.
Flags are not raised as a result of a reported or proposed action (e.g. drug-drug interactions, duplicate therapy warnings). These are handled using DetectedIssue.
Flag is not used for alerts or alarm conditions detected and signaled by a patient-connected health/medical device. These are handled using DeviceAlert.
Notes
Notes
The Flag resource is sometimes used as "patient notes" and MAY be used to warn of issues such as:
- Issues that impact on the patient's ability to receive/respond to care the care provision process itself (e.g., poor language comprehension, low compliance expected)
- Issues that impact on the ability to provide care (e.g., patient has a big dog at home)
- Financial matters (e.g., patient is a bad debtor)
StructureDefinition
Elements (Simplified)
- Flag [0..*]: - Key information to flag to healthcare providers
- Flag.identifier [0..*]: Identifier Business identifier
- Flag.status [0..1]: code required:flag-status active | inactive | entered-in-error
- Flag.category [0..*]: CodeableConcept example:flag-category Clinical, administrative, etc
- Flag.code [1..1]: CodeableConcept example:flag-code Coded or textual message to display to user
- Flag.subject [1..1]: [Reference(Patient](/Reference(Patient), RelatedPerson, Location, Group, Organization, Practitioner, PractitionerRole, PlanDefinition, Medication, Procedure)) Who/What is flag about?
- Flag.period [0..1]: Period Time period when flag is active
- Flag.encounter [0..1]: Reference(Encounter) Alert relevant during encounter
- Flag.author [0..1]: [Reference(Device](/Reference(Device), Organization, Patient, RelatedPerson, Practitioner, PractitionerRole)) Flag creator
- Flag.supportingInfo [0..*]: [Reference(Condition](/Reference(Condition), Procedure, AllergyIntolerance, Observation, RiskAssessment)) Extra information to use in context of the flag
Mappings
- Flag Mappings — 16 mapping entries
Implementation Guide
implementationguide-Flag-core.xml
<?xml version="1.0" encoding="UTF-8"?>
<ImplementationGuide xmlns="http://hl7.org/fhir">
<id value="Flag-core"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.30.4"/>
</identifier>
<version value="0.1"/>
<name value="FlagHL7Extensions"/>
<title value="Flag H L7 Extensions"/>
<status value="draft"/>
<date value="2015-02-21T00:00:00.000"/>
<publisher value="Health Level Seven, Inc. - Patient Care WG"/>
<description value="Defines common extensions used with or related to the Flag resource"/>
</ImplementationGuide>
Resource Packs
list-Flag-packs.xml
<?xml version="1.0" encoding="UTF-8"?>
<List xmlns="http://hl7.org/fhir">
<id value="Flag-packs"/>
<status value="current"/>
<mode value="working"/>
<entry>
<item>
<reference value="ImplementationGuide/Flag-core"/>
</item>
</entry>
</List>
Search Parameters
- author — reference — Flag creator —
Flag.author - date — date — Time period when flag is active —
Flag.period - encounter — reference — Alert relevant during encounter —
Flag.encounter - identifier — token — Business identifier —
Flag.identifier - patient — reference — The identity of a subject to list flags for —
Flag.subject.where(resolve() is Patient) - status — token — active | inactive | entered-in-error —
Flag.status - subject — reference — The identity of a subject to list flags for —
Flag.subject - category — token — The category of the flag, such as clinical, administrative, etc. —
Flag.category
Examples
- clinical-trial-enrollment — flag-example-clinical-trial-enrollment — Clinical Trial Enrollment
- example — flag-example — Example of flag
- example-encounter — flag-example-encounter — Encounter Specific Alert
- flag-example — flag-example
- flag-example-clinical-trial-enrollment — flag-example-clinical-trial-enrollment
- flag-example-encounter — flag-example-encounter
- flag-example-medication — flag-example-medication
- flag-example-overdue-account — flag-example-overdue-account
- flag-example-protocol — flag-example-protocol
- flag-example-provider-unavailable — flag-example-provider-unavailable
- flag-examples-header — flag-examples-header
- medication — flag-example-medication — Medication
- overdue-account — flag-example-overdue-account — Overdue Account
- protocol — flag-example-protocol — Protocol
- provider-unavailable — flag-example-provider-unavailable — Provider Unavailable
Mapping Exceptions
flag-fivews-mapping-exceptions.xml
Unmapped Elements
- FiveWs.recorded — Unknown
- FiveWs.actor — Unknown
- FiveWs.cause — Unknown
- FiveWs.version — Unknown
- FiveWs.witness — Unknown
- FiveWs.where — Unknown
- FiveWs.init — Unknown
- FiveWs.why — Unknown
- FiveWs.source — Unknown
- FiveWs.who — Unknown
- FiveWs.grade — Unknown
- FiveWs.planned — Unknown
- FiveWs.done — Unknown