QI-Core Implementation Guide
6.0.0-ballot - ballot
QI-Core Implementation Guide
6.0.0-ballot - ballot
This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. 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: 6.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.
| Large Dog Warning Example |
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 | |
  status | S | 1..1 | code | active | inactive | entered-in-error |
| category | S | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (preferred) |
| code | S | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (preferred) |
 subject | S | 1..1 | Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) | Who/What is flag about? |
 period | S | 0..1 | Period | Time period when flag is active |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Flag.category | preferred | FlagCategory |
| Flag.code | preferred | FlagCode |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | ?!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 (preferred) |
| code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (preferred) |
| subject | SΣ | 1..1 | Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) | Who/What is flag about? |
| period | SΣ | 0..1 | Period | Time period when flag is active |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Flag.status | required | FlagStatus |
| Flag.category | preferred | FlagCategory |
| Flag.code | preferred | FlagCode |
| 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 | |||||
 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 (preferred) | ||||
| code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (preferred) | ||||
| subject | SΣ | 1..1 | Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) | 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| Flag.language | preferred | CommonLanguages
| ||||
| Flag.status | required | FlagStatus | ||||
| Flag.category | preferred | FlagCategory | ||||
| Flag.code | preferred | FlagCode |
| Id | Grade | Path(s) | Details | Requirements |
| 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
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. Binding: FlagCategory (preferred) |
| code | S | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (preferred) |
| subject | S | 1..1 | Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) | Who/What is flag about? |
| period | S | 0..1 | Period | Time period when flag is active |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Flag.category | preferred | FlagCategory |
| Flag.code | preferred | FlagCode |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | ?!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 (preferred) |
| code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (preferred) |
| subject | SΣ | 1..1 | Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) | Who/What is flag about? |
| period | SΣ | 0..1 | Period | Time period when flag is active |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Flag.status | required | FlagStatus |
| Flag.category | preferred | FlagCategory |
| Flag.code | preferred | FlagCode |
| 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 | |||||
| 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 (preferred) | ||||
| code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (preferred) | ||||
| subject | SΣ | 1..1 | Reference(QICore Patient | QICore Location | Group | QICore Organization | QICore Practitioner) | 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| Flag.language | preferred | CommonLanguages
| ||||
| Flag.status | required | FlagStatus | ||||
| Flag.category | preferred | FlagCategory | ||||
| Flag.code | preferred | FlagCode |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ http://www.hl7.org/Special/committees/cqi/index.cfm. Package hl7.fhir.us.qicore#6.0.0-ballot based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change