Page History

...

Info

title	News and updates

2021-03-30: New contents, editorial updates
2020-11-11: Next Generation CDISC Library
2020-07-07: New contents, new endpoint, metadata adjustments for ADaM
2020-02-14: New contents, new endpoints, editorial updates

Expand

title	History Prior to 2020...

2019-11-18: New contents, bug fixes, minor browser patch
2019-09-13: Data standards browser as a new functionality
2019-07-18: Search API, CSV & Excel exports, new and updated contents, and documentation updates
2019-04-10: New contents, XML media type (beta functionality), and document revision with new and updated information
2019-02-15: Initial version

...

Section

border	true

Column

Status

colour	Red
title	Important

The 2020-11-11 release is generally known as Next Generation CDISC Library, where CDISC begins to host CDISC Library in Microsoft Azure. An introduction about it is available as a webinar recording here: https://www.cdisc.org/cdisc-library/getting-startedTo learn more, access the free course NGLIB001: Next Generation CDISC Library on CDISC Learning System.

Section

border	true

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

Section

border	true

Column

The base URL for the API is:

Code Block

linenumbers	true

https://library.cdisc.org/api

...

Section

border	true

Column
The CDISC Library API generally follows HTTP/1.1's guidelines for status code. Details are here: HTTP Status Codes (2020-02-14).

Section

border	true

Column

The REST API uses API key authentication.

Status

colour	Yellow
title	Updated

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.

Section

border	true

Column

Status

colour	Yellow
title	Updated

Info
Content for CDISC Controlled Terminology P43 will be is available in as a patch release at a later datedated 2020-11-06. It will consist of the version dated consists of contents published on 2020-09-25 , as well as the plus transactional updates from the version dated 2020-11-06.

The following standards have been loaded:

CDISC Controlled Terminology P19 (2014-09-26) to P42 P45 (20202021-0603-26)*, a total of 24 27 quarters with 93 110 parts
CDASH v1.1.1/CDASHUG v1.0, CDASH Model v1.0 to v1.1, CDASHIG v2.0 to v2.1
SDTM v1.2 to v1.8, SDTMIG v3.1.2 to v3.3, SDTMIG-AP v1.0, SDTMIG-PGx 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 ADaMIG v1.1 to v1.2, ADaM ADAE v1.0, ADaM TTE for BDS v1.0, ADaM OCCDS v1.0

* denotes new contents added as of the 20202021-0703-07 30 release

Section

border	true

Column

Status

colour	Yellow
title	Updated

Included in the 2021-03-30 release are:

Enhancements

CDISC Glossary. CDISC Glossary is part of CDISC Controlled Terminology. CDISC Library now supports this package type starting P44 (2020-12-18).

Draft contents. Users can now access draft contents through the Data Standards Browser and the API. Draft contents are standards available for preview before their publication.

Data Standards Browser. A new expandable node is added to the left navigation panel.
Expand
title Screenshot example
Image Added

API. The registrationStatus element has a value of "Draft".

Expand

title	/mdr/sdtmig/3-4 example output

Code Block

linenumbers	true

{
    "name": "SDTMIG v3.4",
    "registrationStatus": "Draft",
    "source": "CDISC Submission Data Standards Team",
    "version": "3.4"
    ...
}

List of draft contents:
- SDTMIG v3.4
- ADaMIG v1.3

Corrections & Patches

N/A for this release

Deprecations

N/A for this release

Expand

title	Review information from previous release notes...

Column

Status

colour	Yellow
title	Updated

Included in the 2020-11-11 release are:

Enhancements

For API endpoint /mdr/products/DataAnalysis, the ADaM v2.1 is now included as one of the products.
- Expand
  title

Excerpt from

/mdr/products/DataAnalysis example output

Code Block

linenumbers	true

{
    "_links": {
        "adam": [
            {
                "href": "/mdr/adam/adam-2-1",
                "title": "Analysis Data Model Version 2.1",
                "type": "Foundational Model"
            },
            ...
        ],
        ...
    }
}

For API endpoint /mdr/cdashig/2-0 and /mdr/cdashig/2-1, the implements HATEOAS links are added to each applicable domain fields (JSON path: $.classes[*].domains[*].fields[*]._links.implements).

Expand

title	Example showing the implements HATEOAS link for the STUDYID field in CDASHIG v2.1's CO domain

Code Block

linenumbers	true

{
    ...
    "classes": [
        {
            ...
            "domains": [
                {
                    ...
                    "fields": [
                        {
                            ...
                            "_links": {
                                "implements": {
                                    "href": "/mdr/cdash/1-1/classes/Identifiers/fields/STUDYID",
                                    "title": "Study Identifier",
                                    "type": "Class Variable"
                                }
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

Corrections & Patches

Erroneous index entries, e.g., "SDTM v1.2", "SDTM v1.3", etc., no longer appears in the response from this API request: /mdr/search/scopes/class.
The hypermedia link about parent product is added back to these API endpoints. In other words, the JSON path $._links.parentProduct now contains a link:
- /mdr/sdtm/{version}/classes
- /mdr/sdtmig/{version}/classes
- /mdr/sendig/{version}/classes
- Expand
  title

Example using

/mdr/sendig/ar-1-0/classes example output

Code Block

linenumbers	true

{
    "_links": {
        "classes": [
        ],
        "parentProduct": {
            "href": "/mdr/sendig/ar-1-0",
            "title": "Standard for Exchange of Nonclinical Data Implementation Guide: Animal Rule Version 1.0 (Final)",
            "type": "Implementation Guide"
        },
        ...
    },
    ...
}

For API endpoint /mdr/root/cdash/classes/{class}/fields/{field}, the value of the type object (JSON path: $._links.self.type) now reads "Root Data Element"; originally, "Has Root Data Element".

Expand

title	Example using /mdr/root/cdash/classes/Interventions/fields/--YN

Before, at line #6, type reads "Has Root Data Element":

Code Block

linenumbers	true

{
    "_links": {
        "self": {
            "href": "/mdr/root/cdash/classes/Interventions/fields/--YN",
            "title": "Version-agnostic anchor element for Interventions field --YN",
            "type": "Has Root Data Element"
        },
        ...
    }
}

After, at line #6, type reads "Root Data Element":

Code Block

linenumbers	true

{
    "_links": {
        "self": {
            "href": "/mdr/root/cdash/classes/Interventions/fields/--YN",
            "title": "Version-agnostic anchor element for Interventions field --YN",
            "type": "Root Data Element"
        },
        ...
    }
}

Deprecations

Basic Auth support for API access, replaced by API key authentication.
API endpoint /health for system component status. CDISC is evaluating equivalent or similar functionality in future patch release.
Search scopes /mdr/search/scopes/{scope} where scope is one of these values:
1. definition
2. description
3. measureType
4. productGroup
5. uiHref
6. valueDomain

Section

border	true

Column

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

Code Block

linenumbers	true

/mdr/maintenance

For example,

Code Block

linenumbers	true

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

Section

border	true

Status

colour	Yellow
title	Updated

Column

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

Code Block

linenumbers	true

/mdr/products

Or, by product group:

Code Block

firstline	2
linenumbers	true

/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

Section

border	true

Column

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.

Code Block

linenumbers	true

/mdr/about

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

Code Block

linenumbers	true

/mdr/lastupdated

For example:

Code Block

title	/mdr/about example output
linenumbers	true

{
  "_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"
}

Code Block

title	/mdr/lastupdated example output
linenumbers	true

{
  "_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"
}

...

Section

border	true

Column

Added to the 2019-07-18 release is the support for two additional media types: CSV and Excel. Users may request top-level foundational standards exports in either CSV or Excel Workbook format. The media type for CSV is text/csv, while application/vnd.ms-excel for Excel.

Note
CSV and Excel Workbook media types are only available at the top-level of a foundational standard. When requesting them at levels in any lower hierarchy, the API will return an HTTP 406 Not Acceptable status code.

Info
Refer to to Limitations for an important note about the CSV and Excel exports.

For example, 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:

Code Block

language	text
linenumbers	true

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:

Code Block

language	text
linenumbers	true

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'

...

Space shortcuts

Page tree

Versions Compared

Old Version 11

New Version 12

Key

Enhancements

Corrections & Patches

Deprecations

Enhancements

Corrections & Patches

Deprecations