QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions
Large Dog Warning Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-flag
Profile of Flag for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on Flag.
This profile was published on Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | I | 0..* | Flag | Key information to flag to healthcare providers |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business identifier |
status | ?!SΣI | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required) |
category | SΣI | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example) |
code | SΣI | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example) |
subject | SΣI | 1..1 | Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | SΣI | 0..1 | Period | Time period when flag is active |
encounter | ΣI | 0..1 | Reference(Encounter) | Alert relevant during encounter |
author | ΣI | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | I | 0..* | Flag | Key information to flag to healthcare providers |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business identifier |
status | ?!SΣI | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required) |
category | SΣI | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example) |
code | SΣI | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example) |
subject | SΣI | 1..1 | Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner) | Who/What is flag about? |
period | SΣI | 0..1 | Period | Time period when flag is active |
encounter | ΣI | 0..1 | Reference(Encounter) | Alert relevant during encounter |
author | ΣI | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator |
Documentation for this format |
Path | Conformance | ValueSet |
Flag.language | preferred | CommonLanguages Max Binding: AllLanguages |
Flag.status | required | FlagStatus |
Flag.category | example | FlagCategory |
Flag.code | example | FlagCode |
Id | Path | Details | Requirements |
dom-2 | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Flag | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Flag | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Flag.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Flag.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Flag.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Flag.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Flag.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Flag.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |