Info

title	News and updates

2024-04-02: Package 7 (package 2024-04-02)
20232022-12-07: Initial version

Table of Contents

...

border	true

...

Introduction

...

The biomedical concepts and dataset specializations are informative content. They will start to fill gaps such as semantics, variable relationships and value level metadata. Key objectives are to reduce variability in standards implementations, increase metadata-driven automation and reduce barriers to operational implementation.

CDISC biomedical concepts and dataset specializations will be released in incremental packages. The first package was released on October 26, 2022.

12: Package 6 (package 2023-12-12)
2023-10-03: Package 5 (package 2023-10-03), new endpoints added to API v2
2023-07-06: Package 4 (package 2023-07-06), new versioned APIs
2023-04-04: Package 3 (package 2023-03-31)
2023-02-13: Package 2 (package 2023-02-13)
2022-12-07: Initial version (package 2022-10-26)

Info

title	Release Notes 2024-04-02

New CDISC Biomedical Concepts (BCs) and SDTM Dataset Specializations are now available in Package 7. NCIt and Codetable Mapping Files were used as source references for the new content:

54 BCs including Genomics Findings, Death Diagnosis/Details, and Findings About Cardiovascular Events
63 SDTM Dataset Specializations for GF, DD, and FA

CDISC Library now contains a total of 302 BCs and 290 SDTM Dataset Specializations retrievable via the CDISC Library API.

More information about CDISC Biomedical Concepts and SDTM Dataset Specializations can be found at CDISC Biomedical Concepts.

Table of Contents

...

Section

border	true

Column

Model & Schema

The model and schema describing the CDISC biomedical concepts and SDTM dataset specializations can be found on GitHub.

Section

border	true

Description

Note

title	Changes to API Endpoint Responses for CDISC Biomedical Concepts and SDTM Dataset Specializations

API endpoint responses for CDISC Biomedical Concepts and SDTM Dataset Specializations have changed due to the evolution of the Biomedical Concepts data model. As a result, all API endpoints will be versioned. The original, pre-existing API endpoints will remain available in API v1.

New API endpoints have been developed and are available in API v2. On July 6, 2023, all new and revised API endpoints for CDISC Biomedical Concepts and SDTM Dataset Specializations will be included in API v2.

Starting July 6, 2023, all API requests will need to include a version. For example,

Old API endpoint:

Column

Basic Construct

The following table shows the basic construct of API request to obtain biomedical concepts:

API request template

/mdr/bc/packages

Get Biomedical Concept Package List

/2022-10-26/biomedicalconcepts/C64547

New API endpoints

/cosmos/v1/

/

mdr/bc/packages/

{package}/biomedicalconceptsGet Biomedical Concept List

/mdr/bc/packages/{package}/biomedicalconcepts/{biomedicalconcept}

Get Biomedical Concept

The following table shows the basic construct of API request to obtain SDTM specializations:

API request templateDescription

/mdr/specializations/sdtm/packages

Get SDTM Dataset Specialization Package List

/mdr/specializations/sdtm/packages/{package}/datasetspecializations

Get SDTM Dataset Specialization List

/mdr/specializations/sdtm/packages/{package}/datasetspecializations/{datasetspecialization}

Get SDTM Dataset Specialization

This is a table of supported parameters:

ParameterDescriptionpackagePackage Identifier. An ISO 8601 date.biomedicalconceptBiomedical Concept Identifier. A string.datasetspecializationSDTM Dataset Specialization Identifier. A string.

Note
Some examples are slightly modified to provide a better visual and flow.

2022-10-26/biomedicalconcepts/C64547 /cosmos/v2/mdr/bc/packages/2022-10-26/biomedicalconcepts/C64547

A version must be specified. If a user does not specify a version, a 404 API response code (Not Found) will be returned. All documentation for the CDISC Library API can be found at https://api.developer.library.cdisc.org/. Users should use their existing cdiscID login credentials.

Section

border	true

Column

Introduction

CDISC biomedical concepts and dataset specializations are currently supported standards. These include an abstract conceptual layer, aligned with NCI terminology, which is linked to a simplified implementation layer of pre-configured SDTM dataset specializations.Information for additional specializations, such as CDASH data collections, will be added when they become available.

The biomedical concepts and dataset specializations are informative content. They will start to fill gaps such as semantics, variable relationships and value level metadata. Key objectives are to reduce variability in standards implementations, increase metadata-driven automation and reduce barriers to operational implementation.

CDISC biomedical concepts and dataset specializations will be released in incremental packages. The first package was released on October 26, 2022. Subsequent packages have been released and are now available via CDISC Library APIs (see News and Updates).

Please use CDISC Jira for comments and feedback.

Section

border	true

Column

Base URL for API Endpoints

The base URL for the API is:

Code Block

linenumbers	true

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

Or, this one for legacy support:

Code Block

linenumbers	true

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

Note that there has not been a target sunset date established yet.

Section

border	true

Column

Model & Schema

The model and schema describing the CDISC biomedical concepts and SDTM dataset specializations can be found on GitHub.

Section

border	true

Column

Basic Construct

The following table shows the basic construct of API requests to obtain biomedical concepts:

API request template	API v2 Only?	Return Latest Version Only?	Description
`/mdr/bc/packages`			Get Biomedical Concept Package List
`/mdr/bc/packages/{package}/biomedicalconcepts`			Get Biomedical Concept List in a Package (example)
`/mdr/bc/packages/{package}/biomedicalconcepts/{biomedicalconcept}`			Get Biomedical Concept in a Package (example)
`/mdr/bc/biomedicalconcepts`			Get Biomedical Concept List (example)
/mdr/bc/biomedicalconcepts/{biomedicalconcept}			Get Biomedical Concept (example)
`/mdr/bc/categories`			Get Biomedical Concept Categories List (example)
`/mdr/bc/biomedicalconcepts?category={category}`			Get List of Biomedical Concepts for a Given Category (example)

The following table shows the basic construct of API requests to obtain SDTM dataset specializations:

API request template	API v2 Only?	Return Latest Version Only?	Description
`/mdr/specializations/sdtm/packages`			Get SDTM Dataset Specialization Package List
`/mdr/specializations/sdtm/packages/{package}/datasetspecializations`			Get SDTM Dataset Specialization List in a Package (example)
`/mdr/specializations/sdtm/packages/{package}/datasetspecializations/{datasetspecialization}`			Get SDTM Dataset Specialization in a Package (example)
/mdr/specializations/sdtm/datasetspecializations			Get SDTM Dataset Specialization List (example)
/mdr/specializations/sdtm/datasetspecializations/{datasetspecialization}			Get SDTM Dataset Specialization (example)
/mdr/specializations/sdtm/domains			Get SDTM Dataset Specialization Domain List (example)
`/mdr/specializations/sdtm/datasetspecializations?domain={domain}`			Get a List of SDTM Dataset Specializations for a Given Domain (example)

The following table shows the basic construct of API requests to obtain dataset specializations:

API request template	API v2 Only?	Return Latest Version Only?	Description
/mdr/specializations/datasetspecializations?biomedicalconcept={biomedicalconcept}			Get a List of Dataset Specializations that Specialize a Biomedical Concept (example)

This is a table of supported parameters:

Parameter	Description
package	Package Identifier. An ISO 8601 date.
biomedicalconcept	Biomedical Concept Identifier. A string.
datasetspecialization	SDTM Dataset Specialization Identifier. A string.
category	Biomedical Concept Category. A string.
domain	Identifier for Dataset Specialization Domain. Examples: AE, DM, VS. A string.

Section

border	true

Column

Core Differences in BC API v2

These are the changes in the response payload from /mdr/bc/packages/{package}/biomedicalconcepts/{biomedicalconcept}:

Attribute name changes
- $.category to $.categories
- $.synonym to $.synonyms
- $.resultScale to $.resultScales
Data type changes
- $.resultScales returns from a scalar to a list
New attributes
- $.ncitCode
- $.dataElementConcepts.ncitCode

Info

Some examples are slightly modified to provide a better visual and flow. The examples are reflective of v2 endpoints.

The JSON standard defines an object as "an unordered collection of zero or more name/value pairs". As such, the specific order in which object keys appear may vary in the response payload.

Section

border	true

Column

Anchor
example1
example1
Example 1

Get the biomedical concept list from the package released on October 26, 2022.

/mdr/bc/packages/2022-10-26/biomedicalconcepts

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "biomedicalConcepts": [
            {
                "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298",
                "title": "Systolic Blood Pressure",
                "type": "Biomedical Concept"
            },
            ...
         ],
         "self": {
            "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts",
            "title": "Biomedical Concepts",
            "type": "Biomedical Concept List"
        }
    },

Lines 3-10: A list of HATEOS links to biomedical concepts matching the package parameter, excerpted to show Systolic Blood Pressure.
Each biomedical concept has 3 elements: href, title, and type.

For an in-depth explanation of HATEOS refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Code Block

language	yml
firstline	17
linenumbers	true

    "effectiveDate": "2022-10-26",
    "label": "Biomedical Concept Package Effective 2022-10-26",
    "name": "Biomedical Concepts 2022-10-26",
    "version": "2022-10-26"
}

Lines 17-20: Metadata about the biomedical concept list.

Section

border	true

Column

Anchor
example
example
Example 2

Get the one Systolic Blood Pressure biomedical concept from the package released on October 26, 2022.

/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "parentBiomedicalConcept": {
            "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C54706",
            "title": "Blood Pressure",
            "type": "Biomedical Concept"
        },
        "parentPackage": {
            "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts",
            "title": "Biomedical Concept Package Effective 2022-10-26",
            "type": "Biomedical Concept Package"
        },
        "self": {
            "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298",
            "title": "Systolic Blood Pressure",
            "type": "Biomedical Concept"
        }
    },

Lines 2-18: A list of HATEOAS links to related resources, such as self, parent package, and parent biomedical concept. A note on parent biomedical concept: In this example, Blood Pressure is the parent to Systolic Blood Pressure. parentBiomedicalConcept will not be present for topmost biomedical concepts.

Lines 3-7: The latest version of the parent biomedical concept (Blood Pressure).

Code Block

language	yml
firstline	19
linenumbers	true

     "categories": [
        "Vital Signs"
    ],

Lines 19-21: A list of categories to which this biomedical concept belongs.

Code Block

language	yml
firstline	22
linenumbers	true

    "coding": [
        {
            "code": "8480-6",
            "system": "http://loinc.org/",
            "systemName": "LOINC"
        }
    ],

Lines 22-28: A list of external code systems to which this biomedical concept relates.

Code Block

language	yml
theme	Confluence
firstline	29
linenumbers	true

    "dataElementConcepts": [
        {
            "conceptId": "C173522",
            "dataType": "integer",
            "href": "https://ncithesaurus.nci.nih.gov/...&code=C173522",
            "ncitCode": "C173522",
            "shortName": "Vital Signs Result"
        },
        {
            "conceptId": "C49669",
            "dataType": "string",
            "exampleSet": [
                "cmHg",
                "mmHG",
                "Pascal"
            ],
            "href": "https://ncithesaurus.nci.nih.gov/...&code=C49669",
            "ncitCode": "C49669",
            "shortName": "Unit of Pressure"
        },
        ...
    ],

Lines 29-50: A list of data element concepts that comprise this biomedical concept. The href value points to an NCI EVS Thesaurus resource where definition of this data element can be found via the concept code (or, commonly known as c-code).

Lines 31-35: Vital Signs Result (Line 35) is the first data element concept on the list.

Lines 38-47: Unit of Measure (Line 47) is the next data element concept on the list. An example set of values is provided in this example.

Code Block

language	yml
firstline	51
linenumbers	true

    "conceptId": "C25298",
    "definition": "The maximum pressure exerted into the systemic arterial...",
    "href": "https://ncithesaurus.nci.nih.gov/...&code=C25298",
    "resultScales": [
        "Quantitative
    ],
    "ncitCode": "C25298",
    "shortName": "Systolic Blood Pressure",
    "synonyms": [
        "SYSBP"
    ]
}

Lines 51-61: Metadata about the biomedical concept.

Section

border	true

Column

Anchor
example3
example3
Example 3

Get a list of all biomedical concepts across packages.

/mdr/bc/biomedicalconcepts

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "biomedicalConcepts": [
            {
                "href": "/mdr/bc/biomedicalconcepts/C25298",
                "title": "Systolic Blood Pressure",
                "type": "Biomedical Concept"
            },
            ...
        ],
        "self": {
            "href": "/mdr/bc/biomedicalconcepts",
            "title": "Biomedical Concepts (latest version)",
            "type": "Biomedical Concept List"
        }
    }, 
    "name": "Biomedical Concepts (latest version)",
    "label": "Biomedical Concepts List"
}

Lines 3-10: A list of HATEOS links to biomedical concepts, excerpted to show Systolic Blood Pressure.
Each biomedical concept has 3 elements: href, title, and type.

For an in-depth explanation of HATEOS refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Section

border	true

Column

Anchor
example4
example4
Example 4

Get the latest version of the Systolic Blood Pressure biomedical concept.

/mdr/bc/biomedicalconcepts/C25298

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "parentBiomedicalConcept": {
            "href": "/mdr/bc/biomedicalconcepts/C54706",
            "title": "Blood Pressure",
            "type": "Biomedical Concept"
        },
        "parentPackage": {
            "href": "/mdr/bc/packages/2023-07-06/biomedicalconcepts",
            "title": "Biomedical Concept Package Effective 2023-07-06",
            "type": "Biomedical Concept Package"
        },
        "self": {
            "href": "/mdr/bc/biomedicalconcepts/C25298",
            "title": "Systolic Blood Pressure",
            "type": "Biomedical Concept"
        }
    },

Lines 2-18: A list of HATEOAS links to related resources, such as self, parent package that has the latest version of this biomedical concept, and parent biomedical concept. A note on parent biomedical concept: In this example, Blood Pressure is the parent to Systolic Blood Pressure. parentBiomedicalConcept will not be present for topmost biomedical concepts.

Code Block

language	yml
firstline	19
linenumbers	true

"categories": [
    "Vital Signs"
],

Lines 19-21: A list of categories to which this biomedical concept belongs.

Code Block

language	yml
firstline	22
linenumbers	true

"coding": [
    {
        "code": "8480-6",
        "system": "http://loinc.org/",
        "systemName": "LOINC"
    }
],

Lines 22-28: A list of external code systems to which this biomedical concept relates.

Code Block

language	yml
firstline	29
linenumbers	true

"dataElementConcepts": [
       {
           "conceptId": "C173522",
           "dataType": "decimal",
           "href": "https://ncithesaurus.nci.nih.gov/...&code=C173522",
           "ncitCode": "C173522",
           "shortName": "Vital Signs Result"
       },
       {
           "conceptId": "C49669",
           "dataType": "string",
           "exampleSet": [
               "cmHg",
               "mmHG",
               "Pascal"
           ],
           "href": "https://ncithesaurus.nci.nih.gov/...&code=C49669",
           "ncitCode": "C49669",
           "shortName": "Unit of Pressure"
       },
       ...
   ],

Lines 29-50: A list of data element concepts that comprise this biomedical concept. The href value points to an NCI EVS Thesaurus resource where definition of this data element can be found via the concept code (or, commonly known as c-code).

Lines 31-35: Vital Signs Result (Line 35) is the first data element concept on the list.

Lines 38-47: Unit of Measure (Line 47) is the next data element concept on the list. An example set of values is provided in this example.

Code Block

language	yml
title	51
linenumbers	true

    "conceptId": "C25298",
    "definition": "The maximum pressure exerted into the systemic arterial...",
    "href": "https://ncithesaurus.nci.nih.gov/...&code=C25298",
    "resultScales": [
        "Quantitative
    ],
    "ncitCode": "C25298",
    "shortName": "Systolic Blood Pressure",
    "synonyms": [
        "SYSBP"
    ]
}

Lines 51-61: Metadata about the biomedical concept.

Section

border	true

Column

Anchor
example5
example5
Example 5

Get a list of all the biomedical concept categories.

/mdr/bc/categories

Code Block

language	yml
linenumbers	true

{
    "_links": {          
         "self": {
             "href": "/mdr/bc/categories",
             "title": "Biomedical Concept Categories",
             "type": "Biomedical Concept Category List"
         }
         "categories": [
            {
                "name": "Vital Signs",
                "_links": {
                    "self": {
                        "href": "/mdr/bc/biomedicalconcepts?category=Vital%20Signs",
                        "title": "Biomedical Concepts Category (Vital Signs)",
                        "type": "Biomedical Concepts Category"
                    }
                }
            },
            ...
        ],
     },
    "name": "Biomedical Concept Categories",
    "label": "Biomedical Concept Categories List"
}

Lines 8-20: A list of HATEOS links to biomedical concept categories, excerpted to show Vital Signs.
Each biomedical concept category has 3 elements: href, title, and type.

For an in-depth explanation of HATEOS refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Section

border	true

Column

Anchor
example6
example6
Example 6

Get a list of the latest version of all biomedical concepts in the Vital Signs category.

/mdr/bc/biomedicalconcepts?category=Vital%20Signs

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "biomedicalConcepts": [
            {
                "href": "/mdr/bc/biomedicalconcepts/C25298",
                "title": "Systolic Blood Pressure",
                "type": "Biomedical Concept"
            },
            ...
        ],
        "self": {
            "href": "/mdr/bc/biomedicalconcepts",
            "title": "Biomedical Concepts (latest version)",
            "type": "Biomedical Concept List"
        }
    },

Lines 3-10: A list of HATEOS links to biomedical concepts in the Vital Signs category, excerpted to show Systolic Blood Pressure.
Each biomedical concept has 3 elements: href, title, and type.

For an in-depth explanation of HATEOS refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Code Block

language	yml
linenumbers	true

    "name": "Biomedical Concepts (latest version)",
    "category": "Vital Signs",
    "label": "Biomedical Concepts List"
}

Lines 17-20: Metadata about the biomedical concept category list.

Section

border	true

Column

Anchor
example7
example7
Example 7

Get the SDTM dataset specialization list from the package released on October 26, 2022.

/mdr/specializations/sdtm/packages/2022-10-26/datasetspecializations

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "self": {
            "href": "/mdr/specializations/sdtm/...datasetspecializations",
            "title": "SDTM Dataset Specializations",
            "type": "SDTM Dataset Specialization list"
        },
        "datasetSpecializations": [
            {
                "href": "/mdr/specializations/sdtm/...datasetspecializations/SYSBP",
                "title": "Systolic Blood Pressure",
                "type": "SDTM Dataset Specialization"
            },
            ...
        ]
    },

Lines 8-15: A list of SDTM dataset specializations matching the package parameter, excerpted to show Systolic Blood Pressure. Note the specialization type is set to "SDTM Dataset Specialization".

Code Block

language	yml
firstline	17
linenumbers	true

    "effectiveDate": "2022-10-26",
    "label": "SDTM Dataset Specialization Package Effective 2022-10-26",
    "name": "SDTM Dataset Specializations 2022-10-26",
    "version": "2022-10-26"
}

Lines 17-20: Metadata about the SDTM dataset specialization list.

Section

border	true

Column

Anchor
example8
example8
Example 8

Get the one Systolic Blood Pressure SDTM dataset specialization from the package released on October 26, 2022.

/mdr/specializations/sdtm/packages/2022-10-26/datasetspecializations/SYSBP

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "parentBiomedicalConcept": {
            "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298",
            "title": "Systolic Blood Pressure",
            "type": "Biomedical Concept"
        },
        "parentPackage": {
            "href": "/mdr/specializations/sdtm/...datasetspecializations",
            "title": "SDTM Dataset Specialization Package Effective 2022-10-26",
            "type": "SDTM Dataset Specialization Package"
        },
        "self": {
            "href": "/mdr/specializations/sdtm/...datasetspecializations/SYSBP",
            "title": "Systolic Blood Pressure",
            "type": "SDTM Dataset Specialization"
        }
    },

Lines 2-18: A list of HATEOAS links to related resources, such as self, parent package, and parent biomedical concept. A note on parent biomedical concept: In this example, Systolic Blood Pressure is the parent biomedical concept to this SDTM dataset specialization. parentBiomedicalConcept will not be present if no parent is available at the time of publication.

Code Block

language	yml
firstline	19
linenumbers	true

    "variables": [
        {
            "name": "VSORRESU",
            "dataElementConceptId": "C49669",
            "isNonStandard": false,
            "mandatoryValue": false,
            "mandatoryVariable": true,
            "role": "Qualifier",
            "relationship": {
                "linkingPhrase": "is the unit for the value in",
                "object": "VSORRES",
                "predicateTerm": "IS_UNIT_FOR",
                "subject": "VSORRESU"
            },
            "codelist": {
                "conceptId": "C66770",
                "href": "https://ncithesaurus.nci.nih.gov/...&code=C66770",
                "submissionValue": "VSRESU"
            },
            "assignedTerm": {
                "conceptId": "C49670",
                "value": "mmHG"
            },
            "vlmTarget": true
        },

Line 19: Beginning of a variable (or, data element) list that comprise this Systolic Blood Pressure SDTM dataset specialization.

Lines 20-43: VSORRESU (Line 21) is the first variable on the list. codelist (Lines 33-37) shows controlled terminology metadata for this variable. relationship (Lines 27-32) shows how this variable is related to another variable in the format of (subject, predicate, object): VSORRESU IS_UNIT_FOR VSORRES.

Code Block

language	yml
firstline	44
linenumbers	true

        {
            "name": "VSSTRESN",
            "dataElementConceptId": "C173522",
            "isNonStandard": false,
            "dataType": "integer",
            "length": 3,
            "mandatoryValue": false,
            "mandatoryVariable": false,
            "role": "Qualifier",
            "relationship": {
                "linkingPhrase": "is the result of the test in",
                "object": "VSTESTCD",
                "predicateTerm": "IS_RESULT_OF",
                "subject": "VSSTRESN"
            },
            "vlmTarget": true
        },
        ...
    ],

Lines 44-60: VSSTRESN (Line 45) is the next variable on the list. It has an integer as datatype with a preconfigured length of 3. relationship (Lines 53-58) shows how this variable is related to another variable in the format of (subject, predicate, object): VSSTRESN IS_RESULT_OF VSTESTCD.

Code Block

language	yml
firstline	63
linenumbers	true

    "datasetSpecializationId": "SYSBP",
    "domain": "VS",
    "sdtmigStartVersion": "3-2",
    "shortName": "Systolic Blood Pressure",
    "source": "VS.VSTESTCD"
}

Lines 63-67: Metadata about the SDTM dataset specialization.

Section

border	true

Column

Anchor
example9
example9
Example 9

Get a list of all SDTM dataset specializations across packages.

/mdr/specializations/sdtm/datasetspecializations

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "datasetSpecializations": [
            {
                "href": "/mdr/specializations/sdtm/datasetspecializations/SYSBP",
                "title": "Systolic Blood Pressure",
                "type": "SDTM Dataset Specialization"
            },
            ...
        ],
        "self": {
            "href": "/mdr/specializations/sdtm/datasetspecializations",
            "title": "SDTM Dataset Specializations (latest version)",
            "type": "SDTM Dataset Specializations List"
        }
    },
    "name": "SDTM Dataset Specializations (latest version)",
    "label": "SDTM Dataset Specializations List"
}

Lines 3-10: A list of SDTM dataset specializations, excerpted to show Systolic Blood Pressure.
Each SDTM dataset specialization has 3 elements: href, title, and type. For Refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Section

border	true

Column

Anchor
example10
example10
Example 10

Get the latest version of the Systolic Blood Pressure SDTM Dataset Specialization.

/mdr/specializations/sdtm/datasetspecializations/SYSBP

Section

border	true

Column

Example 1

Get biomedical concept list from the package released on October 26, 2022.

/mdr/bc/packages/2022-10-26/biomedicalconcepts

Code Block

language	yml
linenumbers	true

{
    "_links": {
         "selfparentBiomedicalConcept": {
            "href": "/mdr/bc/packages/2022-10-26/bc/biomedicalconcepts/C25298",
            "title": "BiomedicalSystolic Blood ConceptsPressure",
            "type": "Biomedical Concept List"
        },
        "biomedicalConcepts": [
           "parentPackage": {
                "href": "/mdr/specializations/bcsdtm/packages/20222023-1007-2606/biomedicalconcepts/C25298datasetspecializations",
                "title": "Systolic Blood PressureSDTM Dataset Specialization Package Effective 2023-07-06",
                "type": "Biomedical ConceptSDTM Dataset Specialization Package"
            },
        "self": {
     ...
        ],
     },

Lines 8-15: A list of biomedical concepts matching the package parameter, excerpted to show Systolic Blood Pressure. Each biomedical concept has 3 elements: href, title, and type. For Refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Code Block

language	yml
firstline	17
linenumbers	true

"href": "/mdr/specializations/sdtm/datasetspecializations/SYSBP",
            "effectiveDatetitle": "2022-10-26Systolic Blood Pressure",
    "label": "Biomedical Concept Package Effective 2022-10-26",
    "nametype": "BiomedicalSDTM Concepts 2022-10-26",
Dataset Specialization"
     "version": "2022-10-26"
}

Lines 17-20: Metadata about the biomedical concept list.

Section

border	true

   }
    },

Lines 2-18: A list of HATEOAS links to related resources, such as self, parent package, and parent biomedical concept. A note on parent biomedical concept: In this example, Systolic Blood Pressure is the parent biomedical concept to this SDTM dataset specialization. parentBiomedicalConcept will not be present if no parent is available at the time of publication.

Code Block

language	yml
firstline	19
linenumbers	true

    "variables": [
        ...
        {
            "name": "VSORRESU",

Column

Example 2

Get the one Systolic Blood Pressure biomedical concept from the package released on October 26, 2022.

/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "parentBiomedicalConceptdateElementConceptId": {"C49669",
            "hrefisNonStandard": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C54706",
 false,
            "codelist": {
                "titleconceptId": "Blood PressureC66770",
                "typesubmissionValue": "Biomedical ConceptVSRESU",
        },
        "parentPackagehref": {"https://ncithesaurus.nci.nih.gov/...&code=C66770"
            },
            "hrefassignedTerm": "/mdr/bc/packages/2022-10-26/biomedicalconcepts",{
                "titleconceptId": "C49670"Biomedical,
 Concept Package Effective 2022-10-26",
            "typevalue": "mmHg"Biomedical
   Concept Package"
        },
            "selfrole": {"Qualifier",
            "hrefrelationship": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298",
{
                "titlesubject": "Systolic Blood PressureVSORRESU",
                "typelinkingPhrase": "Biomedical Concept"is the unit for the value in",
        }
    },

Lines 2-18: A list of HATEOAS links to related resources, such as self, parent package, and parent biomedical concept. A note on parent biomedical concept: In this example, Blood Pressure is the parent to Systolic Blood Pressure. parentBiomedicalConcept will not be present for topmost biomedical concepts.

Code Block

language	yml
firstline	19
linenumbers	true

     "categorypredicateTerm": ["IS_UNIT_FOR",
        "Vital Signs"
    ],

Lines 19-21: A list of categories to which this biomedical concept belongs.

Code Block

language	yml
firstline	22
linenumbers	true

    "codingobject": ["VSORRES"
        {    },
            "codemandatoryVariable": "8480-6"true,
            "systemmandatoryValue": "http://loinc.org/"false,
            "systemNamevlmTarget": "LOINC"true
        }
    ],,

Line 19: Beginning of a variable (or, data element) list that comprise this Systolic Blood Pressure SDTM dataset specialization.

Lines 21-44: VSORRESU (Line 21) is a variable on the list. codelist (Lines 33-37) shows controlled terminology metadata for this variable. relationship (Lines 27-32) shows how this variable is related to another variable in the format of (subject, predicate, object): VSORRESU IS_UNIT_FOR VSORRES

Lines 22-28: A list of external code systems to which this biomedical concept relates

.

Code Block

language	yml	theme	Confluenceyml
firstline	2945
linenumbers	true

      "dataElementConcepts": [
  {
             {"name": "VSSTRESN",
            "conceptIddateElementConceptId": "C173522",
            "dataTypeisNonStandard": "integer"false,
            "hrefrole": "https://ncithesaurus.nci.nih.gov/...&code=C173522Qualifier",
            "shortNamedataType": "Vital Signs Result""integer",
            "length": 3,
        },
    "relationship": {
    {
            "conceptIdsubject": "C49669VSSTRESN",
                "dataTypelinkingPhrase": "string",
is the result of the        "exampleSet": [test in",
                "cmHgpredicateTerm": "IS_RESULT_OF",
                "mmHG",object": "VSTESTCD"
            },
    "Pascal"
            ]"mandatoryVariable": false,
            "hrefmandatoryValue": "https://ncithesaurus.nci.nih.gov/...&code=C49669"false,
            "shortNamevlmTarget": "Unit of Pressure"true
        },
        ...
    ],...
],

Lines 45-61: VSSTRESN

Lines 29-48: A list of data element concepts that comprise this biomedical concept. The href value points to an NCI EVS Thesaurus resource where definition of this data element can be found via the concept code (or, commonly known as c-code).

Lines 30-35: Vital Signs Result (Line 34) is the first data element concept on the list.

Lines 36-46: Unit of Measure (Line 45) is the next data element concept variable on the list. An example set of values is provided in this exampleIt has an integer as datatype with a preconfigured length of 3. relationship (Lines 53-58) shows how this variable is related to another variable in the format of (subject, predicate, object): VSSTRESN IS_RESULT_OF VSTESTCD.

Code Block

language	yml
firstline	4964
linenumbers	true

    "conceptIddatasetSpecializationId": "C25298SYSBP",
    "definitiondomain": "The maximum pressure exerted into the systemic arterial...VS",
    "hrefsdtmigStartVersion": "https://ncithesaurus.nci.nih.gov/...&code=C252983-2",
      "resultScalesdtmigEndVersion": "Quantitative",
      "shortName": "Systolic Blood Pressure",
    "synonymsource": [
        "SYSBP"
    ]
"VS.VSTESTCD"
}

Lines 5064-5670: Metadata about the biomedical conceptSDTM dataset specialization.

Section

border	true

Column

Anchor
example11
example11
Example

3

11

Get a list of all the SDTM dataset specialization list from the package released on October 26, 2022domains.

/mdr/specializations/sdtm/packages/2022-10-26/datasetspecializationdomains

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "self": {
            "href": "/mdr/specializations/sdtm/...datasetspecializationsdomains",
            "title": "SDTM Dataset Specializations Domains",
            "type": "SDTM Dataset Specializations SpecializationDomains listList"
        },
    "domains": [
        {
        "datasetSpecializations     "name": "VS"
             "_links": [{
                "self": {
                    "href": "/mdr/specializations/sdtm/...datasetspecializations/SYSBPdatasetspecializations?domain=VS",
                    "title": "Systolic Blood PressureSDTM Dataset Specialization Domain (VS)",
                    "type": "SDTM Dataset Specialization Domain"
            },
            ...
        ]
    },

Lines 8-15: A list of SDTM dataset specializations matching the package parameter, excerpted to show Systolic Blood Pressure. Note the specialization type is set to "SDTM Dataset Specialization".

Code Block

language	yml
firstline	17
linenumbers	true

    "effectiveDate": "2022-10-26"}
            },
        },
    "label": "SDTM Dataset Specialization Package Effective 2022-10-26"    ...
       ]
    },
    "name": "SDTM Dataset Specializations 2022-10-26Domains",
    "versionlabel": "2022-10-26 "SDTM Dataset Specializations Domains List"
}

Lines

17

8-20:

Metadata about the

A list of HATEOS links to SDTM dataset specialization

list.

Section

border	true

domains, excerpted to show VS.
Each biomedical concept category has 3 elements: href, title, and type.

For an in-depth explanation of HATEOS refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Section

border	true

Column

Anchor
example12
example12
Example 12

Get a list of the latest version of all SDTM dataset specializations in the VS domain.

/mdr/specializations/sdtm/datasetspecializations?domain=VS

Code Block

language	yml
linenumbers	true

{
    "_links": {

Column

Example 4

Get the one Systolic Blood Pressure SDTM dataset specialization from the package released on October 26, 2022.

/mdr/specializations/sdtm/packages/2022-10-26/datasetspecializations/SYSBP

Code Block

language	yml
linenumbers	true

{
    "_links": {
        "parentBiomedicalConcept": {
            "href": "/mdr/bc/packages/2022-10-26/biomedicalconcepts/C25298",
            "title": "Systolic Blood Pressure",
            "typedatasetSpecializations": "Biomedical Concept"[
        },
    {
    "parentPackage": {
            "href": "/mdr/specializations/sdtm/...datasetspecializations/SYSBP",

                "title": "SDTM Dataset Specialization Package Effective 2022-10-26",
Systolic Blood Pressure",
                "type": "SDTM Dataset Specialization Package"
            },
           "self": {
 ...
        ],
        "hrefself": "/mdr/specializations/sdtm/...datasetspecializations/SYSBP",{
            "titlehref": "Systolic Blood Pressure/mdr/specializations/sdtm/datasetspecializations",
            "typetitle": "SDTM Dataset Specialization"
        }
    },

Lines 2-18: A list of HATEOAS links to related resources, such as self, parent package, and parent biomedical concept. A note on parent biomedical concept: In this example, Systolic Blood Pressure is the parent biomedical concept to this SDTM dataset specialization. parentBiomedicalConcept will not be present if no parent is available at the time of publication.

Code Block

language	yml
firstline	19
linenumbers	true

 "SDTM Dataset Specializations (latest version)",
            "variablestype": [ "SDTM Dataset Specializations List"
        {}
    },

Lines 3-10: A list of HATEOS links to SDTM dataset specializations in the VS domain, excerpted to show Systolic Blood Pressure.
Each biomedical concept has 3 elements: href, title, and type.

For an in-depth explanation of HATEOS refer to In-depth: HATEOAS Implementation in CDISC Library API for more information about hypermedia links.

Code Block

language	yml
linenumbers	true

         "name": "VSORRESU",
SDTM Dataset Specializations          "dataElementConceptId": "C49669",
            "isNonStandard": false,
            "mandatoryValue": false(latest version)",
    "label": "SDTM Dataset Specializations List",
    "mandatoryVariabledomain": "VS"
}

Lines 17-20: Metadata about the SDTM dataset specialization.

Section

border	true

Column

Anchor
example13
example13
Example 13

Get a list of the latest version of all dataset specializations that specialize the Glucose Measurement biomedical concept.

/mdr/specializations/datasetspecializations?biomedicalconcept=C105585

Code Block

language	yml
linenumbers	true

{true,
    "_links": {
        "roledatasetSpecializations": "Qualifier",{
            "relationshipsdtm": {[
                "linkingPhrase": "is the unit for the value in",
   {
                    "objecthref": "VSORRES/mdr/specializations/sdtm/datasetspecializations/GLUCBLD",
                    "predicateTermtitle": "IS_UNIT_FORGlucose Concentration in Blood",
                    "subjecttype": "VSORRESUSDTM Dataset Specialization"
            },
         },
   "codelist": {
             {
   "conceptId": "C66770",
                "href": "https://ncithesaurus.nci.nih.gov/...&code=C66770/mdr/specializations/sdtm/datasetspecializations/GLUCPL",
                    "submissionValuetitle": "VSRESU"
Glucose Concentration in Plasma",
         },
            "assignedTermtype": {"SDTM Dataset Specialization"
                "conceptId": "C49670"},
                "value": "mmHG"
     {
        },
            "vlmTargethref": true"/mdr/specializations/sdtm/datasetspecializations/GLUCSER",
        },

Line 19: Beginning of a variable (or, data element) list that comprise this Systolic Blood Pressure SDTM dataset specialization.

Lines 20-43: VSORRESU (Line 21) is the first variable on the list. codelist (Lines 33-37) shows controlled terminology metadata for this variable. relationship (Lines 27-32) shows how this variable is related to another variable in the format of (subject, predicate, object): VSORRESU IS_UNIT_FOR VSORRES.

Code Block

language	yml
firstline	44
linenumbers	true

            "title": "Glucose Concentration in Serum",
        {
            "nametype": "VSSTRESN"SDTM Dataset Specialization"
                },
            "dataElementConceptId": "C173522",
     {
       "isNonStandard": false,
            "dataTypehref": "integer/mdr/specializations/sdtm/datasetspecializations/GLUCURIN",
            "length": 3,
       "title": "Glucose Concentration in  "mandatoryValue": falseUrine",
            "mandatoryVariable": false,
            "roletype": "QualifierSDTM Dataset Specialization",
            "relationship": {
   }
            ]
 "linkingPhrase": "is the result of the test in"},
        "parentBiomedicalConcept": {
            "objecthref": "VSTESTCD/mdr/bc/biomedicalconcepts/C105585",
                "predicateTermtitle": "IS_RESULT_OFGlucose Measurement",
                "subjecttype": "VSSTRESNBiomedical Concept"
            },
        "self": {
   "vlmTarget": true
          }"href": "/mdr/specializations/datasetspecializations?biomedicalconcept=C105585",
        ...
     ],

Lines 44-60: VSSTRESN (Line 45) is the next variable on the list. It has an integer as datatype with a preconfigured length of 3. relationship (Lines 53-58) shows how this variable is related to another variable in the format of (subject, predicate, object): VSSTRESN IS_RESULT_OF VSTESTCD.

Code Block

language	yml
firstline	63
linenumbers	true

    "datasetSpecializationId": "SYSBP",
"title": "Dataset Specializations that specialize a Biomedical Concept",
            "domaintype": "VSDataset Specializations List",
        "sdtmigStartVersion": "3-2"}
    },
    "shortNamename": "Systolic Blood PressureDataset Specializations (latest version)",
    "sourcelabel": "VS.VSTESTCDDataset Specializations List"
}

Lines 634-67: Metadata about the SDTM dataset specialization25: A list of SDTM dataset specializations that specialize the Glucose Measurement biomedical concept (C105585).

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Introduction

Model & Schema

Basic Construct

Introduction

Base URL for API Endpoints

Model & Schema

Basic Construct

Core Differences in BC API v2

Anchor
example1
example1
Example 1

Anchor
example
example
Example 2

Anchor
example3
example3
Example 3

Anchor
example4
example4
Example 4

Anchor
example5
example5
Example 5

Anchor
example6
example6
Example 6

Anchor
example7
example7
Example 7

Anchor
example8
example8
Example 8

Anchor
example9
example9
Example 9

Anchor
example10
example10
Example 10

Example 1

Example 2

Anchor
example11
example11
Example

11

Anchor
example12
example12
Example 12

Example 4

Anchor
example13
example13
Example 13

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Introduction

Model & Schema

Basic Construct

Introduction

Base URL for API Endpoints

Model & Schema

Basic Construct

Core Differences in BC API v2

Anchorexample1example1Example 1

AnchorexampleexampleExample 2

Anchorexample3example3Example 3

Anchorexample4example4Example 4

Anchorexample5example5Example 5

Anchorexample6example6Example 6

Anchorexample7example7Example 7

Anchorexample8example8Example 8

Anchorexample9example9Example 9

Anchorexample10example10Example 10

Example 1

Example 2

Anchorexample11example11Example

11

Anchorexample12example12Example 12

Example 4

Anchorexample13example13Example 13

Anchor
example1
example1
Example 1

Anchor
example
example
Example 2

Anchor
example3
example3
Example 3

Anchor
example4
example4
Example 4

Anchor
example5
example5
Example 5

Anchor
example6
example6
Example 6

Anchor
example7
example7
Example 7

Anchor
example8
example8
Example 8

Anchor
example9
example9
Example 9

Anchor
example10
example10
Example 10

Anchor
example11
example11
Example

Anchor
example12
example12
Example 12

Anchor
example13
example13
Example 13