This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
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
This is a domain case/instance profile
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 | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
instantiatesCaseFeature | S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
caseFeatureType | S | 0..1 | code | CPG 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 | S | 0..1 | code | CPG 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 | S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 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Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
subject | SΣ | 1..1 | Reference(CPG Patient) | Who/What is flag about? |
period | SΣ | 0..1 | Period | Time period when flag is active |
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Alert relevant during encounter |
author | SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator |
Documentation for this format |
Path | Conformance | ValueSet |
Flag.status | required | FlagStatus |
Flag.category | example | FlagCategory |
Flag.code | example | 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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
instantiatesCaseFeature | S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | ||||
caseFeatureType | S | 0..1 | code | CPG 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 | S | 0..1 | code | CPG 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 | S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 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Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. | ||||
subject | SΣ | 1..1 | Reference(CPG Patient) | Who/What is flag about? | ||||
period | SΣ | 0..1 | Period | Time period when flag is active | ||||
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Alert relevant during encounter | ||||
author | SΣ | 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 | example | FlagCategory | ||||
Flag.code | example | 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() |
This structure is derived from Flag
Summary
Mandatory: 1 element
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Flag
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
instantiatesCaseFeature | S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
caseFeatureType | S | 0..1 | code | CPG 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 | S | 0..1 | code | CPG 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 | S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 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Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
subject | SΣ | 1..1 | Reference(CPG Patient) | Who/What is flag about? |
period | SΣ | 0..1 | Period | Time period when flag is active |
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Alert relevant during encounter |
author | SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator |
Documentation for this format |
Path | Conformance | ValueSet |
Flag.status | required | FlagStatus |
Flag.category | example | FlagCategory |
Flag.code | example | 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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
instantiatesCaseFeature | S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | ||||
caseFeatureType | S | 0..1 | code | CPG 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 | S | 0..1 | code | CPG 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 | S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 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Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
code | SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. | ||||
subject | SΣ | 1..1 | Reference(CPG Patient) | Who/What is flag about? | ||||
period | SΣ | 0..1 | Period | Time period when flag is active | ||||
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Alert relevant during encounter | ||||
author | SΣ | 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 | example | FlagCategory | ||||
Flag.code | example | 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() |
This structure is derived from Flag
Summary
Mandatory: 1 element
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron