Error rendering macro 'rw-search'

null

Page History

Versions Compared

Key

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

Comment: Temporarily reverting this page to a previous version (v. 136 from March 01, 2019) so I can copy content of that version to the "2 - caDSR API REST-like Examples" page (in the 4.1.x guide).

...

Table of Contents

minLevel	2

Overview

Using the API, developers can allow an application to connect to caDSR and search the database. The API is available at the Domain Class Browser. The caDSR REST-like (XML-HTTP) API and CDE Browser provide access to, and a means of linking to, caDSR metadata through a standard internet browser.

...

Info

title	Multiple AND IN Note

You cannot enter multiple and or in values for search criteria when using the REST (XML-HTTP) API.

Setting Result Set and Page Size for REST-like API

For a caDSR REST-like RESTlike API:

You can expand or limit the result set using the resultCounter parameter. By default, the result set for a REST-like RESTlike call is limited to 1,000 records, with the set number of records appearing per page, either as the default or as a specified page size.
To change the maximum number of results returned for a query, add the resultCounter=## parameter to the call.
If your total results are less than the page size, the first page of results contain all the returned items.
The resultCounter and pageSize capabilities are available for use in REST-like RESTlike API calls.
For REST-like (XML-HTTPS) calls, page size information is cached, so that if you make a call that identifies a particular page size, subsequent calls will also use that same page size, even without the parameter.
To change the number of results appearing on each page, include a different pageSize parameter in a call, or clear the cache to return to the default.

...

Code Block

title	Result Set and Page Size

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.Form&gov.nih.nci.cadsr.domain.Form[@workflowStatusName=RELEASED]&startIndex=0&pageSize=30&resultCounter=300

You can also add the startIndex parameter to indicate which record should be the first on the page. This means you can alter a query to return the second or third page of results. Generally speaking, however, the startIndex parameter is "zero based" - you start at zero and subsequent pages begin with a startIndex of the next result page. Using the above query as an example, the second page of the results would show startIndex=31, because the page size is 30.

Info

title	Page Size Note

Page size information is cached, so that if you make a call that identifies a particular page size, subsequent calls will also use that same page size, even without the parameter. To change the number of results appearing on each page, include a different size parameter in a call, or clear the cache to return to the default.

Retrieving the Corresponding EVS Concept Codes for the Value Domain

Given a data element, you can retrieve the corresponding EVS concept codes for the values in a Value Domain.

...

Each enumerated value domain (My DE) has a getValueDomainPermissibleValueCollection
Each ValueDomainPermissibleValue in the collection has a getPermissibleValue (F)
Each permissibleValue has a getValueMeaning (Former)
Each valueMeaning has a getConceptDerivationRule in which the list of concepts and their ordering is stored
Each conceptDerivationRule has a getComponentConceptCollection (the primary concept and any qualifier concepts, in this case Former has only a Primary Concept)
Each componentConcept in the collection has a getConcept (returns the Concept Object)
Each concept has an attribute, preferredName in which the corresponding EVS concept code is stored (C0750523).

Searching for a Common EVS Concept Code or Name but Restricting to Primary

To search for data elements using a common EVS concept code or name, but restrict the results to only Primary concepts in the CDE object class, refer to the following the examples.

Retrieve data elements with object class, Primary, and concept, Blood and Blood Products (result in HTML).

Code Block

title	Retrieve Data Elements

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

EXTENSION 1: Additionally, you can find all data elements where the concept is used either as a primary OR qualifier concept. This is accomplished by removing the last qualifier in the query. Removing this criteria in Example 1 returns 104 results instead of 88.

Code Block

title	Extension 1

[@primaryFlag=Yes]

Retrieve data elements with property Primary, and concept, E-Mail Address.

Code Block

title	Retrieve Data Elements

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]

EXTENSION 2: To retrieve the next higher order "type" administered items, remove the name of the item(s) before it in the query argument list. For example, to get Data Element Concepts (DECs) with E-Mail address as the primary concept, remove DataElement (the first item in the query argument list in Example 2):

Retrieve DECs with property Primary, and concept E-Mail Address.

Code Block

title	Extension 2

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]

Retrieve data elements with value domain's value meaning Primary concept code= C19448 (Blood and Blood Products”) (result in XML).

Code Block

title	Retrieve Data Elements

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]

Examples

Example 1 - Find Data Element by Public ID and Version

The following examples find a data element Data Element where Public ID Id = 62 and Version=6 , displaying and display the basic metadata attributes.

...

.Either the CDE Browser or the caDSR REST API can be used to satisfy this query and results from both are shown below.

Example 1a Results Displayed in the CDE Browser

This method can be used to retrieve data elements Data Elements only when you know both the Public ID and Version number . (If you have trouble with the following link in Firefox, copy and paste it into IE.)into Firefox).

code

Code Block

title	Example 1a

https://cdebrowser.nci.nih.gov/CDEBrowser/search?dataElementDetails=9/&cdeId=62&version=6&PageId=DataElementsGroup&queryDE=yes&FirstTimer=yes

...

Code Block
https://freestyle.nci.nih.gov/freestyle/do/cdebrowser?publicId=622178693&version=62.1

...

Example 1b Results Displayed in XML

The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 1b URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement[@publicId=62][@version=6]

caDSR II Example 1a Results Displayed in XML

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement[@publicId=62,@version=6]

...

Example 2 - Find Data Element by Public ID

The following example finds a Data Element with Public Id = 2178693, display the basic metadata attributes, version is not known. Since the version is not known, this query can only be handled via a caDSR REST API query getting all versions.

The URL for the results from the caDSR II 4.1.x REST API is

Code Block

title	Example 2 URL for Results

https://cadsrapi.nci.cancernih.gov/invokecadsrapi4/caDSR/GetHTMLGetXML?query=DataElement[@publicId=62,@version=6]

caDSR II Example 1c Results Displayed in JSON

The URL for the results from the caDSR II REST API is

Or the query can retrieve only the latest version.

Code Block

title	Example 2

Code Block

https://cadsrapi.cancernci.nih.gov/invokecadsrapi4/caDSR/GetJSONGetXML?query=DataElement[@publicId=62,@version=6][@latestVersionIndicator=Yes]

Example

...

3 - Find Data Element by Public ID, display all related components

The following example finds a data element Data Element with Public ID Id = 62, displaying display all the metadata associated with the Data Element's related components, not just the basic metadata attributes. Since the version is not known, this query can only be handled via a caDSR REST API query getting all versions.

Legacy Example 2

This is handled in the caDSR REST API using a parameter that produces expanded ("heavy") XML.

The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 3 URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement&DataElement[@publicId=62]

...

&returnHeavyXML=true

Example 4 - Find Data Element Concept using Public ID and display all its associated Data Elements

Find all the Data Elements associated with the Data Element Concept with Public Id = 2178546, display the basic metadata of the Data Element Concept and its Data Elements.

The URL for the results from the caDSR 4.0 REST API is

Code Block

title	Example 4 URL for Results

https:

Code Block

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement&DataElementConcept[@publicId=622178546][@latestVersionIndicator=Yes]

...

Example 5 - Find Data Elements associated with a particular Data Element Concept public ID and Version

The following example finds only Data Elements associated with VERSION 2.1 of Data Element Concept with Public Id = 2178546.

The URL for the results from the caDSR II 4.1.x REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement[@publicId=62]

Or the query can retrieve only the latest version.

title	Example 5 URL for Results

Code Block

https://cadsrapi.cancernci.nih.gov/invoke/caDSRcadsrapi4/GetXML?query=DataElement&DataElementConcept[@publicId=62,@latestVersionIndicator=yes]

Example 3 - Find Data Element by Public ID, Display All Related Components

The following example finds a data element with Public ID = 62, displaying all the metadata associated with the data element's related components, not just the basic attributes. This is handled in the caDSR REST API using a parameter that produces expanded ("heavy") XML.

Legacy Example 3

The URL for the results from the caDSR 4.1.x REST API is

...

2178546][@version=2.1]

Example 6 - Find a Form using Form public ID and Version and display basic metadata attributes

The following examples find a Form where Public Id = 2392775 and Version=1.0 and display the basic metadata attributes. Either the Form Builder or the caDSR 4.1.x REST-like API can be used to satisfy this query and results from both are shown below.

Example 6a Results Displayed in the Form Builder

This method can be used to retrieve Forms only when you know both the Public ID and Version number. (If you have trouble with the following link in Firefox, cut and paste it into IE.)

https://formbuilder.nci.nih.gov/

...

FormBuilder/

...

formDetailsAction.do?

...

method=

...

getFormDetails&

...

formIdSeq=FF04F699-FE6A-56AA-E034-0003BA3F9857

Example 6b Results Displayed in XML

The URL for the results from the caDSR II 4.1.x REST API is

Code Block

title	Example 6b URL for Results

https://cadsrapi.nci.nihhttps://cadsrapi.cancer.gov/invokecadsrapi4/caDSR/GetXML?query=DataElementForm[@publicId=622392775]&returnHeavyXML=true[@version=1.0]

Example

...

7 - Find

...

a Form using only public ID

The following example finds a Form with Public Id = 2392775, display the basic metadata attributes, version is not known. Since the version is not known, this query can only be handled via a caDSR REST API query.

Find all the data elements associated with the DEC with Public ID = 2178546, displaying the basic metadata of the DEC and its data elements.

...

The URL for the results from the caDSR 4.1.0 x REST API is

Code Block

title	Example 7 URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement&DataElementConceptForm[@publicId=21785462392775]

caDSR II Example 4

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement&DataElementConcept[@publicId=2178546]

...

Example 8 - Find a Form using public ID, display all the metadata associated with the Data Elements

The following example finds only data elements associated with Version 2.1 of DEC with Public ID = 2178546.

...

a Form with Public Id = 2392775, display all the metadata associated with the Data Element's related components, not just the basic attributes. This is handled in the caDSR REST API using a parameter that produces expanded ("heavy") XML.

The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 8 URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElementForm&DataElementConceptForm[@publicId=21785462392775][@version=2.1]

...

&returnHeavyXML=true

Example 9 - Find all the Forms associated with a particular Data Element public ID and version

The following example finds all the Forms associated with the CDE with Public Id = 2183364, Version 1.0, display the basic metadata of the Form.

The URL for the results from the caDSR II 4.1.x REST API is

Code Block

title	Example 9 URL for Results

https://cadsrapi.cancernci.nih.gov/invoke/caDSRcadsrapi4/GetXML?DataElement&DataElementConceptquery=Form&Module&Question&DataElement[@publicId=2178546,2183364][@version=21.10]

Example

...

10 - Get all Modules associated with a Form

...

using Form

...

public ID

The following example gets all the modules for form with publicID = 2392775.

The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 10 URL for Results

The following examples find a Form where Public ID = 2392775 and Version=1.0, displaying the basic metadata attributes.

Legacy Example 6a Results Displayed in the Form Builder

...

https://

...

cadsrapi.nci.nih.gov/

...

cadsrapi4/

...

GetXML?

...

Legacy Example 6b Results Displayed in XML

The URL for the results from the caDSR 4.1.x REST API is

Code Block
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=Form[@publicId=2392775]query=gov.nih.nci.cadsr.domain.Module&gov.nih.nci.cadsr.domain.Form[@version=1.0][@publicID=2392775]

...

Example 11 - Get all the Questions for a Module using Module public ID and version

The following example gets all the questions for module with publicID = 2392777 and version = 1.0.

The URL for the results from the caDSR II 4.1.x REST API is

Code Block

title	Example 11 URL for Results

https://cadsrapi.cancernci.nih.gov/invokecadsrapi4/caDSR/GetXML?query=Form[@publicId=2392775,gov.nih.nci.cadsr.domain.Question&gov.nih.nci.cadsr.domain.Module[@version=1.0][@publicID=2392777]

Example

...

12 - Get all the Data Elements for a Question using Question public ID and version

The following example finds a Form with Public ID = 2392775, displaying the basic metadata attributes. Since the version is not known, this query can only be handled via a caDSR REST API query.

Legacy Example 7

gets all the data elements for question with publicID = 2392779 and version = 1.0.

The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 12 URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=Form[@publicId=2392775]

caDSR II Example 7

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Form[@publicId=2392775]

Example 8 - Find a Form Using Public ID, Display All Metadata Associated with Data Elements

The following example finds a Form with Public ID = 2392775, displaying all the metadata associated with the data element's related components, not just the basic attributes. This is handled in the caDSR REST API using a parameter that produces expanded ("heavy") XML.

Legacy Example 8

gov.nih.nci.cadsr.domain.DataElement&gov.nih.nci.cadsr.domain.Question[@version=1.0][@publicID=2392779]

Example 13 - Retrieve all Administered Components associated with a ClassSchemeClassSchemeItem with a particular ID

The following example gets all Administered Components for ClassSchemeClassSchemeItem with ID = A55C551C-1866-5ED1-E034-080020C9C0E0. This retrieve all AC's and sort them according to type (Form, DE, DEC, etc.).

The URL The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 13 URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=Form&Form[@publicId=2392775]&returnHeavyXML=true

caDSR II Example 8

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Form[@publicId=2392775]&returnHeavyXML=true

Example 9 - Find All Forms Associated with Particular Data Element Public ID and Version

The following example finds all the Forms associated with the CDE with Public ID = 2183364, Version 1.0, displaying the basic metadata of the Form.

Legacy Example 9

AdministeredComponent,AdministeredComponentClassSchemeItem,ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[@ID=A55C551C-1866-5ED1-E034-080020C9C0E0]

Example 14 - Retrieve all ClassSchemeClassSchemeItem associated with a ClassificationSchemeItem and a ClassificationScheme

The following example gets all ClassSchemeClassSchemeItem for ClassificationSchemeItem with longName starting with 2014r1 and ClassificationScheme with preferredName starting with NMDP.

Info

title	Specifying an Association

The association can be specified either through using square brackets '[]' or by using the backslash '\' however, association within the square brackets cannot have further associations as attributes.

The URL for the results from the caDSR 4The URL for the results from the caDSR 4.1.x REST API is

Code Block

title	Example 14 URL for Results

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXMLGetHTML?query=Form&Module&Question&DataElement[@publicId=2183364][@version=1.0]

caDSR II Example 9

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Form,Module,Question&DataElement[@publicId=2183364,@version=1.0]

Example 10 - Get all Modules Associated with a Form Using Form Public ID

The following example gets all the modules for a form with Public ID = 2392775.

Legacy Example 10

The URL for the results from the caDSR 4.1.x REST API is

Code Block
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.Module&gov.nih.nci.cadsr.domain.Form[@version=1.0][@publicId=2392775]

caDSR II Example 10

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Module&Form[@publicId=2392775,@version=1.0]

Example 11 - Get All the Questions for a Module Using Module Public ID and Version

The following example gets all the questions for a module with Public ID = 2392777 and version = 1.0.

Legacy Example 11

The URL for the results from the caDSR 4.1.x REST API is

Code Block
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.Question&gov.nih.nci.cadsr.domain.Module[@version=1.0][@publicId=2392777]

caDSR II Example 11

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Question&Module[@publicId=2392777,@version=1.0]

Example 12 - Get All the Data Elements for Question Using Question Public ID and Version

The following example gets all the data elements for a question with Public ID = 2392779 and version = 1.0.

Legacy Example 12

The URL for the results from the caDSR 4.1.x REST API is

Code Block
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.DataElement&gov.nih.nci.cadsr.domain.Question[@version=1.0][@publicId=2392779]

caDSR II Example 12

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement&Question[@publicId=2392779,@version=1.0]

Example 13 - Retrieve All Administered Components Associated with ClassSchemeClassSchemeItem with Particular ID

The following example gets all Administered Components for ClassSchemeClassSchemeItem with ID = A55C551C-1866-5ED1-E034-080020C9C0E0. This retrieves all ACs and sorts them according to type (Form, DE, DEC, and so on).

Legacy Example 13

The URL for the results from the caDSR 4.1.x REST API is

Code Block

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=AdministeredComponent,AdministeredComponentClassSchemeItem,ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[@ID=A55C551C-1866-5ED1-E034-080020C9C0E0]

caDSR II Example 13

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=AdministeredComponent,AdministeredComponentClassSchemeItem&ClassSchemeClassSchemeItem[@id=A55C551C-1866-5ED1-E034-080020C9C0E0]

Example 14 - Retrieve All ClassSchemeClassSchemeItem Associated with ClassificationSchemeItem and ClassificationScheme

The following example gets all ClassSchemeClassSchemeItem for ClassificationSchemeItem with longName starting with 2014r1 and ClassificationScheme with preferredName starting with NMDP.

Info

title	Specifying an Association

Legacy Example 14

The URL for the results from the caDSR 4.1.x REST API is

Code Block
https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[ClassificationScheme[@preferredName=NMDP]]\ClassificationSchemeItem[@longName=2014r1]

caDSR II Example 14

The URL for the results from the caDSR II REST API is

Code Block
TBD

Examples 15-17 - Get Data Elements Using Concept Code or Concept Name

Examples 15-17 show how to retrieve data elements using either the concept code or the concept name where the concept is the Primary concept of the related caDSR item. In these examples, results are returned in HTML.

Legacy Example 15 - Find All Data Elements Where Associated Concept is Primary Concept of Data Element's Object Class

This example shows the use of either the Concept Code (C19448) or the Concept Name "Blood and Blood Products". Results are identical from these two calls, both are returned in HTML.

Code Block

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]

caDSR II Example 15

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement,DataElementConcept,ObjectClass&ComponentConcept[Concept[@preferredName=C19448],@primaryFlag=Yes]

Legacy Example 16 - Find All Data Elements Where Associated Concept is Primary Concept of Data Element's Property

Code Block

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C42775]][@primaryFlag=Yes]

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]

caDSR II Example 16

The URL for the results from the caDSR II REST API is

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement,DataElementConcept,Property&ComponentConcept[Concept[@preferredName=C42775],@primaryFlag=Yes]

Legacy Example 17 - Find All Data Elements Where Associated Concept is Primary Concept of One of Data Element's Value Domain Value Meanings

Code Block

https://cadsrapi.nci.nih.gov/cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

https://cadsrapi.nci.nih.gov/cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]

caDSR II Example 17

The URL for the results from the caDSR II REST API is

Code Block

https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement,ValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning&ComponentConcept[Concept[@preferredName=C19448],@primaryFlag=Yes]

Example 18 - Find All Enumerated Permissible Values for a Data Element

The following examples find all enumerated permissible values for a data element using the data element's public ID and version or the data element's public ID (and getting latest version).

Legacy Example 18

ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[ClassificationScheme[@preferredName=NMDP*]]\ClassificationSchemeItem[@longName=2014r1*]

Examples 15-17 - Get Data Elements using Concept Code or Concept Name

Example 15 - Find all Data Elements where associated concept is the Primary Concept of the Data Element's Object Class

This example shows the use of either the Concept Code (C19448) or the Concept Name "Blood and Blood Products". Results are identical from these two calls, both are returned in HTML.

Code Block

title	Example 15

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

Code Block

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=PermissibleValueDataElement,ValueDomainPermissibleValueDataElementConcept,EnumeratedValueDomainObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]

Example 16 - Find all Data Elements where associated concept is the Primary Concept of the Data Element's Property

Code Block

title	Example 16

ValueDomain&DataElement[@publicId=106][@version=5.1]

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=PermissibleValueDataElement,ValueDomainPermissibleValueDataElementConcept,EnumeratedValueDomainProperty,ValueDomainConceptDerivationRule&DataElementComponentConcept[Concept[@publicId@preferredName=106C42775]][@latestVersionIndicator@primaryFlag=Yes]

caDSR II Example 18

The URL for the results from the caDSR II REST API is

Code Block


https://cadsrapi.cancernci.nih.gov/invokecadsrapi4/caDSR/GetXMLGetHTML?query=PermissibleValueDataElement,DataElementConcept,ValueDomainPermissibleValueProperty,ValueDomainConceptDerivationRule&DataElementComponentConcept[Concept[@publicId=106,@version=5.1@longName=E-mail%20Address]][@primaryFlag=Yes]

Example

...

17 - Find

...

all Data Elements where associated concept is the Primary Concept of one of the Data Element's Value Domain Value Meanings

Code Block

title	Example 17

The following examples find a concept with the concept code.

Legacy Example 19

code

https://cadsrapi.nci.nih.gov/cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C42614]

caDSR II Example 19

The URL for the results from the caDSR II REST API is

Code Block

C19448]][@primaryFlag=Yes]

https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Concept[@preferredName=C42614nci.nih.gov/cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]

Example

...

18 - Find All Enumerated Permissible Values for a Data Element

The following example finds all enumerated permissible values for a data element using the data element's public ID and version or the data element's public ID (and getting latest version).

Code Block

title	Example 18

The following caDSR II examples retrieve a caDSR form with all its collections, or "flattened". This means for a given form, the system returns all Modules, Questions, Valid Values and related instructions in one call. The system returns results as a JSON file. You must specify a version.

The following example retrieves a form without specifying a protocol:

Code Block
https://cadsrapi.nci.cancernih.gov/invoke/form.test/getJSONcadsrapi4/GetHTML?query=Form[@publicId=7203785,@version=1]

The following example specifies a protocol:

Code Block

PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicID=106][@version=5.1]

https://cadsrapi.nci.cancernih.gov/invoke/form.test/getJSON?query=Form[Protocol[@preferredName=C3D%20ADOPTER%20TEMPLATES],@publicId=2392775,@version=1]

Example 21 - Return Permissible Value Info for a CDE

The following caDSR II example returns the Permissible Value information for a given CDE. If you do not specify the version, the query returns the latest version.

cadsrapi4/GetHTML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicID=106][@latestVersionIndicator=Yes]

Example 19 - Find a Concept by Concept Code

The following example finds a concept with the concept code.

code

Code Block

title	Example 19

https://cadsrapi.cancernci.nih.gov/caDSRcadsrapi4/GetPVXML01GetHTML?query=PermissibleValue&DataElementConcept[@publicId=62,@version=6]@preferredName=C42614]

Can you retrieve all Data Elements using a common EVS concept code or name, but restrict results to only those where the concept is “Primary” in the CDE’s Object Class?

Yes. This can be done through any of the caDSR APIs, as well as for restricting to Property or a Value Meaning in the CDEs Enumerated Value Domain.

Example

Retrieve data elements Data Elements with Object Class “Primary” concept named “Blood and Blood Products” (result in HTML).

Code Block

title	Retrieve Data Elements

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

EXTENSION 1: An extension finds all data elements Data Elements where the concept is used either as a primary OR qualifier concept. This is accomplished by removing last qualifier in the query.

Code Block

title	Extension 1

[@primaryFlag=Yes]

Removing this criteria in Example 1 returns 104 results instead of 88.

Retrieve data elements Data Elements with Property “Primary” concept named “E-Mail Address”.

Code Block

title	Retrieve Data Elements

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]

EXTENSION 2: To retrieve the next higher order "type" administered items, remove the name of the item(s) before it in the query argument list, for example, to get DECs with E-Mail address as the primary concept, remove "DataElement" (the first item in the query argument list in Example 2).

Retrieve DECs Data Element Concepts with Property “Primary” concept named “E-Mail Address”.

Code Block

title	Extension 2

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]

Retrieve data elements Data Elements with Value Domain's Value Meaning "Primary" concept code= C19448 (Blood and Blood Products”) (result in XML).

Code Block

title	Retrieve Data Elements

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]

Content

Space Tools

Page History

Versions Compared

Old Version 147

New Version 148

Key

Overview

Setting Result Set and Page Size for REST-like API

Retrieving the Corresponding EVS Concept Codes for the Value Domain

Searching for a Common EVS Concept Code or Name but Restricting to Primary

Examples

Example 1 - Find Data Element by Public ID and Version

Example 1a Results Displayed in the CDE Browser

Example 1b Results Displayed in XML

caDSR II Example 1a Results Displayed in XML

Example 2 - Find Data Element by Public ID

caDSR II Example 1c Results Displayed in JSON

Example

3 - Find Data Element by Public ID, display all related components

Legacy Example 2

Example 4 - Find Data Element Concept using Public ID and display all its associated Data Elements

Example 5 - Find Data Elements associated with a particular Data Element Concept public ID and Version

Example 3 - Find Data Element by Public ID, Display All Related Components

Legacy Example 3

Example 6 - Find a Form using Form public ID and Version and display basic metadata attributes

Example 6a Results Displayed in the Form Builder

Example 6b Results Displayed in XML

Example

7 - Find

a Form using only public ID

caDSR II Example 4

Example 8 - Find a Form using public ID, display all the metadata associated with the Data Elements

Example 9 - Find all the Forms associated with a particular Data Element public ID and version

Example

10 - Get all Modules associated with a Form

using Form

public ID

Legacy Example 6a Results Displayed in the Form Builder

Legacy Example 6b Results Displayed in XML

Example 11 - Get all the Questions for a Module using Module public ID and version

Example

12 - Get all the Data Elements for a Question using Question public ID and version

Legacy Example 7

caDSR II Example 7

Example 8 - Find a Form Using Public ID, Display All Metadata Associated with Data Elements

Legacy Example 8

Example 13 - Retrieve all Administered Components associated with a ClassSchemeClassSchemeItem with a particular ID

caDSR II Example 8

Example 9 - Find All Forms Associated with Particular Data Element Public ID and Version

Legacy Example 9

Example 14 - Retrieve all ClassSchemeClassSchemeItem associated with a ClassificationSchemeItem and a ClassificationScheme

caDSR II Example 9

Example 10 - Get all Modules Associated with a Form Using Form Public ID

Legacy Example 10

caDSR II Example 10

Example 11 - Get All the Questions for a Module Using Module Public ID and Version

Legacy Example 11

caDSR II Example 11

Example 12 - Get All the Data Elements for Question Using Question Public ID and Version

Legacy Example 12

caDSR II Example 12

Example 13 - Retrieve All Administered Components Associated with ClassSchemeClassSchemeItem with Particular ID

Legacy Example 13

caDSR II Example 13

Example 14 - Retrieve All ClassSchemeClassSchemeItem Associated with ClassificationSchemeItem and ClassificationScheme

Legacy Example 14

caDSR II Example 14

Examples 15-17 - Get Data Elements Using Concept Code or Concept Name

Legacy Example 15 - Find All Data Elements Where Associated Concept is Primary Concept of Data Element's Object Class

caDSR II Example 15

Legacy Example 16 - Find All Data Elements Where Associated Concept is Primary Concept of Data Element's Property

caDSR II Example 16

Legacy Example 17 - Find All Data Elements Where Associated Concept is Primary Concept of One of Data Element's Value Domain Value Meanings

caDSR II Example 17

Example 18 - Find All Enumerated Permissible Values for a Data Element

Legacy Example 18

Examples 15-17 - Get Data Elements using Concept Code or Concept Name

Example 15 - Find all Data Elements where associated concept is the Primary Concept of the Data Element's Object Class

Example 16 - Find all Data Elements where associated concept is the Primary Concept of the Data Element's Property