This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
Patient Care Work Group | Maturity Level: 1 | Trial Use | Security Category: Patient | Compartments: Device, Patient, Practitioner |
Detailed Descriptions for the elements in the Flag resource.
Flag | |
Element Id | Flag |
Definition | Prospective warnings of potential issues when providing care to the patient. |
Short Display | Key information to flag to healthcare providers |
Cardinality | 0..* |
Type | DomainResource |
Alternate Names | Barriers to Care; Alert; Warning |
Summary | false |
Flag.identifier | |
Element Id | Flag.identifier |
Definition | Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Short Display | Business identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Allows identification of the flag as it is known by various participating systems and in a way that remains consistent across servers. |
Summary | true |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Flag.status | |
Element Id | Flag.status |
Definition | Supports basic workflow. |
Short Display | active | inactive | entered-in-error |
Cardinality | 1..1 |
Terminology Binding | Flag Status (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Summary | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Flag.category | |
Element Id | Flag.category |
Definition | Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. |
Short Display | Clinical, administrative, etc |
Cardinality | 0..* |
Terminology Binding | Flag Category (Example) |
Type | CodeableConcept |
Summary | true |
Comments | The value set will often need to be adjusted based on local business rules and usage context. |
Flag.code | |
Element Id | Flag.code |
Definition | The coded value or textual component of the flag to display to the user. |
Short Display | Coded or textual message to display to user |
Cardinality | 1..1 |
Terminology Binding | Flag Code (Example) |
Type | CodeableConcept |
Summary | true |
Comments | If non-coded, use CodeableConcept.text. This element should always be included in the narrative. |
Flag.subject | |
Element Id | Flag.subject |
Definition | The patient, related person, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
Short Display | Who/What is flag about? |
Cardinality | 1..1 |
Type | Reference(Patient | RelatedPerson | Location | Group | Organization | Practitioner | PractitionerRole | PlanDefinition | Medication | Procedure) |
Summary | true |
Flag.period | |
Element Id | Flag.period |
Definition | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. |
Short Display | Time period when flag is active |
Cardinality | 0..1 |
Type | Period |
Summary | true |
Flag.encounter | |
Element Id | Flag.encounter |
Definition | This alert is only relevant during the encounter. |
Short Display | Alert relevant during encounter |
Cardinality | 0..1 |
Type | Reference(Encounter) |
Summary | true |
Comments | If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end. |
Flag.author | |
Element Id | Flag.author |
Definition | The person, organization or device that created the flag. |
Short Display | Flag creator |
Cardinality | 0..1 |
Type | Reference(Device | Organization | Patient | RelatedPerson | Practitioner | PractitionerRole) |
Summary | true |
Flag.supportingInfo | |
Element Id | Flag.supportingInfo |
Definition | Additional information that may be relevant to the flag, such as why the flag was created or how to guide management of the flag. |
Short Display | Extra information to use in context of the flag |
Cardinality | 0..* |
Type | Reference(Condition | Procedure | AllergyIntolerance | Observation | RiskAssessment) |
Summary | false |
Comments | For example, when the flag represents an alert on difficulty in intubation, supportingInfo could reference details about previous incidents of intubation problems encountered. When the flag represents an alert on swallow or speech difficulty, supportingInfo could reference specific details about stroke or laryngeal carcinoma undergoing radiation therapy as primary or adjuvant therapy to surgery, or damage to recurrent laryngeal nerve from thyroid surgery or tumor. Flag.supportingInfo replaced the extension http://hl7.org/fhir/StructureDefinition/flag-detail in R6. In previous versions, using this extension is correct, not the R6 version extension. |