Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Patient Care Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Device, Patient, Practitioner

Detailed Descriptions for the elements in the Flag resource.

Flag
Element IdFlag
Definition

Prospective warnings of potential issues when providing care to the patient.

Short DisplayKey information to flag to healthcare providers
Cardinality0..*
TypeDomainResource
Alternate NamesBarriers to Care; Alert; Warning
Summaryfalse
Flag.identifier
Element IdFlag.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 DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows identification of the flag as it is known by various participating systems and in a way that remains consistent across servers.

Summarytrue
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 IdFlag.status
Definition

Supports basic workflow.

Short Displayactive | inactive | entered-in-error
Cardinality1..1
Terminology BindingFlagStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
Comments

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

Flag.category
Element IdFlag.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 DisplayClinical, administrative, etc.
Cardinality0..*
Terminology BindingFlag Category (Example)
TypeCodeableConcept
Summarytrue
Comments

The value set will often need to be adjusted based on local business rules and usage context.

Flag.code
Element IdFlag.code
Definition

The coded value or textual component of the flag to display to the user.

Short DisplayCoded or textual message to display to user
Cardinality1..1
Terminology BindingFlag Code (Example)
TypeCodeableConcept
Summarytrue
Comments

If non-coded, use CodeableConcept.text. This element should always be included in the narrative.

Flag.subject
Element IdFlag.subject
Definition

The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.

Short DisplayWho/What is flag about?
Cardinality1..1
TypeReference(Patient | Location | Group | Organization | Practitioner | PractitionerRole | PlanDefinition | Medication | Procedure)
Summarytrue
Flag.period
Element IdFlag.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 DisplayTime period when flag is active
Cardinality0..1
TypePeriod
Summarytrue
Flag.encounter
Element IdFlag.encounter
Definition

This alert is only relevant during the encounter.

Short DisplayAlert relevant during encounter
Cardinality0..1
TypeReference(Encounter)
Summarytrue
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 IdFlag.author
Definition

The person, organization or device that created the flag.

Short DisplayFlag creator
Cardinality0..1
TypeReference(Device | Organization | Patient | Practitioner | PractitionerRole)
Summarytrue