Data Model Libraries
    Preparing search index...

    Class ObservationReferenceRangeComponent

    ObservationReferenceRangeComponent Class

    FHIR Specification

    • Short: Provides guide for interpretation
    • Definition: Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.
    • 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 Observation

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    low? high? type_? appliesTo? age? text?

    Methods

    parse getLow setLow hasLow getHigh setHigh hasHigh getType setType hasType getAppliesTo setAppliesTo addAppliesTo hasAppliesTo getAge setAge hasAge getTextElement setTextElement hasTextElement getText setText hasText fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initAppliesTo

    Constructors

    Properties

    low?: Quantity

    Observation.referenceRange.low Element

    FHIR Specification

    • Short: Low Range, if relevant
    • Definition: The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    high?: Quantity

    Observation.referenceRange.high Element

    FHIR Specification

    • Short: High Range, if relevant
    • Definition: The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionaltype_

    type_?: CodeableConcept

    Observation.referenceRange.type Element

    FHIR Specification

    • Short: Reference range qualifier
    • Definition: Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
    • Comment: This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.
    • Requirements: Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    appliesTo?: CodeableConcept[]

    Observation.referenceRange.appliesTo Element

    FHIR Specification

    • Short: Reference range population
    • Definition: Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
    • Comment: This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.
    • Requirements: Need to be able to identify the target population for proper interpretation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    age?: Range

    Observation.referenceRange.age Element

    FHIR Specification

    • Short: Applicable age range, if relevant
    • Definition: The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
    • Requirements: Some analytes vary greatly over age.
    • FHIR Type: Range
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionaltext

    text?: StringType

    Observation.referenceRange.text Element

    FHIR Specification

    • Short: Text based reference range in an observation
    • Definition: Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ObservationReferenceRangeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ObservationReferenceRangeComponent

      ObservationReferenceRangeComponent data model or undefined for ObservationReferenceRangeComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; 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