Data Model Libraries
    Preparing search index...

    Class ClinicalImpression

    ClinicalImpression Class

    A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

    FHIR Specification

    • Short: A clinical assessment performed when planning treatments and management strategies for a patient
    • Definition: A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
    • FHIR Version: 4.0.1

    FHIR ClinicalImpression

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? eventStatusEnum status statusReason? code? description? subject encounter? effective? date? assessor? previous? problem? investigation? protocol? summary? finding? prognosisCodeableConcept? prognosisReference? supportingInfo? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getCode setCode hasCode getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getEffective setEffective hasEffective getEffectiveDateTimeType hasEffectiveDateTimeType getEffectivePeriod hasEffectivePeriod getDateElement setDateElement hasDateElement getDate setDate hasDate getAssessor setAssessor hasAssessor getPrevious setPrevious hasPrevious getProblem setProblem addProblem hasProblem getInvestigation setInvestigation addInvestigation hasInvestigation getProtocolElement setProtocolElement addProtocolElement hasProtocolElement getProtocol setProtocol addProtocol hasProtocol getSummaryElement setSummaryElement hasSummaryElement getSummary setSummary hasSummary getFinding setFinding addFinding hasFinding getPrognosisCodeableConcept setPrognosisCodeableConcept addPrognosisCodeableConcept hasPrognosisCodeableConcept getPrognosisReference setPrognosisReference addPrognosisReference hasPrognosisReference getSupportingInfo setSupportingInfo addSupportingInfo hasSupportingInfo getNote setNote addNote hasNote 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 initProblem initInvestigation initProtocol initFinding initPrognosisCodeableConcept initPrognosisReference initSupportingInfo initNote

    Constructors

    Properties

    identifier?: Identifier[]

    ClinicalImpression.identifier Element

    FHIR Specification

    • Short: Business identifier
    • Definition: Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • Requirements: Allows identification of the clinical impression as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    eventStatusEnum: EventStatusEnum

    FHIR CodeSystem: EventStatus

    EventStatusEnum

    status: null | EnumCodeType

    ClinicalImpression.status Element

    FHIR Specification

    • Short: in-progress | completed | entered-in-error
    • Definition: Identifies the workflow status of the assessment.
    • Comment: This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical impression as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: EventStatusEnum

    statusReason?: CodeableConcept

    ClinicalImpression.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current state of the ClinicalImpression.
    • Comment: This is generally only used for "exception" statuses such as "not-done", "suspended" or "cancelled". [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    ClinicalImpression.code Element

    FHIR Specification

    • Short: Kind of assessment performed
    • Definition: Categorizes the type of clinical assessment performed.
    • Comment: This is present as a place-holder only and may be removed based on feedback/work group opinion.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    ClinicalImpression.description Element

    FHIR Specification

    • Short: Why/how the assessment was performed
    • Definition: A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    ClinicalImpression.subject Element

    FHIR Specification

    encounter?: Reference

    ClinicalImpression.encounter Element

    FHIR Specification

    • Short: Encounter created as part of
    • Definition: The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
    • Comment: This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    effective?: IDataType

    ClinicalImpression.effective[x] Element

    @ChoiceDataTypesMeta('ClinicalImpression.effective[x]', ['dateTime','Period',]

    FHIR Specification

    • Short: Time of assessment
    • Definition: The point in time or period over which the subject was assessed.
    • Comment: This SHOULD be accurate to at least the minute, though some assessments only have a known date.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    ClinicalImpression.date Element

    FHIR Specification

    • Short: When the assessment was documented
    • Definition: Indicates when the documentation of the assessment was complete.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    assessor?: Reference

    ClinicalImpression.assessor Element

    FHIR Specification

    previous?: Reference

    ClinicalImpression.previous Element

    FHIR Specification

    • Short: Reference to last assessment
    • Definition: A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
    • Comment: It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    problem?: Reference[]

    ClinicalImpression.problem Element

    FHIR Specification

    investigation?: ClinicalImpressionInvestigationComponent[]

    ClinicalImpression.investigation Element

    FHIR Specification

    • Short: One or more sets of investigations (signs, symptoms, etc.)
    • Definition: One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    protocol?: UriType[]

    ClinicalImpression.protocol Element

    FHIR Specification

    • Short: Clinical Protocol followed
    • Definition: Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    summary?: StringType

    ClinicalImpression.summary Element

    FHIR Specification

    • Short: Summary of the assessment
    • Definition: A text summary of the investigations and the diagnosis.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    finding?: ClinicalImpressionFindingComponent[]

    ClinicalImpression.finding Element

    FHIR Specification

    • Short: Possible or likely findings and diagnoses
    • Definition: Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    prognosisCodeableConcept?: CodeableConcept[]

    ClinicalImpression.prognosisCodeableConcept Element

    FHIR Specification

    • Short: Estimate of likely outcome
    • Definition: Estimate of likely outcome.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    prognosisReference?: Reference[]

    ClinicalImpression.prognosisReference Element

    FHIR Specification

    supportingInfo?: Reference[]

    ClinicalImpression.supportingInfo Element

    FHIR Specification

    • Short: Information supporting the clinical impression
    • Definition: Information supporting the clinical impression.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    ClinicalImpression.note Element

    FHIR Specification

    • Short: Comments made about the ClinicalImpression
    • Definition: Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.
    • Comment: Don't use this element for content that should more properly appear as one of the specific elements of the impression.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClinicalImpression

      • OptionaloptSourceField: string

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

      Returns undefined | ClinicalImpression

      ClinicalImpression data model or undefined for ClinicalImpression

      JsonError if the provided JSON is not a valid JSON object

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonhasStatusReasongetCodesetCodehasCodegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetEffectivesetEffectivehasEffectivegetEffectiveDateTimeTypehasEffectiveDateTimeTypegetEffectivePeriodhasEffectivePeriodgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetAssessorsetAssessorhasAssessorgetPrevioussetPrevioushasPreviousgetProblemsetProblemaddProblemhasProblemgetInvestigationsetInvestigationaddInvestigationhasInvestigationgetProtocolElementsetProtocolElementaddProtocolElementhasProtocolElementgetProtocolsetProtocoladdProtocolhasProtocolgetSummaryElementsetSummaryElementhasSummaryElementgetSummarysetSummaryhasSummarygetFindingsetFindingaddFindinghasFindinggetPrognosisCodeableConceptsetPrognosisCodeableConceptaddPrognosisCodeableConcepthasPrognosisCodeableConceptgetPrognosisReferencesetPrognosisReferenceaddPrognosisReferencehasPrognosisReferencegetSupportingInfosetSupportingInfoaddSupportingInfohasSupportingInfogetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitProbleminitInvestigationinitProtocolinitFindinginitPrognosisCodeableConceptinitPrognosisReferenceinitSupportingInfoinitNote