Page History

...

The following examples find a Data Element where Public Id = 62 and Version=6 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. 

Legacy Example 1a Results Displayed in the CDE Browser

This method can be used to retrieve Data Elements only when you know both the Public ID and Version number (If you have trouble with the following link into Firefox).

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

...

https://freestyle.nci.nih.gov/freestyle/do/cdebrowser?publicId=2178693&version=2.1

Legacy Example 1b Results Displayed in XML

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

https://cadsrapi.nci.nih.gov/cadsrapi4/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 4.1.x REST API is

caDSR II Example 1a Results Displayed in XML

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

https://cadsrapi.nci.nihcancer.gov/cadsrapi4invoke/caDSR/GetXML?query=DataElement[@publicId=62,@version=6]

...

caDSR II Example 1b Results Displayed in HTML

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

https://cadsrapi.ncicancer.nih.gov/invoke/cadsrapi4caDSR/GetXMLGetHTML?query=DataElement[@publicId=62][@latestVersionIndicator=Yes,@version=6]

...

caDSR II Example 1c Results Displayed in JSON

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

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

Example 2 - Find Data Element by Public ID

The following example finds a Data Element with Public Id = 62, display all displaying the basic 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.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

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

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

...

Or the query can retrieve only the latest version.

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

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

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

...

caDSR II Example 2

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

https://cadsrapi.nci.nihcancer.gov/invoke/cadsrapi4caDSR/GetXML?query=DataElement&DataElementConcept[@publicId=2178546][@version=2.1]

...

62]

Or the query can retrieve only the latest version.

https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement[@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

https://cadsrapi

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.)

...

.nci.nih.gov/

...

cadsrapi4/

...

GetXML?query=DataElement&DataElement[@publicId=62]&returnHeavyXML=true

caDSR II Example 3

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

https://cadsrapi.nci.nihcancer.gov/cadsrapi4invoke/caDSR/GetXML?query=FormDataElelemt[@publicId=239277562][@version=1.0]&returnHeavyXML=true

Example

...

4 - Find

...

Data Element Concept using Public ID, Display All Associated Data Elements

Find all the Data Elements associated with the Data Element Concept The following example finds a Form with Public Id = 23927752178546, display displaying 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.of the Data Element Concept and its Data Elements.

Legacy Example 4

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

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=FormDataElement&DataElementConcept[@publicId=23927752178546]

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

The following example finds 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

caDSR II Example 4

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

https://cadsrapi.cancer.gov/invoke/caDSR

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

Example

...

5 - Find

...

Data Elements Associated with a

...

Particular Data Element

...

Concept Public ID and

...

Version

The following example finds all the Forms associated with the CDE only Data Elements associated with VERSION 2.1 of Data Element Concept with Public Id = 2183364, Version 1.0, display the basic metadata of the Form.2178546.

Legacy Example 5

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

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=Form&Module&Question&DataElementDataElement&DataElementConcept[@publicId=21833642178546][@version=2.1.0]

Example 10 - Get all Modules associated with a Form using Form public ID

...

caDSR II Example 5

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

https://cadsrapi.ncicancer.nih.gov/cadsrapi4invoke/caDSR/GetXML?query=gov.nih.nci.cadsr.domain.Module&gov.nih.nci.cadsr.domain.Form[@version=1.0][@publicID=2392775DataElement&DataElementConcept[@publicId=2178546,@version=2.1]

Example

...

6 - Find a Form using Form Public ID and Version, Display Basic Metadata Attributes

The following examples find a Form where Public Id = 2392775 and Version=1.0 and display the basic metadata attributes. 

Legacy 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

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

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

...

...

.nci.nih.gov/

...

FormBuilder/

...

formDetailsAction.do?method=getFormDetails&formIdSeq=FF04F699-FE6A-56AA-E034-0003BA3F9857

Legacy Example 6b Results Displayed in XML

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

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=Form[@publicId=2392775]query=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 gets all the data elements for question with publicID = 2392779 and version = 1.0.

caDSR II Example 6

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

https://cadsrapi.ncicancer.nih.gov/cadsrapi4invoke/caDSR/GetXML?query=gov.nih.nci.cadsr.domain.DataElement&gov.nih.nci.cadsr.domain.Question[Form[@publicId=2392775,@version=1.0][@publicID=2392779]

Example

...

7 - Find a Form Using Only Public 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.).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

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

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=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.

Form[@publicId=2392775]

caDSR II Example 7

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

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

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

https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTMLGetXML?query=ClassSchemeClassSchemeItemForm&ClassSchemeClassSchemeItemForm[ClassificationScheme[@preferredName=NMDP*]]\ClassificationSchemeItem[@longName=2014r1*]

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. All URL's are using the caDSR 4.1.x API.

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.

@publicId=2392775]&returnHeavyXML=true

caDSR II Example 8

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

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

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

https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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

https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Form,Module,Question&DataElement[@publicId=2178480,@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 publicID = 2392775.

Legacy Example 10

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

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

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 publicID = 2392777 and version = 1.0.

Legacy Example 11

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

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

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 publicID = 2392779 and version = 1.0.

Legacy Example 12

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

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

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

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

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.

Legacy Example 14

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

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

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.

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

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

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

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

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,ObjectClassEnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,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

@preferredName=C19448]][@primaryFlag=Yes]

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

caDSR II Example 17

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

https://cadsrapi.nci.nihcancer.gov/invoke/cadsrapi4caDSR/GetHTMLGetXML?query=DataElement,ValueDomain,DataElementConceptValueDomainPermissibleValue,PropertyPermissibleValue,ConceptDerivationRuleValueMeaning&ComponentConcept[Concept[@longName@preferredName=E-mail%20Address]][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 

https://cadsrapi.nci.nih.gov/cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomainPermissibleValue,ValueDomainPermissibleValue,PermissibleValueEnumeratedValueDomain,ValueMeaning,ConceptDerivationRuleValueDomain&ComponentConceptDataElement[Concept[@preferredName=C19448]@publicID=106][@primaryFlag@version=Yes5.1]

https://cadsrapi.nci.nih.gov/cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomainPermissibleValue,ValueDomainPermissibleValue,PermissibleValueEnumeratedValueDomain,ValueMeaning,ConceptDerivationRuleValueDomain&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlagDataElement[@publicID=106][@latestVersionIndicator=Yes]

caDSR II Example 18

...

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

Code Block

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).

Example 18

Code Block
title
https://cadsrapi.nci.nihcancer.gov/cadsrapi4invoke/caDSR/GetHTMLGetXML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicID@publicId=106][,@version=5.1]

Example 19 - Find a Concept by Concept Code

The following examples find a concept with the concept code.

Legacy Example 19

https://cadsrapi.nci.nih.gov/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.

Concept[@preferredName=C42614]

caDSR II Example #

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

https://cadsrapi.nci.nihcancer.gov/cadsrapi4invoke/caDSR/GetHTMLGetXML?query=Concept[@preferredName=C42614]

...

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

   title

   Code Block
   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 where the concept is used either as a primary OR qualifier concept. This is accomplished by removing last qualifier in the query.

   Extension 1

   Code Block
   title
   [@primaryFlag=Yes]

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

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

   title

   Code Block
   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).

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

   title

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

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

   Retrieve Data Elements

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