This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
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.
Summary
Mandatory: 1 element
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-instantiatesCaseFeature | S | 0..1 | canonical(StructureDefinition) | Definition of this case feature URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
cpg-caseFeatureType | S | 0..1 | code | asserted | 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 | S | 0..1 | code | weakly-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 | S | 0..* | Reference() | Pertinent information 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(CPGPatient) | Who/What is flag about? |
period | SΣ | 0..1 | Period | Time period when flag is active |
encounter | SΣ | 0..1 | Reference(CPGEncounter) | Alert relevant during encounter |
author | SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator |
Documentation for this format |
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
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-instantiatesCaseFeature | S | 0..1 | canonical(StructureDefinition) | Definition of this case feature URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
cpg-caseFeatureType | S | 0..1 | code | asserted | 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 | S | 0..1 | code | weakly-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 | S | 0..* | Reference() | Pertinent information 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(CPGPatient) | Who/What is flag about? |
period | SΣ | 0..1 | Period | Time period when flag is active |
encounter | SΣ | 0..1 | Reference(CPGEncounter) | 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 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.extension:instantiatesCaseFeature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Flag.extension:instantiatesCaseFeature | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Flag.extension:caseFeatureType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Flag.extension:caseFeatureType | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Flag.extension:caseFeaturePertinence | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Flag.extension:caseFeaturePertinence | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Flag.extension:pertinent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Flag.extension:pertinent | 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()) |