HL7 Europe Patient Summary
0.0.1-ci - ci-build 150

HL7 Europe Patient Summary, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/eps/ and changes regularly. See the Directory of published versions

Resource Profile: Flag (EPS)

Official URL: http://hl7.eu/fhir/eps/StructureDefinition/flag-eu-eps Version: 0.0.1-ci
Standards status: Draft Maturity Level: 1 Computable Name: FlagEuEps

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile constrains the Flag resource to represent alerts or warnings in FHIR for the purpose of this project.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagAlertUvIps Key information to flag to healthcare providers
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:flag-priority SO 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... 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.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category SOΣ 0..* CodeableConceptIPS(2.0.0) Clinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... code SOΣ 1..1 CodeableConceptIPS(2.0.0) Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... subject SOΣ 1..1 Reference(Patient (EPS)) Who/What is flag about?
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
From the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
From the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from FlagAlertUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag FlagAlertUvIps
... Slices for extension Content/Rules for all slices
.... 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.
... status 1..1 code Alert status
... code 1..1 CodeableConceptIPS(2.0.0) Coded or textual message to display to user.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagAlertUvIps 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
... 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:flag-priority SO 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... 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.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business 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.
Fixed Value: active
... category SOΣ 0..* CodeableConceptIPS(2.0.0) Clinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... code SOΣ 1..1 CodeableConceptIPS(2.0.0) Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... subject SOΣ 1..1 Reference(Patient (EPS)) Who/What is flag about?
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
From the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
From the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
From the FHIR Standard
Flag.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from FlagAlertUvIps

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagAlertUvIps Key information to flag to healthcare providers
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:flag-priority SO 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... 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.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category SOΣ 0..* CodeableConceptIPS(2.0.0) Clinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... code SOΣ 1..1 CodeableConceptIPS(2.0.0) Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... subject SOΣ 1..1 Reference(Patient (EPS)) Who/What is flag about?
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
From the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
From the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from FlagAlertUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag FlagAlertUvIps
... Slices for extension Content/Rules for all slices
.... 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.
... status 1..1 code Alert status
... code 1..1 CodeableConceptIPS(2.0.0) Coded or textual message to display to user.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagAlertUvIps 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
... 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:flag-priority SO 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... 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.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business 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.
Fixed Value: active
... category SOΣ 0..* CodeableConceptIPS(2.0.0) Clinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... code SOΣ 1..1 CodeableConceptIPS(2.0.0) Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
... subject SOΣ 1..1 Reference(Patient (EPS)) Who/What is flag about?
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Producer (IPS) from Flag - Alert (IPS)
SHALL:handle Consumer (IPS) from Flag - Alert (IPS)
SHOULD:display Consumer (IPS) from Flag - Alert (IPS)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
From the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
From the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
From the FHIR Standard
Flag.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from FlagAlertUvIps

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron