Data Model Libraries
    Preparing search index...

    Class ResearchStudyAssociatedPartyComponent

    ResearchStudyAssociatedPartyComponent Class

    FHIR Specification

    • Short: Sponsors, collaborators, and other parties
    • Definition: Sponsors, collaborators, and other parties.
    • Comment: For a Sponsor or a PrincipalInvestigator use the dedicated attributes provided.
    • Requirements: While there are explicit attributes for a Sponsor and a PrincipalInvestigator many trial record a range of other organizations and individuals in key roles.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name?: StringType

    FHIR Specification

    • Short: Name of associated party
    • Definition: Name of associated party.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    role: null | CodeableConcept

    ResearchStudy.associatedParty.role Element

    FHIR Specification

    • Short: sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair
    • Definition: Type of association.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    period?: Period[]

    ResearchStudy.associatedParty.period Element

    FHIR Specification

    • Short: When active in the role
    • Definition: Identifies the start date and the end date of the associated party in the role.
    • Comment: The cardinality is 0..* due to the fact that an associated party may be intermittently active in a given role over multiple time periods.
    • FHIR Type: Period
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    classifier?: CodeableConcept[]

    ResearchStudy.associatedParty.classifier Element

    FHIR Specification

    • Short: nih | fda | government | nonprofit | academic | industry
    • Definition: A categorization other than role for the associated party.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    party?: Reference

    ResearchStudy.associatedParty.party Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchStudyAssociatedPartyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchStudyAssociatedPartyComponent

      ResearchStudyAssociatedPartyComponent data model or undefined for ResearchStudyAssociatedPartyComponent

      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