Flag resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
Flag: Implementation Guidance
Usage
The Flag resource is used to carry information about a patient that is not a clinical assertion e.g. Scene Safety, transport requirements, accessibility requirements, patient preferences and reasonable adjustments.
Detailed implementation guidance for a Flag resource within the scope of this implementation guide is given below:
| Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
|---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | |
meta |
0..1 |
Meta | Metadata about the resource | |
implicitRules |
0..1 |
uri | A set of rules under which this content was created | |
language |
0..1 |
code | Language of the resource content. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | |
extension (basedOn) |
0..* |
Extension | An Extension to identify what a Flag is based on. This allows a history of the provenance to be carried. URL: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-UEC-FlagBasedOn-1 |
This MAY be populated. |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
identifier |
0..* |
Identifier | Business identifier | |
status |
1..1 |
code | active | inactive | entered-in-error FlagStatus (Required) |
|
category |
0..1 |
CodeableConcept | Clinical, administrative, etc. Flag Category (Example) |
|
code |
1..1 |
CodeableConcept | CodeableConcept Coded or textual message to display to user Flag Code (Example) |
|
subject |
1..1 |
Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? | This MUST be populated with 'Patient' |
period |
0..1 |
Period | Time period when flag is active | This MAY be populated |
start |
0..1 |
Period | Starting time with inclusive boundary | This MUST be populated. If the start period is not known it SHOULD be set to the start of the encounter. |
end |
0..1 |
Period | End time with inclusive boundary, if not ongoing | If the end period is known this SHOULD be populated. If not populated, then assumed to be in the future/open-ended |
encounter |
0..1 |
Reference(Encounter) | Alert relevant during encounter | This MUST be populated with the current Encounter reference. |
author |
0..1 |
Reference(Device | Organization | Patient | Practitioner) | Flag creator |
