QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)

QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions

D.4.1 StructureDefinition-qicore-flag

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Large Dog Warning Example

D.4.1.1 Formal Views of Profile Content

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.

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag I0..*FlagKey information to flag to healthcare providers
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifier
... status ?!SΣI1..1codeactive | inactive | entered-in-error
Binding: FlagStatus (required)
... category SΣI0..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example)
... code SΣI1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example)
... subject SΣI1..1Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner)Who/What is flag about?
... period SΣI0..1PeriodTime period when flag is active
... encounter ΣI0..1Reference(Encounter)Alert relevant during encounter
... author ΣI0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag I0..*FlagKey information to flag to healthcare providers
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifier
... status ?!SΣI1..1codeactive | inactive | entered-in-error
Binding: FlagStatus (required)
... category SΣI0..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example)
... code SΣI1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example)
... subject SΣI1..1Reference(QICorePatient | QICoreLocation | Group | QICoreOrganization | QICorePractitioner)Who/What is flag about?
... period SΣI0..1PeriodTime period when flag is active
... encounter ΣI0..1Reference(Encounter)Alert relevant during encounter
... author ΣI0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2FlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3FlagIf 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-4FlagIf 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-5FlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6FlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1Flag.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Flag.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Flag.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Flag.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Flag.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Flag.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())