QI-Core Implementation Guide
7.0.0-ballot - STU7 Ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v7.0.0-ballot: STU7 (v7.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore Flag

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-flag Version: 7.0.0-ballot
Active 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.

QI Elements:
  • status: (QI) active | inactive | entered-in-error
  • category: (QI) Clinical, administrative, etc.
  • code: (QI) Coded or textual message to display to user
  • subject: (QI) Who/What is flag about?
  • period: (QI) Time period when flag is active
Primary code path: code
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Usage

See the patterns page for implementation and usage patterns.

Examples

Large Dog Warning Example

Usage:

Formal Views of Profile Content

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

This structure is derived from Flag

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Flag Key information to flag to healthcare providers
... status 1..1 code (QI) active | inactive | entered-in-error
... category 0..* CodeableConcept (QI) Clinical, administrative, etc.
Binding: FlagCategory (preferred)
... code 1..1 CodeableConcept (QI) Coded or textual message to display to user
Binding: FlagCode (preferred)
... period 0..1 Period (QI) Time period when flag is active

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Flag.categorypreferredFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codepreferredFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Flag Key information to flag to healthcare providers
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code (QI) 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.

... code Σ 1..1 CodeableConcept (QI) Coded or textual message to display to user
Binding: FlagCode (preferred)
... subject Σ 1..1 Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) (QI) Who/What is flag about?
... period Σ 0..1 Period (QI) Time period when flag is active

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categorypreferredFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codepreferredFlagCode
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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 ?!Σ 1..1 code (QI) 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 (QI) Clinical, administrative, etc.
Binding: FlagCategory (preferred)
... code Σ 1..1 CodeableConcept (QI) Coded or textual message to display to user
Binding: FlagCode (preferred)
... subject Σ 1..1 Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) (QI) Who/What is flag about?
... period Σ 0..1 Period (QI) 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

PathConformanceValueSetURI
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categorypreferredFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codepreferredFlagCode
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 Flag

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Flag Key information to flag to healthcare providers
... status 1..1 code (QI) active | inactive | entered-in-error
... category 0..* CodeableConcept (QI) Clinical, administrative, etc.
Binding: FlagCategory (preferred)
... code 1..1 CodeableConcept (QI) Coded or textual message to display to user
Binding: FlagCode (preferred)
... period 0..1 Period (QI) Time period when flag is active

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Flag.categorypreferredFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codepreferredFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Flag Key information to flag to healthcare providers
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code (QI) 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.

... code Σ 1..1 CodeableConcept (QI) Coded or textual message to display to user
Binding: FlagCode (preferred)
... subject Σ 1..1 Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) (QI) Who/What is flag about?
... period Σ 0..1 Period (QI) Time period when flag is active

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categorypreferredFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codepreferredFlagCode
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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 ?!Σ 1..1 code (QI) 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 (QI) Clinical, administrative, etc.
Binding: FlagCategory (preferred)
... code Σ 1..1 CodeableConcept (QI) Coded or textual message to display to user
Binding: FlagCode (preferred)
... subject Σ 1..1 Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) (QI) Who/What is flag about?
... period Σ 0..1 Period (QI) 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

PathConformanceValueSetURI
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categorypreferredFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codepreferredFlagCode
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()

 

Other representations of profile: CSV, Excel, Schematron