SHARE Example - Standards

If you were to request to get a standards list, “/standards” from the SHARE API Schema on the SHARE for Technical Implementers page, the API would return the following XML containing a list of all Implementation Guide-level standards within SHARE. Each standard has its own unique entity object identifier, or OID. Each standard returned includes a set of URLs for requesting additional details. For the "/standards" resource the Alias elements provide URLs for requesting the data classes, data domains, or the complete standard. Developers use this additional information to discover the next level of detail made available through the standards hierarchy.

The ODM-based XML returned from SHARE is extended to include additional metadata. Standards content typically includes the mdr:Status attribute that indicates the lifecycle stage of the standard, and the mdr:DatePublished that indicates when the standard was published in SHARE.

An XML excerpt with some of the content from the complete listing of fetched results:

 <ODM xmlns="http://www.cdisc.org/ns/odm/v1.3" xmlns:mdr="http://www.cdisc.org/ns/SHARE-XML/v1.0" xmlns:mdrodm="http://www.cdisc.org/ns/SHARE-ODM/v1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" CreationDateTime="2017-03-06T09:57:08" FileOID="Semantics.Manager.SHARE.11.5.getStandards" FileType="Snapshot" ODMVersion="1.3.2" SourceSystem="SHARE" SourceSystemVersion="7.1.3.97" mdr:BaseURI="https://share.cdisc.org/sm/rest/semantics/SHARE" xsi:schemaLocation="http://www.cdisc.org/ns/odm/v1.3 share-odm-1-0-0.xsd">
    <Study OID="SHARE.11.5.getStandards">
        <GlobalVariables>
            <StudyName>SHARE Data Standards</StudyName>
            <StudyDescription>A list of data standards</StudyDescription>
            <ProtocolName>List</ProtocolName>
        </GlobalVariables>
        <MetaDataVersion Name="SHARE" OID="MDV.11.5.getStandards" mdr:ShareXMLVersion="1.0.0">
            <ItemGroupDef Name="SDTM (MDES 3.1.2)" OID="1.0_1391054074081152706575" Purpose="Data Tabulations" Repeating="No" mdr:DatePublished="2017-01-25" mdr:Status="Approved Final">
                <Description>
                    <TranslatedText xml:lang="en">Study Data Tabulation Model (SDTM) 1.2, SDTM IG 3.1.2</TranslatedText>
                </Description>
                <Alias Context="Data Classes API" Name="/standards/{asset-id}/classes"/>
                <Alias Context="Data Domains API" Name="/standards/{asset-id}/domains"/>
                <Alias Context="Standard Metadata API" Name="/standards/{asset-id}/metadata"/>
            </ItemGroupDef>
            <ItemGroupDef Name="SDTM (MDES 3.1.3)" OID="1.0_13969030352051659917782" Purpose="Data Tabulations" Repeating="No" mdr:DatePublished="2017-01-25" mdr:Status="Approved Final">
                <Description>
                    <TranslatedText xml:lang="en">Study Data Tabulation Model (SDTM) 1.3, SDTM IG 3.1.3</TranslatedText>
                </Description>
                <Alias Context="Data Classes API" Name="/standards/{asset-id}/classes"/>
                <Alias Context="Data Domains API" Name="/standards/{asset-id}/domains"/>
                <Alias Context="Standard Metadata API" Name="/standards/{asset-id}/metadata"/>
            </ItemGroupDef>
            <ItemGroupDef Name="SDTM (MDES 3.2)" OID="1.0_1403536355619-785103875" Purpose="Data Tabulations" Repeating="No" mdr:DatePublished="2017-01-12" mdr:Status="Approved Final">
                <Description>
                    <TranslatedText xml:lang="en">Study Data Tabulation Model (SDTM) 1.4, SDTM IG 3.2</TranslatedText>
                </Description>
                <Alias Context="Data Classes API" Name="/standards/{asset-id}/classes"/>
                <Alias Context="Data Domains API" Name="/standards/{asset-id}/domains"/>
                <Alias Context="Standard Metadata API" Name="/standards/{asset-id}/metadata"/>
            </ItemGroupDef>
        </MetaDataVersion>
    </Study>
</ODM>