FHIR Clinical Guidelines (v1.0.0) (STU1)

Clinical Practice Guidelines, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-cpg-flag

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-flag

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

This profile builds on Flag.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred

... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature

... cpg-pertinent S0..*Reference()Pertinent information
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(CPGPatient)Who/What is flag about?
... period S0..1PeriodTime period when flag is active
... encounter S0..1Reference(CPGEncounter)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
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred


... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature


... cpg-pertinent S0..*Reference()Pertinent information
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(CPGPatient)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(CPGEncounter)Alert relevant during encounter
... author SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred

... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature

... cpg-pertinent S0..*Reference()Pertinent information
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(CPGPatient)Who/What is flag about?
... period S0..1PeriodTime period when flag is active
... encounter S0..1Reference(CPGEncounter)Alert relevant during encounter
... author S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Flag creator

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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred


... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature


... cpg-pertinent S0..*Reference()Pertinent information
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(CPGPatient)Who/What is flag about?
... period SΣ0..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(CPGEncounter)Alert relevant during encounter
... author SΣ0..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.extension:instantiatesCaseFeatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Flag.extension:instantiatesCaseFeatureMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Flag.extension:caseFeatureTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Flag.extension:caseFeatureTypeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Flag.extension:caseFeaturePertinenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Flag.extension:caseFeaturePertinenceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Flag.extension:pertinentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Flag.extension:pertinentMust 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())