Data Model Libraries
    Preparing search index...

    Class RiskAssessment

    RiskAssessment Class

    An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

    FHIR Specification

    • Short: Potential outcomes for a subject with likelihood
    • Definition: An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
    • FHIR Version: 4.0.1

    FHIR RiskAssessment

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? parent? observationStatusEnum status method? code? subject encounter? occurrence? condition? performer? reasonCode? reasonReference? basis? prediction? mitigation? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn hasBasedOn getParent setParent hasParent getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getMethod setMethod hasMethod getCode setCode hasCode getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getCondition setCondition hasCondition getPerformer setPerformer hasPerformer getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getBasis setBasis addBasis hasBasis getPrediction setPrediction addPrediction hasPrediction getMitigationElement setMitigationElement hasMitigationElement getMitigation setMitigation hasMitigation 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 initReasonCode initReasonReference initBasis initPrediction initNote

    Constructors

    Properties

    identifier?: Identifier[]

    RiskAssessment.identifier Element

    FHIR Specification

    • Short: Unique identifier for the assessment
    • Definition: Business identifier assigned to the risk assessment.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference

    RiskAssessment.basedOn Element

    FHIR Specification

    • Short: Request fulfilled by this assessment
    • Definition: A reference to the request that is fulfilled by this risk assessment.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    parent?: Reference

    RiskAssessment.parent Element

    FHIR Specification

    • Short: Part of this occurrence
    • Definition: A reference to a resource that this risk assessment is part of, such as a Procedure.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    observationStatusEnum: ObservationStatusEnum

    FHIR CodeSystem: ObservationStatus

    ObservationStatusEnum

    status: null | EnumCodeType

    RiskAssessment.status Element

    FHIR Specification

    • Short: registered | preliminary | final | amended +
    • Definition: The status of the RiskAssessment, using the same statuses as an Observation.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ObservationStatusEnum

    method?: CodeableConcept

    RiskAssessment.method Element

    FHIR Specification

    • Short: Evaluation mechanism
    • Definition: The algorithm, process or mechanism used to evaluate the risk.
    • Requirements: The method can influence the results of the assessment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept

    RiskAssessment.code Element

    FHIR Specification

    • Short: Type of assessment
    • Definition: The type of the risk assessment performed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    RiskAssessment.subject Element

    FHIR Specification

    encounter?: Reference

    RiskAssessment.encounter Element

    FHIR Specification

    • Short: Where was assessment performed?
    • Definition: The encounter where the assessment was performed.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    occurrence?: IDataType

    RiskAssessment.occurrence[x] Element

    @ChoiceDataTypesMeta('RiskAssessment.occurrence[x]', ['dateTime','Period',]

    FHIR Specification

    • Short: When was assessment made?
    • Definition: The date (and possibly time) the risk assessment was performed.
    • Requirements: The assessment results lose validity the more time elapses from when they are first made.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    condition?: Reference

    RiskAssessment.condition Element

    FHIR Specification

    • Short: Condition assessed
    • Definition: For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: Reference

    RiskAssessment.performer Element

    FHIR Specification

    reasonCode?: CodeableConcept[]

    RiskAssessment.reasonCode Element

    FHIR Specification

    • Short: Why the assessment was necessary?
    • Definition: The reason the risk assessment was performed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    RiskAssessment.reasonReference Element

    FHIR Specification

    basis?: Reference[]

    RiskAssessment.basis Element

    FHIR Specification

    • Short: Information used in assessment
    • Definition: Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    prediction?: RiskAssessmentPredictionComponent[]

    RiskAssessment.prediction Element

    FHIR Specification

    • Short: Outcome predicted
    • Definition: Describes the expected outcome for the subject.
    • Comment: Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    mitigation?: StringType

    RiskAssessment.mitigation Element

    FHIR Specification

    • Short: How to reduce risk
    • Definition: A description of the steps that might be taken to reduce the identified risk(s).
    • Requirements: One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    RiskAssessment.note Element

    FHIR Specification

    • Short: Comments on the risk assessment
    • Definition: Additional comments about the risk assessment.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR RiskAssessment

      • OptionaloptSourceField: string

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

      Returns undefined | RiskAssessment

      RiskAssessment data model or undefined for RiskAssessment

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the reasonReference property.

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('RiskAssessment.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the reasonReference array property.

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('RiskAssessment.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBasedOnsetBasedOnhasBasedOngetParentsetParenthasParentgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetMethodsetMethodhasMethodgetCodesetCodehasCodegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetOccurrencesetOccurrencehasOccurrencegetOccurrenceDateTimeTypehasOccurrenceDateTimeTypegetOccurrencePeriodhasOccurrencePeriodgetConditionsetConditionhasConditiongetPerformersetPerformerhasPerformergetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetBasissetBasisaddBasishasBasisgetPredictionsetPredictionaddPredictionhasPredictiongetMitigationElementsetMitigationElementhasMitigationElementgetMitigationsetMitigationhasMitigationgetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitReasonCodeinitReasonReferenceinitBasisinitPredictioninitNote