IMPORTANT Introduced as part of the 2023-07-06 release, the base path URL for BC API endpoints have changed with versioning. The endpoints remain unchanged. See technical details in Biomedical Concepts & Specializations.

All access inquires, technical support tickets, comments, and general CDISC Library questions, please use the CDISC Library Product Inquiry form.

The base URL for the API is:

https://library.cdisc.org/api

The URL for Data Standards Browser is:

https://library.cdisc.org/browser

CDISC Biomedical Concept (BC) API endpoints are now versioned, a change that was introduced in the release on 2023-07-06. For more information, go to Biomedical Concepts & Specializations.

https://library.cdisc.org/api/cosmos/v2
https://library.cdisc.org/api/cosmos/v1

Note that v2 endpoints are recommended. v1 is for legacy support. A 404 HTTP error will occur when attempting to access BC endpoints without specifying the version.

The CDISC Library API generally follows HTTP/1.1's guidelines for status code. Details are here: HTTP Status Codes.

The REST API uses API key authentication.

Note, support for Basic Auth is deprecated as of the 2020-11-11 release. For an interactive walk-through, refer to the video posted on https://www.cdisc.org/cdisc-library/getting-started, starting at 00:44:38.

UPDATED The following standards have been loaded:

• CDISC Controlled Terminology P19 (2014-09-26) to P55 (2022-09-29), a total of 36 quarters with 163 parts
• CDASH v1.1.1/CDASHUG v1.0, CDASH Model v1.0 to v1.3*, CDASHIG v2.0 to v2.3*
• SDTM v1.2 to v2.0, SDTMIG v3.1.2 to v3.4, SDTMIG-AP v1.0, SDTMIG-MD v1.0, SDTMIG-MD v1.1
• SENDIG v3.0, SENDIG v3.1.1, SENDIG-DART v1.1, SENDIG-AR v1.0
• ADaM v2.1, ADaMIG v1.0 to v1.3, ADaM ADAE v1.0, ADaM TTE for BDS v1.0, ADaM OCCDS v1.0 to v1.1, ADaMIG MD v1.0, ADaMIG NCA v1.0, ADaM popPK v1.0*
  
• QRS Supplements to SDTMIG: AIMS, APACHE II, ATLAS, HAM-A, KFSS, KPS SCALE, SIX MINUTE WALK, CGI, PGI
• Biomedical Concepts & SDTM Specializations: Package 5, a total of 208 BCs and 171 SDTM Dataset Specializations, including adverse events, demographics, imaging, and laboratory tests

* denotes new contents added to the 2023-10-12 and 2023-11-06 releases

UPDATED Included in the 2023-10-12 and 2023-11-06 releases are:

Enhancements

Feature

• N/A

Contents

• ADaM popPK v1.0, promoted from Draft Content to Final
• CDASH Model v1.3 and CDASHIG v2.3, promoted from Draft Content to Final

Data Standards Browser

• N/A for this release.

Corrections & Patches

• N/A for this release.

Deprecations

• N/A for this release.

For system maintenance status, use this endpoint to obtain a flag indicating whether CDISC Library is under maintenance and a related system message:

/mdr/maintenance

For example,

{
  "maintenanceMode": true,
  "maintenanceMessage": "CDISC Library is currently under a scheduled maintenance."
}

For a machine-readable method to obtain a full listing of products loaded into the metadata repository use:

/mdr/products

Or, by product group:

/mdr/products/{product-group}

where product-group is one of these values:

• Terminology
• DataCollection
• DataTabulation
• DataAnalysis
• DraftContent*

* denotes new parameter added as of the 2021-03-30 release

Included in the 2020-02-14 release are two new endpoints, designed to provide high-level information about CDISC Library. These endpoints support both JSON and XML media types.

First, /mdr/about returns the URL for on-line API Documentation and Release Notes. It also includes a hypermedia link to a list of the product groups with their most recent update dates, as described below.

/mdr/about

/mdr/lastupdated returns dates of last updated, organized by CDISC product group.

/mdr/lastupdated

For example:

{
  "_links": {
    "self": {
      "href": "/mdr/about",
      "title": "Information About CDISC Library",
      "type": "About CDISC Library"
    },
    "lastupdated": {
      "href": "/mdr/lastupdated",
      "title": "Last Update Date of CDISC Library Products",
      "type": "About CDISC Library"
    }
  },
  "release-notes": "https://wiki.cdisc.org/display/LIBSUPRT/Release+Notes",
  "api-documentation": "https://www.cdisc.org/cdisc-library/api-documentation"
}

{
  "_links": {
    "self": {
      "href": "/mdr/lastupdated",
      "title": "Last Update Date of CDISC Library Products",
      "type": "About CDISC Library"
    }
  },
  "overall": "2020-02-14",
  "data-analysis": "2020-02-14",
  "data-collection": "2020-02-14",
  "data-tabulation": "2019-11-18",
  "terminology": "2020-02-14"
}

Added to the 2021-06-28 release is the support for ODM-XML, as a beta functionality. The media type for ODM-XML is application/odm+xml. For CDASHIG, users will receive an ODM v1.3.2 document as the response payload. For ADaMIG, SDTMIG, and SENDIG, user will receive a Define-XML v2.1 document.

For example, a cURL snippet to obtain ADaM OCCDS v1.0 (lines #1-3), SDTMIG v3.3 (lines #5-7) in ODM format. The outputs are in Define-XML v2.1:

curl -X GET \
  https://library.cdisc.org/api/mdr/adam/adam-occds-1-0 \
  -H 'Accept: application/odm+xml'

curl -X GET \
  https://library.cdisc.org/api/mdr/sdtmig/3-3 \
  -H 'Accept: application/odm+xml'

Another cURL snippet to obtain CDASHIG v2.1 in ODM format. The output is in ODM v1.3.2:

curl -X GET \
  https://library.cdisc.org/api/mdr/cdashig/2-1 \
  -H 'Accept: application/odm+xml'

Below is a cURL snippet to obtain ADaM OCCDS v1.0 (lines #1-3), SDTMIG v3.3 (lines #5-7), and Controlled Terminology P38 (lines #9-11) in CSV format:

curl -X GET \
  https://library.cdisc.org/api/mdr/adam/adam-occds-1-0 \
  -H 'Accept: text/csv'

curl -X GET \
  https://library.cdisc.org/api/mdr/sdtmig/3-3 \
  -H 'Accept: text/csv'

curl -X GET \
  https://library.cdisc.org/api/mdr/ct/packages/sdtmct-2019-06-28 \
  -H 'Accept: text/csv'

Similarly, a cURL snippet to obtain ADaM OCCDS v1.0 (lines #1-3) , SDTMIG v3.3 (lines #5-7), and Controlled Terminology P38 (lines #9-11) in Excel Workbook format:

curl -X GET \
  https://library.cdisc.org/api/mdr/adam/adam-occds-1-0 \
  -H 'Accept: application/vnd.ms-excel'

curl -X GET \
  https://library.cdisc.org/api/mdr/sdtmig/3-3 \
  -H 'Accept: application/vnd.ms-excel'

curl -X GET \
  https://library.cdisc.org/api/mdr/ct/packages/sdtmct-2019-06-28 \
  -H 'Accept: application/vnd.ms-excel'

Starting 2021-03-30, users can access draft contents through CDISC Library. Draft contents are point-in-time snapshots, before they become official publication. Although may not be suitable for production use, draft contents are helpful toward evaluation and public reviews.

Whenever mid-cycle revision to CDISC Controlled Terminology publication is necessary, only the latest corrected information will appear in the metadata repository.

The earliest CDISC Controlled Terminology publication loaded into the metadata repository is P19 (2014-09-26). With that, _links/priorVersion will not be part of the API response when querying P19 packages. CDISC will evaluate loading prior publications based on demand and requests.

For CDISC Controlled Terminology, NCI EVS publishes synonyms in a semi-colon separated list. In the metadata repository, they are decoded into individual entries. In rare cases where synonyms are non-unique for any given term, only distinct synonyms will appear in the metadata repository.

When querying using the API, lexicographic order is applied to synonyms listing in the response. For example, this is a response excerpt when querying the term Left Ventricular Maximum Positive dP/dt (C120916):

{
   "conceptId": "C120916",
   "submissionValue": "Left Ventricular Maximum Positive dP/dt",
   "definition": "The maximum rate of positive pressure change over time within the left ventricle (systole).",
   "preferredTerm": "Left Ventricular Maximum Positive dP/dt",
   "synonyms": [
      "+dPdt",
      "Left Ventricular Maximum Positive dP/dt",
      "dPdt Maximum"
   ]
}

In the CDISC Controlled Terminology Protocol package, where the Codelist Extensible (Yes/No) attribute reads "NA", they are treated as null in the metadata repository.

All instances of "N/A" in CDASH publications are treated as null in the metadata repository.

An exception is the "Controlled Terminology Codelist Name" column exported in the CSV and Excel formats to preserve original sequence of codelist values as shown in the published document.

In the CDASH Model v1.0 and the CDASHIG v2.0, the CDASH team applied the class concept to all domains. Identifier and timing variables were assigned class Identifier and Timing respectively as an attribute. In order to offer one common API design for all CDASH products, it was necessary to apply this class concept to CDASHIG v1.1 domains. In consequence, "Common variables" (identifier and visit timing variables in Sections 5.1, 5.2) were also instantiated to all CDASHIG v1.1 domains.

These changes were presented to and approved by the CDISC Global Governance Committee. For these changes, a new version indicator, 1.1.1, is given in the metadata repository.

The CDASH products include different types of mappings:

• CDASH model class variables to SDTM class variables
• CDASH model class variables to SDTM dataset variables
• CDASH model domain variables to SDTM dataset variables
• CDASH model domain variables to SDTMIG dataset variables
• CDASHIG domain fields to SDTMIG dataset variables
• CDASHIG domain fields to SDTM class variables
• CDASHIG scenario fields to SDTMIG dataset variables

To accommodate the different types of mapping targets, three JSON array attributes had to be defined:

• sdtmClassMappingTargets
• sdtmDatasetMappingTargets
• sdtmigDatasetMappingTargets
  

For CDASH Model v1.2 and CDASHIG v2.2, where applicable:

• Class description is added using definitions from CDISC CT.
• Domain description is added using definitions from CDISC CT.
• Class name is adjusted from "Findings About" to "Findings about Events and Interventions" to match source content, i.e., CDISC Wiki space.

Variables in the SDTM occasionally have expanded text to describe a variable's role. This text is stored in "roleDescription" in the metadata repository. Otherwise, "roleDescription" matches "role", where "role" has a set of controlled values. Below is an example for the SDTM v1.5 variable SVUPDES:

"ordinal": "11", 
"name": "SVUPDES", 
"label": "Description of Unplanned Visit", 
"description": "Description of what happened to the subject during an unplanned visit. Null for protocol-defined visits.", 
"role": "Qualifier", 
"roleDescription": "Optional Qualifier", 
...

Some Implementation Guide variables have multiple CDISC Controlled Terminology codelists. Therefore, an array object is used to output codelist metadata in an API response. For example, this is an excerpt when querying the SENDIG v3.1 variable MISTRESC:

"codelist": [ 
  { 
    "href": "/mdr/root/ct/sendct/codelists/C88025", 
    "title": "Version-agnostic anchor resource for codelist C88025", 
    "type": "Root Value Domain" 
  }, 
  { 
    "href": "/mdr/root/ct/sendct/codelists/C120531", 
    "title": "Version-agnostic anchor resource for codelist C120531", 
    "type": "Root Value Domain" 
  } 
]

To promote consistency, the label "ISO 3166-1 Alpha-3" is used whenever this external country codelist is referenced. Similarly, "ISO 21090 NullFlavor enumeration" is used for null flavors.