Page History
The following topics are included in this page.
Table of Contents | ||
---|---|---|
|
Overview
You can view or search for caDSR data by entering a URL in the address bar of a browser and passing parameters in that URL. This page provides examples to get you started, in legacy and caDSR II format:
- A URL in legacy format returns only HTML or XML.
- A URL in caDSR II format returns HTML, XML, or JSON.
Using the API, developers can allow an application to connect to caDSR and search the database. A web browser interface is available to test the API at the Domain Class Browser. The Legacy caDSR REST-like (XML-HTTP) API provide access to content in the caDSR. There are links to the Legacy Java Docs on the Domain Class Browser page.
...
Info | ||
---|---|---|
| ||
You cannot enter multiple " |
(The order of categories is TBD.)
Examples in caDSR II but not Legacy caDSR
(TBD: Examples 20, 21, 24 will move to here.)
Examples for Value Meaning Concepts
Retrieving the Value Meaning Concept Codes for a Data Element That Has an Enumerated Value Domain
Given a data element, you can retrieve the corresponding concept codes for the permissible values in a Value Domain.
If there is a data element with longName My DE
and the permissible values are N=Never
, F=Former
, C=Current
, etc. and the CDE Browser shows the concept code for Never
as C70543, Former
as C0750523, and Current
as C25471, your application can navigate the objects starting at the value domain and work to the corresponding concept code.
For example
- Each Data Element (My DE) that is enumerated has an EnumeratedValueDomain that can be retrieved using getValueDomain
- Each EnumeratedValueDomain has a permissible value list that can be retrieved using getValueDomainPermissibleValueCollection
- Each ValueDomainPermissibleValue in the collection has a getPermissibleValue, in this example (
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 concept code is stored (
C0750523
).
Retrieving a caDSR Item That Has Concept Using the Concept Code or Name, but Restricting the Search to Only Retrieving Items if the Concept is the Primary Concept
(TBD: The caDSR II URLs for this section are new.)
To search for data elements using a concept code or name, but restrict the results to only Primary concepts in the Object Class, refer to the following the examples.
Retrieve data elements with Object Class Concept "C19448" (result in XML) but only if the Concept is indicates as the Primary concept. This is done using the Concept's primaryFlag indicator = "Yes".
Code Block title Retrieve Data Elements - Legacy https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]
Code Block title Retrieve Data Elements - caDSR II https://cadsrapi.cancer.gov/caDSR5.0/GetXML?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 having the Primary Concept with the longName E-Mail Address.
Code Block title Retrieve Data Elements - Legacy https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]
Code Block title Retrieve Data Elements - caDSR II https://cadsrapi.cancer.gov/caDSR5.0/GetXML?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 its Property Primary Concept longName E-Mail Address, remove DataElement (the first item in the query argument list in Example 2):
Retrieve DECs with Property Primary Concept name E-Mail Address.
Code Block title Extension 2 - Legacy https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]
Code Block title Extension 2 - caDSR II https://cadsrapi.cancer.gov/caDSR5.0/GetXML?query=DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]
Retrieve Data Elements with its ValueDomain having a ValueMeaning with a Primary Concept longName Blood and Blood Products (result in XML).
Code Block title Retrieve Data Elements - Legacy https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]
Code Block title Retrieve Data Elements - caDSR II https://cadsrapi.cancer.gov/caDSR5.0/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]
Examples for Data Elements
Example 1 - Find Data Element by Public ID and Version
The following examples find a data element where Public ID = 62 and Version=6, displaying the basic metadata attributes.
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 in Firefox, copy and paste it into IE.)
Code Block |
---|
https://cdebrowser.nci.nih.gov/CDEBrowser/search?dataElementDetails=9/&cdeId=62&version=6&PageId=DataElementsGroup&queryDE=yes&FirstTimer=yes
|
Or alternatively...
Code Block |
---|
https://freestyle.nci.nih.gov/freestyle/do/cdebrowser?publicId=62&version=6 |
Legacy Example 1b 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=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]
|
caDSR II Example 1b Results Displayed in HTML
The URL for the results from the caDSR II REST API is
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetHTML?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
Code Block |
---|
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, displaying 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
The URL for the results from the caDSR 4.1.x REST API is
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement[@publicId=62] |
...
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement[@publicId=62][@latestVersionIndicator=Yes]
|
caDSR II Example 2
The URL for the results from the caDSR II REST API is
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetHTML?query=DataElement[@publicId=62]
|
Or the query can retrieve only the latest version.
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetHTML?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
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement&DataElement[@publicId=62]&returnHeavyXML=true |
caDSR II Example 3
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]&returnHeavyXML=true
|
Example 4 - Find DEC Using Public ID, Display All Associated Data Elements
Find all the data elements associated with the DEC with Public ID = 2178546, displaying the basic metadata of the DEC and its data elements.
Legacy Example 4
The URL for the results from the caDSR 4.0 REST API is
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=DataElement&DataElementConcept[@publicId=2178546]
|
caDSR II Example 4
The URL for the results from the caDSR II REST API is
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetHTML?query=DataElement&DataElementConcept[@publicId=2178546]
|
Example 5 - Find Data Elements Associated with a Particular DEC Public ID and Version
The following example finds only data elements associated with Version 2.1 of DEC with Public ID = 2178546.
Legacy Example 5
The URL for the results from the caDSR 4.1.x REST API is
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement&DataElementConcept[@publicId=2178546][@version=2.1] |
caDSR II Example 5
The URL for the results from the caDSR II REST API is
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?DataElement&DataElementConcept[@publicId=2178546,@version=2.1]
|
Examples for Forms and Related Items
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, displaying 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, copy and paste it into IE.)
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][@version=1.0]
|
caDSR II Example 6
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,@version=1]
|
Example 7 - Find a Form Using Only Public ID
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
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]
|
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
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&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
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&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]
|
Examples for Other Items
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]
|
HTML Comment | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Example 14 - Retrieve All ClassSchemeClassSchemeItem Associated with ClassificationSchemeItem and ClassificationSchemeThe following example gets all
Legacy Example 14The URL for the results from the caDSR 4.1.x REST API is
|
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 XML.
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 XML.
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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/GetXML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C42775]][@primaryFlag=Yes]
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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
/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]
https://cadsrapi.nci.nih.gov/cadsrapi4
/GetXML?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
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicId=106][@version=5.1]
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicId=106][@latestVersionIndicator=Yes]
|
caDSR II Example 18
The URL for the results from the caDSR II REST API is
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=PermissibleValue,ValueDomainPermissibleValue,ValueDomain&DataElement[@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
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=Concept[@preferredName=C42614]
|
caDSR II Example 19
The URL for the results from the caDSR II REST API is
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Concept[@preferredName=C42614]
|
Example 20 - Retrieve a caDSR Form with All Its Collections ("Flattened")
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. XML and HTML formats are not available for this query. You must specify a version.
The following example retrieves a form without specifying a protocol:
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/form.test/getJSON?query=Form[@publicId=7203785,@version=1] |
The following example specifies a protocol:
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/form.test/getJSON?query=Form[Protocol[@preferredName=C3D%20ADOPTER%20TEMPLATES],@publicId=2392775,@version=1] |
Example 21 - Return Permissible Value Info Including Associated Concepts 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.
Code Block |
---|
https://cadsrapi.cancer.gov/caDSR/GetPVXML01?query=PermissibleValue&DataElement[@publicId=62,@version=6] |
Example 22 - Retrieving Any Administered Component by Public ID
The following examples retrieve any administered component by public ID.
Legacy Example 22
Code Block |
---|
https://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=gov.nih.nci.cadsr.domain.AdministeredComponent&gov.nih.nci.cadsr.domain.AdministeredComponent[@publicID=62]
|
caDSR II Example 22
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=AdministeredComponent[@publicId=62] |
Example 23 - Return Form by Public ID and Protocol
The following caDSR II example retrieves forms with protocol by public ID.
Code Block |
---|
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=Form[Protocol[@preferredName=C3D ADOPTER TEMPLATES],@publicId=2392775] |
Example 24 - REST API Data Element
(TBD: Example 24 will move up because it is very similar to Example 1b.)
The following caDSR II example allows machine-to-machine retrieval of data elements by public ID and version.
Code Block |
---|
https://cadsrapi.cancer.gov/rad/caDSR.restapi:GetXML_rad/GetXML/query=DataElement[@publicId=62,@version=6] |
If you want to create a REST API call from machine to machine or application to application, start your URL as follows:
Code Block |
---|
https://cadsrapi.cancer.gov/rad/caDSR.restapi:GetXML_rad/ |
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.
Legacy Examples
Retrieve data elements with Object Class “Primary” concept with concept code "C19448" (result in XML).
Code Block https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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.
Code Block [@primaryFlag=Yes]
Removing this criteria in Example 1 returns 104 results instead of 88.
Retrieve data elements with Property “Primary” concept named “E-Mail Address”.
Code Block https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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 with Property “Primary” concept named “E-Mail Address”.
Code Block https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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 https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]
caDSR II Examples
Retrieve all Data Elements where the Object Class “Primary” concept is concept code "C19448" (result in XML).
Code Block https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement,DataElementConcept,ObjectClass&ComponentConcept[Concept[@preferredName=C19448],@primaryFlag=Yes]
Retrieve all Data Elements where the Object Class “Primary” concept is concept name "E-mail Address" (result in XML).
Code Block https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement,DataElementConcept,Property&ComponentConcept[Concept[@longName=E-mail%20Address],@primaryFlag=Yes]