Data Model Libraries
    Preparing search index...

    ResearchStudyRecruitmentComponent Class

    FHIR Specification

    • Short: Target or actual group of participants enrolled in study
    • Definition: Target or actual group of participants enrolled in study.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    targetNumber?: UnsignedIntType

    ResearchStudy.recruitment.targetNumber Element

    FHIR Specification

    • Short: Estimated total number of participants to be enrolled
    • Definition: Estimated total number of participants to be enrolled.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    actualNumber?: UnsignedIntType

    ResearchStudy.recruitment.actualNumber Element

    FHIR Specification

    • Short: Actual total number of participants enrolled in study
    • Definition: Actual total number of participants enrolled in study.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    eligibility?: Reference

    ResearchStudy.recruitment.eligibility Element

    FHIR Specification

    actualGroup?: Reference

    ResearchStudy.recruitment.actualGroup Element

    FHIR Specification

    • Short: Group of participants who were enrolled in study
    • Definition: Group of participants who were enrolled in study.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchStudyRecruitmentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchStudyRecruitmentComponent

      ResearchStudyRecruitmentComponent data model or undefined for ResearchStudyRecruitmentComponent

      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