 |
Page History
...
| Table of Contents | ||
|---|---|---|
|
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 | ||
|---|---|---|
| ||
You cannot enter multiple |
Setting Result Set and Page Size for REST-like API
For a caDSR REST-like API:
...
| Info | ||
|---|---|---|
| ||
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 |
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
Formerhas 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 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://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/GetXML?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/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
| 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/GetXML?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/GetXML?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] |
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] |
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 | ||
|---|---|---|
| ||
| 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. |
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
| Code Block |
|---|
https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicId=106][@version=5.1] https://cadsrapi.nci.nih.gov/cadsrapi4/GetHTML?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/GetHTML?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] |
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.
...
