Options
All
  • Public
  • Public/Protected
  • All
Menu

CodeList class.

Hierarchy

  • BasicFunctions
    • CodeList

Index

Constructors

constructor

  • new CodeList(__namedParameters?: CodeListParameters): CodeList
  • Parameters

    • __namedParameters: CodeListParameters = {}

    Returns CodeList

Properties

Optional conceptId

conceptId: string

CDISC Library attribute.

coreObject

coreObject: CoreObject

CLA Wrapper attribute. Object used to send API requests and store technical information. Must be the same object for all classes within an instance of a CdiscLibrary class.

Optional definition

definition: string

CDISC Library attribute.

Optional extensible

extensible: boolean

CDISC Library attribute.

Optional href

href: string

CDISC Library API endpoint.

Optional name

name: string

CDISC Library attribute.

Optional preferredTerm

preferredTerm: string

CDISC Library attribute.

Optional submissionValue

submissionValue: string

CDISC Library attribute.

Optional synonyms

synonyms: string[]

CDISC Library attribute.

Optional terms

terms: Term[]

CDISC Library attribute.

Methods

getFormattedTerms

  • getFormattedTerms(format?: "json" | "csv"): string | Term[]
  • Get codelist terms in a specific format.

    Parameters

    • format: "json" | "csv" = 'json'

    Returns string | Term[]

    Formatted codeList terms.

getRawResponse

  • getRawResponse(href?: string): Promise<object>
  • Get raw API response

    Parameters

    • Optional href: string

      CDISC Library API endpoint. If not specified, href attribute of the object is used.

    Returns Promise<object>

    Returns a JSON response if the request was successfull, otherwise returns undefined.

getVersions

  • getVersions(): Promise<string[]>
  • Get the list of codelist versions.

    Returns Promise<string[]>

    List of CT versions.

load

  • load(href?: string): Promise<boolean>
  • Load object from the CDISC Library

    Parameters

    • Optional href: string

      CDISC Library API endpoint. If not specified, href attribute of the object is used.

    Returns Promise<boolean>

    Returns true in the object was successfully loaded, false otherwise

parseResponse

  • parseResponse(clRaw: any, nciSiteResponse?: boolean): void
  • Parse API response to codelist.

    Parameters

    • clRaw: any

      Raw CDISC API response.

    • nciSiteResponse: boolean = false

      Indicates whether the reponse is from the NCI site

    Returns void

toSimpleObject

  • toSimpleObject(): any
  • Convert class to a simple object, removes methods and technical elements (e.g., coreObject).

    Returns any

    A new object

Generated using TypeDoc