Versions Compared

Key

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

...

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
bordertrue
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
languageyml
linenumberstrue
{
    "_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
languageyml
firstline17
linenumberstrue
    "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.

...