LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Resource Profile: CareGapDetectedIssue - Detailed Descriptions

Active as of 2022-11-10

Definitions for the care-gap-detected-issue resource profile.

1. DetectedIssue
2. DetectedIssue.extension
Control20..*
SlicingThis element introduces a set of slices on DetectedIssue.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. DetectedIssue.extension:canonicalMeasure
SliceNamecanonicalMeasure
Definition

Canonical reference to the specific version of the measure used to generate the care gap or population

Control1..1
TypeExtension(CanonicalMeasure) (Extension Type: canonical)
4. DetectedIssue.extension:measurePopulationId
SliceNamemeasurePopulationId
Definition

User-friendly textual key (internal use only) that identifies the care gap. This id should be unique across all measures and should not change when a measure is versioned or when overrides are applied.

Control1..1
TypeExtension(MeasurePopulationId) (Extension Type: id)
5. DetectedIssue.extension:assignedPractitioner
SliceNameassignedPractitioner
Definition

The practitioners assigned to the patient when the care gap or measure population was identified

Control0..*
TypeExtension(AssignedPractitioner) (Extension Type: Reference(PractitionerPractitionerRole)))
6. DetectedIssue.extension:careGapComplianceDisplayName
SliceNamecareGapComplianceDisplayName
Definition

Text describing the treatment or compliance event required to close the care gap. Should be suitable for display to patient.

Control0..1
TypeExtension(CareGapComplianceDisplayName) (Extension Type: string)
7. DetectedIssue.extension:careGapComplianceFrequency
SliceNamecareGapComplianceFrequency
Definition

Text describing the frequency of the treatment or compliance event required to close the care gap. Frequency should be suitable for display to patient.

Control0..1
TypeExtension(CareGapComplianceFrequency) (Extension Type: string)
8. DetectedIssue.extension:careGapComplianceMet
SliceNamecareGapComplianceMet
Definition

Indicates if the patient received the targeted treatment to close the care gap

Control0..1
TypeExtension(CareGapComplianceMet) (Extension Type: boolean)
9. DetectedIssue.extension:relatedIssue
SliceNamerelatedIssue
Definition

Related issue that can be combined to fulfill a single time period for a given care gap

Control0..*
TypeExtension(RelatedIssue) (Extension Type: Reference(CareGapDetectedIssue)))
10. DetectedIssue.identifier:Derived
SliceNameDerived
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
11. DetectedIssue.identifier:Derived.use
Control0..?
Pattern Valueofficial
12. DetectedIssue.identifier:Derived.type
Control1..?
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type"/>
    <code value="DRI"/>
  </coding>
</valueCodeableConcept>
13. DetectedIssue.code
Control0..01
14. DetectedIssue.severity
Control0..01
15. DetectedIssue.patient
Control10..1
16. DetectedIssue.identified[x]
Control10..1
TypeChoice of: , dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
17. DetectedIssue.author
Control0..01
18. DetectedIssue.implicated
Control0..0*
19. DetectedIssue.evidence
Control0..0*
20. DetectedIssue.detail
Control0..01
21. DetectedIssue.reference
Control0..01
22. DetectedIssue.mitigation
Control0..0*
1. DetectedIssue
Definition

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

Control0..*
Alternate NamesDDI, drug-drug interaction, Contraindication, Alert
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. DetectedIssue.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. DetectedIssue.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..0*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

4. DetectedIssue.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control20..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DetectedIssue.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
5. DetectedIssue.extension:canonicalMeasure
SliceNamecanonicalMeasure
Definition

Canonical reference to the specific version of the measure used to generate the care gap or population

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CanonicalMeasure) (Extension Type: canonical)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. DetectedIssue.extension:measurePopulationId
SliceNamemeasurePopulationId
Definition

User-friendly textual key (internal use only) that identifies the care gap. This id should be unique across all measures and should not change when a measure is versioned or when overrides are applied.

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(MeasurePopulationId) (Extension Type: id)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. DetectedIssue.extension:assignedPractitioner
SliceNameassignedPractitioner
Definition

The practitioners assigned to the patient when the care gap or measure population was identified

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(AssignedPractitioner) (Extension Type: Reference(PractitionerPractitionerRole)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
8. DetectedIssue.extension:careGapComplianceDisplayName
SliceNamecareGapComplianceDisplayName
Definition

Text describing the treatment or compliance event required to close the care gap. Should be suitable for display to patient.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CareGapComplianceDisplayName) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. DetectedIssue.extension:careGapComplianceFrequency
SliceNamecareGapComplianceFrequency
Definition

Text describing the frequency of the treatment or compliance event required to close the care gap. Frequency should be suitable for display to patient.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CareGapComplianceFrequency) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DetectedIssue.extension:careGapComplianceMet
SliceNamecareGapComplianceMet
Definition

Indicates if the patient received the targeted treatment to close the care gap

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CareGapComplianceMet) (Extension Type: boolean)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. DetectedIssue.extension:relatedIssue
SliceNamerelatedIssue
Definition

Related issue that can be combined to fulfill a single time period for a given care gap

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(RelatedIssue) (Extension Type: Reference(CareGapDetectedIssue)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. DetectedIssue.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. DetectedIssue.identifier
Definition

Business identifier associated with the detected issue record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Requirements

Allows linking instances of the same detected issue found on different servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DetectedIssue.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
14. DetectedIssue.identifier:Source
SliceNameSource
Definition

Business identifier associated with the detected issue record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Requirements

Allows linking instances of the same detected issue found on different servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. DetectedIssue.identifier:Source.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Pattern Valueofficial
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. DetectedIssue.identifier:Source.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control10..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type"/>
    <code value="SSRI"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. DetectedIssue.identifier:Derived
SliceNameDerived
Definition

Business identifier associated with the detected issue record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Requirements

Allows linking instances of the same detected issue found on different servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. DetectedIssue.identifier:Derived.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Pattern Valueofficial
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. DetectedIssue.identifier:Derived.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control10..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type"/>
    <code value="DRI"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. DetectedIssue.status
Definition

Indicates the status of the detected issue.

Control1..1
BindingThe codes SHALL be taken from ObservationStatus

Indicates the status of the identified issue.

Typecode
Is Modifiertrue
Alternate Namesstatus
Comments

This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the issue as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. DetectedIssue.code
Definition

Identifies the general type of issue identified.

Control0..01
BindingThe codes SHOULD be taken from DetectedIssueCategory

Codes identifying the general type of detected issue; e.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc.

TypeCodeableConcept
Alternate Namestype
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. DetectedIssue.severity
Definition

Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.

Control0..01
BindingThe codes SHALL be taken from DetectedIssueSeverity

Indicates the potential degree of impact of the identified issue on the patient.

Typecode
Alternate Namesseverity
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. DetectedIssue.patient
Definition

Indicates the patient whose record the detected issue is associated with.

Control10..1
TypeReference(Patient))
Requirements

While the subject could be inferred by tracing the subject of the implicated resources, it's useful to have a direct link for query purposes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. DetectedIssue.identified[x]
Definition

The date or period when the detected issue was initially identified.

Control10..1
TypeChoice of: Period, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

No-one can be responsible for mitigation prior to the issue being identified.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. DetectedIssue.author
Definition

Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.

Control0..01
TypeReference(Practitioner|PractitionerRole|Device))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. DetectedIssue.implicated
Definition

Indicates the resource representing the current activity or proposed activity that is potentially problematic.

Control0..0*
TypeReference(Resource))
Alternate Namescause
Comments

There's an implicit constraint on the number of implicated resources based on DetectedIssue.type; e.g. For drug-drug, there would be more than one. For timing, there would typically only be one.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. DetectedIssue.evidence
Definition

Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.

Control0..0*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. DetectedIssue.detail
Definition

A textual explanation of the detected issue.

Control0..01
Typestring
Comments

Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. DetectedIssue.reference
Definition

The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.

Control0..01
Typeuri
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. DetectedIssue.mitigation
Definition

Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Control0..0*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. DetectedIssue
Definition

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

Control0..*
Alternate NamesDDIdrug-drug interactionContraindicationAlert
2. DetectedIssue.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. DetectedIssue.meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1 This element is affected by the following invariants: ele-1
TypeMeta(ProcessMeta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. DetectedIssue.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. DetectedIssue.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. DetectedIssue.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrativehtmlxhtmldisplay
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. DetectedIssue.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..0
TypeResource
Alternate Namesinline resourcesanonymous resourcescontained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. DetectedIssue.extension
Definition

An Extension

Control2..*
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DetectedIssue.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. DetectedIssue.extension:canonicalMeasure
SliceNamecanonicalMeasure
Definition

Canonical reference to the specific version of the measure used to generate the care gap or population

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CanonicalMeasure) (Extension Type: canonical)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DetectedIssue.extension:measurePopulationId
SliceNamemeasurePopulationId
Definition

User-friendly textual key (internal use only) that identifies the care gap. This id should be unique across all measures and should not change when a measure is versioned or when overrides are applied.

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(MeasurePopulationId) (Extension Type: id)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. DetectedIssue.extension:assignedPractitioner
SliceNameassignedPractitioner
Definition

The practitioners assigned to the patient when the care gap or measure population was identified

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(AssignedPractitioner) (Extension Type: Reference(PractitionerPractitionerRole)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. DetectedIssue.extension:careGapComplianceDisplayName
SliceNamecareGapComplianceDisplayName
Definition

Text describing the treatment or compliance event required to close the care gap. Should be suitable for display to patient.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CareGapComplianceDisplayName) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. DetectedIssue.extension:careGapComplianceFrequency
SliceNamecareGapComplianceFrequency
Definition

Text describing the frequency of the treatment or compliance event required to close the care gap. Frequency should be suitable for display to patient.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CareGapComplianceFrequency) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. DetectedIssue.extension:careGapComplianceMet
SliceNamecareGapComplianceMet
Definition

Indicates if the patient received the targeted treatment to close the care gap

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CareGapComplianceMet) (Extension Type: boolean)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. DetectedIssue.extension:relatedIssue
SliceNamerelatedIssue
Definition

Related issue that can be combined to fulfill a single time period for a given care gap

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(RelatedIssue) (Extension Type: Reference(CareGapDetectedIssue)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. DetectedIssue.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. DetectedIssue.identifier
Definition

Business identifier associated with the detected issue record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Requirements

Allows linking instances of the same detected issue found on different servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DetectedIssue.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
18. DetectedIssue.identifier:Source
SliceNameSource
Definition

Business identifier associated with the detected issue record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Requirements

Allows linking instances of the same detected issue found on different servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. DetectedIssue.identifier:Source.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. DetectedIssue.identifier:Source.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DetectedIssue.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. DetectedIssue.identifier:Source.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Pattern Valueofficial
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. DetectedIssue.identifier:Source.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type"/>
    <code value="SSRI"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. DetectedIssue.identifier:Source.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. DetectedIssue.identifier:Source.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. DetectedIssue.identifier:Source.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. DetectedIssue.identifier:Source.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization))
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. DetectedIssue.identifier:Derived
SliceNameDerived
Definition

Business identifier associated with the detected issue record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Requirements

Allows linking instances of the same detected issue found on different servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. DetectedIssue.identifier:Derived.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
29. DetectedIssue.identifier:Derived.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DetectedIssue.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. DetectedIssue.identifier:Derived.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Pattern Valueofficial
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. DetectedIssue.identifier:Derived.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type"/>
    <code value="DRI"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. DetectedIssue.identifier:Derived.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. DetectedIssue.identifier:Derived.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. DetectedIssue.identifier:Derived.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. DetectedIssue.identifier:Derived.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization))
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. DetectedIssue.status
Definition

Indicates the status of the detected issue.

Control1..1
BindingThe codes SHALL be taken from ObservationStatus Indicates the status of the identified issue
Typecode
Is Modifiertrue
Alternate Namesstatus
Comments

This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the issue as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. DetectedIssue.code
Definition

Identifies the general type of issue identified.

Control0..0
BindingThe codes SHOULD be taken from DetectedIssueCategory Codes identifying the general type of detected issue; e.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc
TypeCodeableConcept
Alternate Namestype
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. DetectedIssue.severity
Definition

Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.

Control0..0
BindingThe codes SHALL be taken from DetectedIssueSeverity Indicates the potential degree of impact of the identified issue on the patient
Typecode
Alternate Namesseverity
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. DetectedIssue.patient
Definition

Indicates the patient whose record the detected issue is associated with.

Control1..1
TypeReference(Patient))
Requirements

While the subject could be inferred by tracing the subject of the implicated resources, it's useful to have a direct link for query purposes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. DetectedIssue.identified[x]
Definition

The date or period when the detected issue was initially identified.

Control1..1
TypePeriod
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

No-one can be responsible for mitigation prior to the issue being identified.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. DetectedIssue.author
Definition

Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.

Control0..0
TypeReference(PractitionerPractitionerRoleDevice))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. DetectedIssue.implicated
Definition

Indicates the resource representing the current activity or proposed activity that is potentially problematic.

Control0..0
TypeReference(Resource))
Alternate Namescause
Comments

There's an implicit constraint on the number of implicated resources based on DetectedIssue.type; e.g. For drug-drug, there would be more than one. For timing, there would typically only be one.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. DetectedIssue.evidence
Definition

Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.

Control0..0
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. DetectedIssue.detail
Definition

A textual explanation of the detected issue.

Control0..0
Typestring
Comments

Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. DetectedIssue.reference
Definition

The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.

Control0..0
Typeuri
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. DetectedIssue.mitigation
Definition

Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Control0..0
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))