Page History

...

Info

title	News and updates

2020-07-07: New contents, new endpoint, metadata adjustments for ADaM
2020-02-14: New contents, new endpoints, editorial updates
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
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 API uses Basic Auth (HTTP Basic Authentication).

...

Section

border	true

Column

Status

colour	Yellow
title	Updated

The following standards have been loaded:

CDISC Controlled Terminology P19 (2014-09-26) to P40 P42 (20192020-1206-2026)*, a total of 22 24 quarters with 83 93 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, 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 2020-0207-14 07 release

Section

border	true

Column

Status

colour	Yellow
title	Updated

Included in the 2020-0207-14 07 release are these standards:

New contents

CDASH Model v1.1

CDASHIG v2.1
CDISC Controlled Terminology P40, including the new Define-XML CTP41 (2020-03-27)
CDISC Controlled Terminology P42 (2020-06-26)
Note: See Clarifications about P41a (2020-05-08)ADaMIG v1.2

Enhancements

Added two endpoints one endpoint (details below):
- /mdr/about
- /mdr/lastupdated

Corrections & Patches

- maintenance
Added maintenance banner to the Data Standards Browser
For API Documentation:
- Added examples
- Added all supported media types for each endpoint
- Enabled API mocking via Swagger virtual server
- Enriched details for search related endpoints, i.e., schemas and query parameters
- Added links to online resources
Added Media Type Support Matrix to the set of Release Notes

Corrections & Patches

Erroneous hypermedia links about valuelist have been removed from all ADaM responses

Expand

title	Example using /mdr/adam/adamig-1-2/datastructures/BDS/variables/ABLFL

Before, valuelist hypermedia link in lines #11 to #14:

Code Block

linenumbers	true

{
    "ordinal": "316",
    "name": "ABLFL",
    ...
    "_links": {
        "self": {
            "href": "/mdr/adam/adamig-1-2/datastructures/BDS/variables/ABLFL",
            "title": "Baseline Record Flag",
            "type": "Analysis Variable"
        },
        "valuelist": {
            "href": "/mdr/adam/adamig-1-2/valuelist/CharacterYesResponse",
            "title": "Yes Response",
            "type": "Enumerated Value Domain"
        },
        "parentProduct": {
            "href": "/mdr/adam/adamig-1-2",
            "title": "Analysis Data Model Implementation Guide Version 1.2",
            "type": "Implementation Guide"
        },
        ...
        }
    }
}

After, valuelist no longer part of _links:

Code Block

linenumbers	true

{
    "ordinal": "316",
    "name": "ABLFL",
    ...
    "_links": {
        "self": {
            "href": "/mdr/adam/adamig-1-2/datastructures/BDS/variables/ABLFL",
            "title": "Baseline Record Flag",
            "type": "Analysis Variable"
        },
        "parentProduct": {
            "href": "/mdr/adam/adamig-1-2",
            "title": "Analysis Data Model Implementation Guide Version 1.2",
            "type": "Implementation Guide"
        },
        ...
        }
    }
}

ADaM TTE v1.0

Corrected all malformed hypermedia links related to varsets

Expand

title	Example from /mdr/adam/adam-tte-1-0/datastructures/ADTTE/varsets

Before, lines #11 and #16 have varsets href as /mdr/adam/adam-tte-1-0/datastructures/BDS/...:

Code Block

linenumbers	true

{
    "ordinal": "1",
    "name": "BDS for TTE",
    ...
    "_links": {
        "self": {
            ...
        },
        "analysisVariableSets": [
            {
                "href": "/mdr/adam/adam-tte-1-0/datastructures/BDS/varsets/SubjectIdentifierVariable",
                "title": "Subject Identifier Variable",
                "type": "Variable Set"
            },
            {
                "href": "/mdr/adam/adam-tte-1-0/datastructures/BDS/varsets/TreatmentVariables",
                "title": "Treatment Variables",
                "type": "Variable Set"
            },
            ...
            }
        ]
    }
}

After, varsets href values are corrected to read /mdr/adam/adam-tte-1-0/datastructures/ADTTE/...:

Code Block

linenumbers	true

{
    "ordinal": "1",
    "name": "BDS for TTE",
    ...
    "_links": {
        "self": {
            ...
        },
        "analysisVariableSets": [
            {
                "href": "/mdr/adam/adam-tte-1-0/datastructures/ADTTE/varsets/SubjectIdentifierVariable",
                "title": "Subject Identifier Variable",
                "type": "Variable Set"
            },
            {
                "href": "/mdr/adam/adam-tte-1-0/datastructures/ADTTE/varsets/TreatmentVariables",
                "title": "Treatment Variables",
                "type": "Variable Set"
            },
            ...
            }
        ]
    }
}

ADaM ADAE v1.0

Corrected typo in TRTEMFL's description.

Expand

title	Details from /mdr/adam/adam-adae-1-0/datastructures/ADAE/variables/TRTEMFL

Before, typo in two instances of the inequality symbol >=:

Code Block

linenumbers	true

{
    ...
    "description": "Example derivation: If ADSL.TRTSDT>=ASTDT>=ADSL.TRTEDT + x days then TRTEMFL='Y' The number x is defined by the sponsor and often incorporates the known half-life of the drug. Variable TRTEMFL is to be used for any analysis of treatment-emergent AEs. This variable is conditional on whether the concept of treatment emergent is a key feature of the AE analyses.",
    ...
}

After, the inequality symbol is corrected to <=:

Code Block

linenumbers	true

{
    ...
    "description": "Example derivation: If ADSL.TRTSDT<=ASTDT<=ADSL.TRTEDT + x days then TRTEMFL='Y' The number x is defined by the sponsor and often incorporates the known half-life of the drug. Variable TRTEMFL is to be used for any analysis of treatment-emergent AEs. This variable is conditional on whether the concept of treatment emergent is a key feature of the AE analyses.",
    ...
}

Section

border	true

Column

For health check, use this endpoint to verify LDAP and database availability:

Code Block

linenumbers	true

/health

Amended API documentation with these previously omitted endpoints:

/mdr/cdash/{version}/classes/{class}/domains

/mdr/root/cdash/domains/{domain}/fields/{field}

Section

border	true

Column

Status

For health check

colour	Green
title	New

For system maintenance status, use this endpoint to verify LDAP and database availability: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

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

Section

border	true

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

Section

border	true

colourIncluded 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.

Column
Status

	Green
title	New

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
CDASH

Section

border	true

Updated

Column
Status
colour	Yellow
title

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.

...

Space shortcuts

Page tree

Versions Compared

Old Version 9

New Version 10

Key

CDASH