Data Model Libraries
    Preparing search index...

    Class ResearchStudyProgressStatusComponent

    ResearchStudyProgressStatusComponent Class

    FHIR Specification

    • Short: Status of study with time for that status
    • Definition: Status of study with time for that status.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    state: null | CodeableConcept

    ResearchStudy.progressStatus.state Element

    FHIR Specification

    • Short: Label for status or state (e.g. recruitment status)
    • Definition: Label for status or state (e.g. recruitment status).
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    actual?: BooleanType

    ResearchStudy.progressStatus.actual Element

    FHIR Specification

    • Short: Actual if true else anticipated
    • Definition: An indication of whether or not the date is a known date when the state changed or will change. A value of true indicates a known date. A value of false indicates an estimated date.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period?: Period

    ResearchStudy.progressStatus.period Element

    FHIR Specification

    • Short: Date range
    • Definition: Date range.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchStudyProgressStatusComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchStudyProgressStatusComponent

      ResearchStudyProgressStatusComponent data model or undefined for ResearchStudyProgressStatusComponent

      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