Data Model Libraries
    Preparing search index...

    Class ObservationDefinitionComponentComponent

    ObservationDefinitionComponentComponent Class

    FHIR Specification

    • Short: Component results
    • Definition: Some observations have multiple component observations, expressed as separate code value pairs.
    • Requirements: Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableConcept

    ObservationDefinition.component.code Element

    FHIR Specification

    • Short: Type of observation
    • Definition: Describes what will be observed.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    permittedDataTypeEnum: PermittedDataTypeEnum

    FHIR CodeSystem: PermittedDataType

    permittedDataType?: EnumCodeType[]

    ObservationDefinition.component.permittedDataType Element

    FHIR Specification

    • Short: Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
    • Definition: The data types allowed for the value element of the instance of this component observations.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: PermittedDataTypeEnum

    permittedUnit?: Coding[]

    ObservationDefinition.component.permittedUnit Element

    FHIR Specification

    • Short: Unit for quantitative results
    • Definition: Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ObservationDefinition.component.qualifiedValue Element

    FHIR Specification

    • Short: Set of qualified values for observation results
    • Definition: A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ObservationDefinitionComponentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ObservationDefinitionComponentComponent

      ObservationDefinitionComponentComponent data model or undefined for ObservationDefinitionComponentComponent

      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