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

Resource Profile: QICoreFlag

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.

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..*FlagKey information to flag to healthcare providers
... status S1..1codeactive | inactive | entered-in-error
... category S0..*CodeableConceptClinical, administrative, etc.
... code S1..1CodeableConceptCoded or textual message to display to user
... period S0..1PeriodTime period when flag is active

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... status ?!SΣ1..1codeactive | 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..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣ1..1Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter Σ0..1Reference(Encounter)Alert relevant during encounter
... author Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... status ?!Σ1..1codeactive | 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..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


... code Σ1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... period Σ0..1PeriodTime period when flag is active

doco Documentation for this format

Differential View

This structure is derived from Flag

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... status S1..1codeactive | inactive | entered-in-error
... category S0..*CodeableConceptClinical, administrative, etc.
... code S1..1CodeableConceptCoded or textual message to display to user
... period S0..1PeriodTime period when flag is active

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... status ?!SΣ1..1codeactive | 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..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣ1..1Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter Σ0..1Reference(Encounter)Alert relevant during encounter
... author Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Flag.languagepreferredCommonLanguages
Max Binding: AllLanguages
Flag.statusrequiredFlagStatus
Flag.categoryexampleFlagCategory
Flag.codeexampleFlagCode

Constraints

IdGradePathDetailsRequirements
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-1errorFlag.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFlag.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFlag.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFlag.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFlag.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFlag.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())