Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleNews and updates
  • 2021-05-04: Added diff functionality
  • 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
    titleHistory 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
bordertrue


Column

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
bordertrue


Updated
Column
Status
colourYellow
title


Info

Content for CDISC Controlled Terminology P43 is available as a patch release dated 2020-11-06. It consists of contents published on 2020-09-25 plus transactional updates from the version dated 2020-11-06.

The following standards have been loaded:

  • CDISC Controlled Terminology P19 (2014-09-26) to P45 (2021-03-26)*, a total of 27 quarters with 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 2021-03-30 release


...

Section
bordertrue


Column

Status
colourYellow
titleUpdated
Included in the 2021-0305-30 04 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
    titleScreenshot example

    Image Removed

    • Diff*
      • API endpoint
      • Report as an export from Data Standards Browser

    * For details, go to Diff

    Corrections & Patches

    • N/A for this release

    Deprecations

    • N/A for this release


    Expand
    titleReview information from previous release notes...

    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
        titleScreenshot example

        Image Added


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

        Expand
        title/mdr/sdtmig/3-4 example output


        Code Block
        linenumberstrue
        {
            "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

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

    Expand
    title/mdr/sdtmig/3-4 example output
    Code Block
    linenumberstrue
    {
        "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
    titleReview information from previous release notes...

    Enhancements

    For API endpoint /mdr/products/DataAnalysis, the ADaM v2.1 is now included as one of the products.
    Expand
    title/mdr/products/DataAnalysis example output
    Code Block
    linenumberstrue
    {
        "_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
    titleExample showing the implements HATEOAS link for the STUDYID field in CDASHIG v2.1's CO domain
    Code Block
    linenumberstrue
    {
        ...
        "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/mdr/sendig/ar-1-0/classes example output
    Code Block
    linenumberstrue
    {
        "_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
    titleExample using /mdr/root/cdash/classes/Interventions/fields/--YN

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

    Code Block
    linenumberstrue
    {
        "_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
    linenumberstrue
    {
        "_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:

    • definition

    • description

    • measureType

    • productGroup

    • uiHref

    • valueDomain




    Section
    bordertrue


    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
    linenumberstrue
    /mdr/maintenance

    For example,

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




    Updated
    Section
    bordertrue
    Status
    colourYellow
    title


    Column

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

    Code Block
    linenumberstrue
    /mdr/products

    Or, by product group:

    Code Block
    firstline2
    linenumberstrue
    /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


    ...