Data Model Libraries
    Preparing search index...

    ResearchSubjectProgressComponent Class

    FHIR Specification

    • Short: Subject status
    • Definition: The current state (status) of the subject and resons for status change where appropriate.
    • Comment: This is intended to deal with the confusion routinely created by haing two conflated concepts of being in a particular state and having achieved a particular milestone. In strict terms a milestone is a point of time event that results in a change from one state to another. The state before the milestone is achieved is often given the same name as the milestone, and sometimes the state may have the same description. For instance "Randomised" and "Visit 1" may be different milestones but the state remains at "on study" after each of them. It is likely that more than one "state" pattern will be recorded for a subject and a type has been introduced to allow this simultaneous recording.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ResearchSubject.progress.type Element

    FHIR Specification

    • Short: state | milestone
    • Definition: Identifies the aspect of the subject's journey that the state refers to.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subjectState?: CodeableConcept

    ResearchSubject.progress.subjectState Element

    FHIR Specification

    • Short: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
    • Definition: The current state of the subject.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    milestone?: CodeableConcept

    ResearchSubject.progress.milestone Element

    FHIR Specification

    • Short: SignedUp | Screened | Randomized
    • Definition: The milestones the subject has passed through.
    • Comment: There can be multiple entries but it is also valid to just have the most recent. This should npt be rlied upon as the full path the subject has taken.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ResearchSubject.progress.reason Element

    FHIR Specification

    • Short: State change reason
    • Definition: The reason for the state change. If coded it should follow the formal subject state model.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    startDate?: DateTimeType

    ResearchSubject.progress.startDate Element

    FHIR Specification

    • Short: State change date
    • Definition: The date when the new status started.
    • Comment: This is NOT the date the change in state was recorded.
    • Requirements: This was originally defined as the date when the change in status occurred. This assumed all states were recorded which is not true. Hence the need to track the end of the state.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    endDate?: DateTimeType

    ResearchSubject.progress.endDate Element

    FHIR Specification

    • Short: State change date
    • Definition: The date when the state ended.
    • Requirements: See the requirement on the start date.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchSubjectProgressComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchSubjectProgressComponent

      ResearchSubjectProgressComponent data model or undefined for ResearchSubjectProgressComponent

      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