Clinical Practice Guidelines
2.0.0-ballot - ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

Resource Profile: CPG Flag

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-flag Version: 2.0.0-ballot
Active as of 2023-12-19 Computable Name: CPGFlag

Represents a flag on a patient record within the context of a computable clinical practice guideline

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred

... pertinent S0..*Reference()CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
... identifier S0..*IdentifierBusiness identifier
... status S1..1codeactive | inactive | entered-in-error
... category S1..1CodeableConceptClinical, administrative, etc.
... code S1..1CodeableConceptCoded or textual message to display to user
... subject S1..1Reference(CPG Patient)Who/What is flag about?
... period S0..1PeriodTime period when flag is active
... encounter S0..1Reference(CPG Encounter)Alert relevant during encounter
... author S0..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
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeaturePertinence S0..1codeCPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature


... pertinent S0..*Reference()CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ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Σ1..1CodeableConceptClinical, 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(CPG Patient)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(CPG Encounter)Alert relevant during encounter
... author SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Flag.statusrequiredFlagStatus
Flag.categoryexampleFlagCategory
Flag.codeexampleFlagCode

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..*FlagKey information to flag to healthcare providers
... id Σ0..1idLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred


... caseFeaturePertinence S0..1codeCPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature


... pertinent S0..*Reference()CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ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Σ1..1CodeableConceptClinical, 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(CPG Patient)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(CPG Encounter)Alert relevant during encounter
... author SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFlagStatus
Flag.categoryexampleFlagCategory
Flag.codeexampleFlagCode

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..*FlagKey information to flag to healthcare providers
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred

... pertinent S0..*Reference()CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
... identifier S0..*IdentifierBusiness identifier
... status S1..1codeactive | inactive | entered-in-error
... category S1..1CodeableConceptClinical, administrative, etc.
... code S1..1CodeableConceptCoded or textual message to display to user
... subject S1..1Reference(CPG Patient)Who/What is flag about?
... period S0..1PeriodTime period when flag is active
... encounter S0..1Reference(CPG Encounter)Alert relevant during encounter
... author S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeaturePertinence S0..1codeCPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature


... pertinent S0..*Reference()CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ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Σ1..1CodeableConceptClinical, 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(CPG Patient)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(CPG Encounter)Alert relevant during encounter
... author SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Flag.statusrequiredFlagStatus
Flag.categoryexampleFlagCategory
Flag.codeexampleFlagCode

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..*FlagKey information to flag to healthcare providers
... id Σ0..1idLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred


... caseFeaturePertinence S0..1codeCPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature


... pertinent S0..*Reference()CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ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Σ1..1CodeableConceptClinical, 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(CPG Patient)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(CPG Encounter)Alert relevant during encounter
... author SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFlagStatus
Flag.categoryexampleFlagCategory
Flag.codeexampleFlagCode

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