HL7 Europe Base and Core FHIR IG
2.0.0-ballot - ballot 150

HL7 Europe Base and Core FHIR IG - Downloaded Version 2.0.0-ballot See the Directory of published versions

## Resource Profile: Flag (EU core)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/flag-eu-core | Version: 2.0.0-ballot
Active as of 2025-12-19 | Computable Name: FlagEuCore
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile defines the core constraints and extensions for a Flag resource when used in European systems for communicating warnings, alerts, or reminders about important health information.

Usages:

- Examples for this Profile: Flag/flag-eu-core-example

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
extension:flagPriorityExt |  | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
extension:note |  | 0..* | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Alert bussiness Identifier
status | ?!Σ | 1..1 | code | Alert status Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject | Σ | 1..1 | Reference(Patient (EU core)) | Who/What is flag about?
period | Σ | 0..1 | Period | Time period when the alert is active
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Flag.status | Base | required | Flag Status | 📍5.0.0 | FHIR Std.
Flag.code | Base | example | Flag Code | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Flag | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Flag

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
extension:flagPriorityExt |  | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
extension:note |  | 0..* | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
identifier |  | 0..* | Identifier | Alert bussiness Identifier
status |  | 1..1 | code | Alert status
code |  | 1..1 | CodeableConcept | Coded or textual message to display to user.
subject |  | 1..1 | Reference(Patient (EU core)) | Who/What is flag about?
period |  | 0..1 | Period | Time period when the alert is active
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
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 Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
extension:flagPriorityExt |  | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
extension:note |  | 0..* | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Alert bussiness Identifier
status | ?!Σ | 1..1 | code | Alert status Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.
category | Σ | 0..* | CodeableConcept | Clinical, administrative, etc Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject | Σ | 1..1 | Reference(Patient (EU core)) | Who/What is flag about?
period | Σ | 0..1 | Period | Time period when the alert is active
encounter | Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter
author | Σ | 0..1 | Reference(Device | Organization | Patient | RelatedPerson | Practitioner | PractitionerRole) | Flag creator
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Flag.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
Flag.status | Base | required | Flag Status | 📍5.0.0 | FHIR Std.
Flag.category | Base | example | Flag Category | 📍5.0.0 | FHIR Std.
Flag.code | Base | example | Flag Code | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Flag | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Flag

Summary

Structures

This structure refers to these other structures:

- Patient (EU core) (http://hl7.eu/fhir/base-r5/StructureDefinition/patient-eu-core)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/flag-detail
- http://hl7.org/fhir/StructureDefinition/flag-priority
- http://hl7.org/fhir/StructureDefinition/note

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
extension:flagPriorityExt |  | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
extension:note |  | 0..* | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Alert bussiness Identifier
status | ?!Σ | 1..1 | code | Alert status Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject | Σ | 1..1 | Reference(Patient (EU core)) | Who/What is flag about?
period | Σ | 0..1 | Period | Time period when the alert is active
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Flag.status | Base | required | Flag Status | 📍5.0.0 | FHIR Std.
Flag.code | Base | example | Flag Code | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Flag | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from Flag

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
extension:flagPriorityExt |  | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
extension:note |  | 0..* | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
identifier |  | 0..* | Identifier | Alert bussiness Identifier
status |  | 1..1 | code | Alert status
code |  | 1..1 | CodeableConcept | Coded or textual message to display to user.
subject |  | 1..1 | Reference(Patient (EU core)) | Who/What is flag about?
period |  | 0..1 | Period | Time period when the alert is active
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
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 Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
extension:flagPriorityExt |  | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
extension:note |  | 0..* | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Alert bussiness Identifier
status | ?!Σ | 1..1 | code | Alert status Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.
category | Σ | 0..* | CodeableConcept | Clinical, administrative, etc Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject | Σ | 1..1 | Reference(Patient (EU core)) | Who/What is flag about?
period | Σ | 0..1 | Period | Time period when the alert is active
encounter | Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter
author | Σ | 0..1 | Reference(Device | Organization | Patient | RelatedPerson | Practitioner | PractitionerRole) | Flag creator
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Flag.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
Flag.status | Base | required | Flag Status | 📍5.0.0 | FHIR Std.
Flag.category | Base | example | Flag Category | 📍5.0.0 | FHIR Std.
Flag.code | Base | example | Flag Code | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Flag | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Flag

Summary

Structures

This structure refers to these other structures:

- Patient (EU core) (http://hl7.eu/fhir/base-r5/StructureDefinition/patient-eu-core)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/flag-detail
- http://hl7.org/fhir/StructureDefinition/flag-priority
- http://hl7.org/fhir/StructureDefinition/note

Other representations of profile: CSV, Excel, Schematron