Data Model Libraries
    Preparing search index...

    Class DetectedIssue

    DetectedIssue Class

    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, gaps in care, etc.

    FHIR Specification

    • Short: Clinical issue with action
    • 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, gaps in care, etc.
    • FHIR Version: 5.0.0

    FHIR DetectedIssue

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? status category? code? detectedissueSeverityEnum severity? subject? encounter? identified? author? implicated? evidence? detail? reference? mitigation?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory addCategory hasCategory getCode setCode hasCode getSeverityEnumType setSeverityEnumType hasSeverityEnumType getSeverityElement setSeverityElement hasSeverityElement getSeverity setSeverity hasSeverity getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getIdentified setIdentified hasIdentified getIdentifiedDateTimeType hasIdentifiedDateTimeType getIdentifiedPeriod hasIdentifiedPeriod getAuthor setAuthor hasAuthor getImplicated setImplicated addImplicated hasImplicated getEvidence setEvidence addEvidence hasEvidence getDetailElement setDetailElement hasDetailElement getDetail setDetail hasDetail getReferenceElement setReferenceElement hasReferenceElement getReference setReference hasReference getMitigation setMitigation addMitigation hasMitigation fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initImplicated initEvidence initMitigation

    Constructors

    Properties

    identifier?: Identifier[]

    DetectedIssue.identifier Element

    FHIR Specification

    • Short: Unique id for the detected issue
    • Definition: Business identifier associated with the detected issue record.
    • Requirements: Allows linking instances of the same detected issue found on different servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    status: null | CodeType

    DetectedIssue.status Element

    FHIR Specification

    • Short: preliminary | final | entered-in-error | mitigated
    • Definition: Indicates the status of the detected issue.
    • Comment: This element is labeled as a modifier because the status contains the code entered-in-error that marks the issue as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains the code entered-in-error which means that the resource should not be treated as valid
    • isSummary: true
    category?: CodeableConcept[]

    DetectedIssue.category Element

    FHIR Specification

    • Short: Type of detected issue, e.g. drug-drug, duplicate therapy, etc
    • Definition: A code that classifies the general type of detected issue.
    • Comment: In addition to the required category valueset, this element allows various categorization schemes based on the owner's definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.
    • Requirements: Used for filtering what detected issues are retrieved and displayed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    DetectedIssue.code Element

    FHIR Specification

    • Short: Specific type of detected issue, e.g. drug-drug, duplicate therapy, etc
    • Definition: Identifies the specific type of issue identified.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    detectedissueSeverityEnum: DetectedissueSeverityEnum

    FHIR CodeSystem: DetectedissueSeverity

    DetectedissueSeverityEnum

    severity?: EnumCodeType

    DetectedIssue.severity Element

    FHIR Specification

    • Short: high | moderate | low
    • Definition: Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: DetectedissueSeverityEnum

    subject?: Reference

    DetectedIssue.subject Element

    FHIR Specification

    encounter?: Reference

    DetectedIssue.encounter Element

    FHIR Specification

    • Short: Encounter detected issue is part of
    • Definition: The encounter during which this issue was detected.
    • Comment: This will typically be the encounter the DetectedIssue was created during, but some DetectedIssues may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).
    • Requirements: Links this detected issue to the Encounter context.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identified?: IDataType

    DetectedIssue.identified[x] Element

    @ChoiceDataTypesMeta('DetectedIssue.identified[x]', ['dateTime','Period',]

    FHIR Specification

    • Short: When identified
    • Definition: The date or period when the detected issue was initially identified.
    • Requirements: No-one can be responsible for mitigation prior to the issue being identified.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    author?: Reference

    DetectedIssue.author Element

    FHIR Specification

    implicated?: Reference[]

    DetectedIssue.implicated Element

    FHIR Specification

    • Short: Problem resource
    • Definition: Indicates the resource representing the current activity or proposed activity that is potentially problematic.
    • Comment: 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    evidence?: DetectedIssueEvidenceComponent[]

    DetectedIssue.evidence Element

    FHIR Specification

    • Short: Supporting evidence
    • Definition: Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    detail?: MarkdownType

    DetectedIssue.detail Element

    FHIR Specification

    • Short: Description and context
    • Definition: A textual explanation of the detected issue.
    • Comment: Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reference?: UriType

    DetectedIssue.reference Element

    FHIR Specification

    • Short: Authority for issue
    • Definition: The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    mitigation?: DetectedIssueMitigationComponent[]

    DetectedIssue.mitigation Element

    FHIR Specification

    • Short: Step taken to address
    • 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided DetectedIssue JSON to instantiate the DetectedIssue data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR DetectedIssue

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to DetectedIssue

      Returns undefined | DetectedIssue

      DetectedIssue data model or undefined for DetectedIssue

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('DetectedIssue.subject', ['Patient','Group','Device','Location','Organization','Procedure','Practitioner','Medication','Substance','BiologicallyDerivedProduct','NutritionProduct',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCategorysetCategoryaddCategoryhasCategorygetCodesetCodehasCodegetSeverityEnumTypesetSeverityEnumTypehasSeverityEnumTypegetSeverityElementsetSeverityElementhasSeverityElementgetSeveritysetSeverityhasSeveritygetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetIdentifiedsetIdentifiedhasIdentifiedgetIdentifiedDateTimeTypehasIdentifiedDateTimeTypegetIdentifiedPeriodhasIdentifiedPeriodgetAuthorsetAuthorhasAuthorgetImplicatedsetImplicatedaddImplicatedhasImplicatedgetEvidencesetEvidenceaddEvidencehasEvidencegetDetailElementsetDetailElementhasDetailElementgetDetailsetDetailhasDetailgetReferenceElementsetReferenceElementhasReferenceElementgetReferencesetReferencehasReferencegetMitigationsetMitigationaddMitigationhasMitigationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitImplicatedinitEvidenceinitMitigation