QI-Core Implementation Guide
4.1.1 - STU 4.1.1
US
This page is part of the Quality Improvement Core Framework (v4.1.1: STU 4) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-flag | Version: 4.1.1 | |||
Draft as of 2018-08-22 | Computable Name: QICoreFlag |
Profile of Flag for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
Large Dog Warning Example |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Flag
Summary
Must-Support: 5 elements
Structures
This structure refers to these other structures:
This structure is derived from Flag
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
status | S | 1..1 | code | active | inactive | entered-in-error |
category | S | 0..* | CodeableConcept | Clinical, administrative, etc. |
code | S | 1..1 | CodeableConcept | Coded or textual message to display to user |
subject | S | 1..1 | Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | S | 0..1 | Period | Time period when flag is active |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier |
status | ?!SΣ | 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. |
category | SΣ | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
subject | SΣ | 1..1 | Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | SΣ | 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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
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. |
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(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | Σ | 0..1 | Period | Time period when flag is active |
Documentation for this format |
This structure is derived from Flag
Summary
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Flag
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
status | S | 1..1 | code | active | inactive | entered-in-error |
category | S | 0..* | CodeableConcept | Clinical, administrative, etc. |
code | S | 1..1 | CodeableConcept | Coded or textual message to display to user |
subject | S | 1..1 | Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | S | 0..1 | Period | Time period when flag is active |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier |
status | ?!SΣ | 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. |
category | SΣ | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
subject | SΣ | 1..1 | Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | SΣ | 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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Flag.language | preferred | CommonLanguages Max Binding: AllLanguages |
Flag.status | required | FlagStatus |
Flag.category | example | FlagCategory |
Flag.code | example | FlagCode |
Id | Grade | Path | 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 | Flag.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Flag.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Flag.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Flag.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Flag.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Flag.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |