Versions Compared

Key

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

This is an initial report for the Load Full IG Content initiative, created in conjunction with PHUSE/FDA CSS 2022 and CDISC US Interchange 2022 events.

Table of Contents
outlinetrue

Background

CDISC Library is the single, trusted, authoritative source of CDISC standards metadata. Through its Data Standards Browser (DSB) and Application Programming Interface (API), users can browse and retrieve normative metadata such as CDASH models, SDTM domain specifications, ADaM data structures, QRS instruments, CDISC Controlled Terminology, etc. Increasingly, CDISC is focusing on enabling end-to-end process automation and simplifying data transformation throughout the data lifecycle.

CDISC makes our data standards available in PDF format. The Data Science team embarked on a proof-of-concept project to digitally transform a few Implementation Guides and make all applicable contents machine-readable, including, but not limited to, informative text, data examples, biomedical concepts, and conformance rules.

Strategy

The objectives of this initiative are 1) to support CDISC's Implementation Guides (IG) and User Guides (UG). A Therapeutic Area User Guide (TAUG) is typically comprised of informative content. We carefully review them and make updates to the data model accordingly; 2) to allow access by member organizations and to expand access to all who implement data standards; 3) to build on existing tooling; 4) to ensure CDISC Library serves as the reference for standard implementers to reinforce its role as the central repository for CDISC standards.

With those objectives, a few key results have been identified: 1) the existing metadata pipeline that sources normative content from CDISC Confluence is updated to acquire all remaining content from IG and UG; 2) it supports new standards and it can be retrospectively applied to IGs and UGs  already in CDISC Library; 3) content is searchable, discoverable, and bookmarkable; 4) it compliments how normative content is displayed in the DSB; 5) where possible, transform all contents to be machine-readable; 6) ensure content in CDISC Library is accessible through HATEOAS-driven RESTful API.

Design

To present informative content in a digestible manner, the CDISC Library makes use of an ETL pipeline to ingest and transform authored content into a generic structure. This normalized structure stores wiki content in both HTML and a stripped-down Markdown format[2] to support the intended rendering of the content as well as the search functionality inherent in all CDISC Library content. Currently, standards are authored in a Confluence wiki with no differentiation between pages meant for publication and supporting documentation for standard structures. The ETL pipeline processes wiki page labels that are supplied by the standards development team to tag stored documents. These additional metadata tags are used to filter which documents are returned by the API and subsequently displayed in the DSB.

Image RemovedImage Added

API design was also critical in ensuring the informative content was extensible. Most informative content is well structured into specific sections associated with specific IG structures (domains, datasets, data structures); however, there is some informative content that does not fit into these categories. Additionally, new IG versions often require new sections or documents. Storing documents in an Azure Cosmos DB, allows us to quickly query documents and filter to support any number of document types and structures. This, coupled with high level API endpoints serving supplemental data about the documents available for a given standard allows CDISC Library to be extensible for all IG types and any new IGs and UGs in the future. Below is an example UI mockup showing how this API design can support an extensible UI for multiple document sections.

Image RemovedImage Added

Access

The CDISC Library is composed of two components: the DSB and the API. Content displayed on the DSB is all driven by the API. All employees of  CDISC Member organizations can create an account to access CDISC Library. Account set-up requires a valid organizational email address to where a verification code can be sent. New users will receive a separate email about obtaining API keys that can be used to programmatically pull metadata from CDISC Library.

Note that IG and UG contents are loaded into CDISC Library as soon as they are reviewed and approved by standards development teams. Release Notes are updated accordingly.

Example IG

The team loaded SENDIG-DART v1.2 to demonstrate the development work in this beta functionality, in conjunction with its public review. Note that this IG is in draft. The content tagging is a work-in-progress by the DART team.

DSB

Here is a short video demonstrating how to locate some of the informative content loaded for SENDIG-DART v1.2. Currently figures & graphics appear as a placeholder.

View file
namequick-clib-dsb-nav-informative-content.mp4
height250

API

GET /mdr/documents/sendig/dart-1-2/sections will provide a list of supported document sections.

GET /mdr/documents/sendig/dart-1-2/{dataset}/{section} will output the informative content corresponds to a given section for a given dataset. For example, /mdr/documents/sendig/dart-1-2/TP/assumptions output the assumptions for the TP dataset. The output matches the wiki source in TP assumptions of the SENDIG-DART development wiki space.

Discoveries

Database design is essential in determining whether a solution supports a use case and is stable enough to support new use cases. Additionally, while out of scope, using Azure Cosmos DB as a storage environment for documents could potentially support standards authoring in the future, given the right toolset. However, using wiki page labels, CDISC Library can be expanded while standards are authored in wiki documents.

...