HL7 Europe Base Profiles, 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/base/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/base/StructureDefinition/flag-eu-eps | Version: 0.0.1-ci | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: FlagEpsEu | ||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Flag
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
flagDetailExt | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail | |
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 | CodeableConcept | Coded or textual message to display to user. | |
subject | 1..1 | Reference(Patient (EU base)) | Who/What is flag about? | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
flagDetailExt | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
flagPriorityExt | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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. ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues. ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(Patient (EU base)) | Who/What is flag about? ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | |
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard |
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.
| |||||
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 | |||||
flagDetailExt | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail | |||||
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. | ||||
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 base)) | 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 |
Path | Conformance | ValueSet | URI | |||
Flag.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | ||||
Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard | ||||
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard |
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
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from Flag
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
flagDetailExt | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail | |
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 | CodeableConcept | Coded or textual message to display to user. | |
subject | 1..1 | Reference(Patient (EU base)) | Who/What is flag about? | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
flagDetailExt | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
flagPriorityExt | 0..1 | CodeableConcept | An alarm code URL: http://hl7.org/fhir/StructureDefinition/flag-priority Binding: FlagPriorityCodes (example): A code of the alarm. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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. ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues. ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(Patient (EU base)) | Who/What is flag about? ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | |
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard |
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.
| |||||
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 | |||||
flagDetailExt | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail | |||||
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. | ||||
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 base)) | 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 |
Path | Conformance | ValueSet | URI | |||
Flag.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | ||||
Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard | ||||
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from the FHIR Standard |
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
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron