Data Model Libraries
    Preparing search index...

    Class ObservationComponentComponent

    ObservationComponentComponent Class

    FHIR Specification

    • Short: Component results
    • Definition: Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
    • Comment: For a discussion on the ways Observations can be assembled in groups together see Notes below.
    • Requirements: Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

    FHIR Observation

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    code value? dataAbsentReason? interpretation? referenceRange?

    Methods

    parse getCode setCode hasCode getValue setValue hasValue getValueQuantity hasValueQuantity getValueCodeableConcept hasValueCodeableConcept getValueStringType hasValueStringType getValueBooleanType hasValueBooleanType getValueIntegerType hasValueIntegerType getValueRange hasValueRange getValueRatio hasValueRatio getValueSampledData hasValueSampledData getValueTimeType hasValueTimeType getValueDateTimeType hasValueDateTimeType getValuePeriod hasValuePeriod getValueAttachment hasValueAttachment getValueReference hasValueReference getDataAbsentReason setDataAbsentReason hasDataAbsentReason getInterpretation setInterpretation addInterpretation hasInterpretation getReferenceRange setReferenceRange addReferenceRange hasReferenceRange fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initInterpretation initReferenceRange

    Constructors

    Properties

    code: null | CodeableConcept

    Observation.component.code Element

    FHIR Specification

    • Short: Type of component observation (code / type)
    • Definition: Describes what was observed. Sometimes this is called the observation "code".
    • Comment: All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.
    • Requirements: Knowing what kind of observation is being made is essential to understanding the observation.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    value?: IDataType

    Observation.component.value[x] Element

    @ChoiceDataTypesMeta('Observation.component.value[x]', ['Quantity','CodeableConcept','string','boolean','integer','Range','Ratio','SampledData','time','dateTime','Period','Attachment','Reference',]

    FHIR Specification

    • Short: Actual component result
    • Definition: The information determined as a result of making the observation, if the information has a simple value.
    • Comment: Used when observation has a set of component observations: - An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). - If a value is present, the datatype for this element should be determined by the code. - CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value. - Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom. - If a value is present, the datatype for this element should be determined by the code. - CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the code defines a coded value. - Attachment is used if the observation result value is a binary file such as an image. If the observation result value is derived from the binary file (for example 'X' detected and here is the the proof in this image), the binary file may be directly represented using DocumentReference and referenced by derivedFrom. - The usage of valueReference is restricted to the MolecularSequence resource when used as a definitional resource, not as a patient-specific finding. . - For additional guidance, see the Notes section below.
    • Requirements: An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.
    • FHIR Types: 'Quantity', 'CodeableConcept', 'string', 'boolean', 'integer', 'Range', 'Ratio', 'SampledData', 'time', 'dateTime', 'Period', 'Attachment', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    dataAbsentReason?: CodeableConcept

    Observation.component.dataAbsentReason Element

    FHIR Specification

    • Short: Why the component result is missing
    • Definition: Provides a reason why the expected value in the element Observation.component.value[x] is missing.
    • Comment: "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.
    • Requirements: For many results it is necessary to handle exceptional values in measurements.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    interpretation?: CodeableConcept[]

    Observation.component.interpretation Element

    FHIR Specification

    • Short: High, low, normal, etc
    • Definition: A categorical assessment of an observation value. For example, high, low, normal.
    • Comment: Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.
    • Requirements: For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    referenceRange?: ObservationReferenceRangeComponent[]

    Observation.component.referenceRange Element

    FHIR Specification

    • Short: Provides guide for interpretation of component result
    • Definition: Guidance on how to interpret the value by comparison to a normal or recommended range.
    • Comment: Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
    • Requirements: Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ObservationComponentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ObservationComponentComponent

      ObservationComponentComponent data model or undefined for ObservationComponentComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetCodesetCodehasCodegetValuesetValuehasValuegetValueQuantityhasValueQuantitygetValueCodeableConcepthasValueCodeableConceptgetValueStringTypehasValueStringTypegetValueBooleanTypehasValueBooleanTypegetValueIntegerTypehasValueIntegerTypegetValueRangehasValueRangegetValueRatiohasValueRatiogetValueSampledDatahasValueSampledDatagetValueTimeTypehasValueTimeTypegetValueDateTimeTypehasValueDateTimeTypegetValuePeriodhasValuePeriodgetValueAttachmenthasValueAttachmentgetValueReferencehasValueReferencegetDataAbsentReasonsetDataAbsentReasonhasDataAbsentReasongetInterpretationsetInterpretationaddInterpretationhasInterpretationgetReferenceRangesetReferenceRangeaddReferenceRangehasReferenceRangefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitInterpretationinitReferenceRange