Data Model Libraries
    Preparing search index...

    Class EvidenceReportSubjectCharacteristicComponent

    EvidenceReportSubjectCharacteristicComponent Class

    FHIR Specification

    • Short: Characteristic
    • Definition: Characteristic.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableConcept

    EvidenceReport.subject.characteristic.code Element

    FHIR Specification

    • Short: Characteristic code
    • Definition: Characteristic code.
    • Comment: Example 1 is a Citation. Example 2 is a type of outcome. Example 3 is a specific outcome.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value: null | IDataType

    EvidenceReport.subject.characteristic.value[x] Element

    @ChoiceDataTypesMeta('EvidenceReport.subject.characteristic.value[x]', ['Reference','CodeableConcept','boolean','Quantity','Range',]

    FHIR Specification

    • Short: Characteristic value
    • Definition: Characteristic value.
    • Comment: Example 1 is Citation #37. Example 2 is selecting clinical outcomes. Example 3 is 1-year mortality.
    • FHIR Types: 'Reference', 'CodeableConcept', 'boolean', 'Quantity', 'Range',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    exclude?: BooleanType

    EvidenceReport.subject.characteristic.exclude Element

    FHIR Specification

    • Short: Is used to express not the characteristic
    • Definition: Is used to express not the characteristic.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period?: Period

    EvidenceReport.subject.characteristic.period Element

    FHIR Specification

    • Short: Timeframe for the characteristic
    • Definition: Timeframe for the characteristic.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceReportSubjectCharacteristicComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceReportSubjectCharacteristicComponent

      EvidenceReportSubjectCharacteristicComponent data model or undefined for EvidenceReportSubjectCharacteristicComponent

      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