This page is part of the International Patient Summary Implementation Guide (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Flag - Alert (IPS)

This profile constrains the Flag resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an alert is represented in the patient summary as an instance of a Flag resource constrained by this profile.

This specialized Flag is used to convey information about an alert specific to an IPS. Information is flagged to raise awareness of potential concerns and/or dangers to/from the subject of the IPS. It brings information to the fore and may reference other information from the summary (through the supportingInfo extension) as well as present obstacles to care.

This profile constrains the representation of a record of an alert in the context of the international patient summary as specified by the IPS project of HL7 International.

Usage:

• Use this Resource Profile: Bundle - IPS
• Refer to this Resource Profile: Composition (IPS)

Formal Views of Profile Content

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

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

This structure is derived from Flag

Name	Flags	Card.	Type	Description & Constraints
Flag			Flag
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
flag-priority	S	0..1	CodeableConcept	An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
status		1..1	code	active | inactive | entered-in-error Fixed Value: active
category	S	0..*	CodeableConceptIPS	Concept - reference to a terminology or just text
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Flag		0..*	Flag	Key information to flag to healthcare providers
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
flag-priority	S	0..1	CodeableConcept	An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | inactive | entered-in-error 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. Fixed Value: active
category	S	0..*	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject	Σ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()

Name	Flags	Card.	Type	Description & Constraints
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
flag-priority	S	0..1	CodeableConcept	An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
status	?!Σ	1..1	code	active | inactive | entered-in-error 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. Fixed Value: active
category	S	0..*	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject	Σ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
period	Σ	0..1	Period	Time period when flag is active
encounter	Σ	0..1	Reference(Encounter)	Alert relevant during encounter
author	Σ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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

Must-Support: 3 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/flag-priority

Maturity: 2

Differential View

This structure is derived from Flag

Name	Flags	Card.	Type	Description & Constraints
Flag			Flag
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
flag-priority	S	0..1	CodeableConcept	An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
status		1..1	code	active | inactive | entered-in-error Fixed Value: active
category	S	0..*	CodeableConceptIPS	Concept - reference to a terminology or just text
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Flag		0..*	Flag	Key information to flag to healthcare providers
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
flag-priority	S	0..1	CodeableConcept	An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | inactive | entered-in-error 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. Fixed Value: active
category	S	0..*	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject	Σ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
flag-priority	S	0..1	CodeableConcept	An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
status	?!Σ	1..1	code	active | inactive | entered-in-error 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. Fixed Value: active
category	S	0..*	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: FlagCode (example): Detail codes identifying specific flagged issues.
subject	Σ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
period	Σ	0..1	Period	Time period when flag is active
encounter	Σ	0..1	Reference(Encounter)	Alert relevant during encounter
author	Σ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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

Must-Support: 3 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/flag-priority

Maturity: 2

Other representations of profile: CSV, Excel, Schematron