 |
Page History
...
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 | ||
|---|---|---|
| ||
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 |
...
Retrieve data elements with object class, Primary, and concept, Blood and Blood Products (result in HTML).
Code Block title Retrieve Data Elements http://cadsrapi.nci.nih.gov/cadsrapi40/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 http://cadsrapi.nci.nih.gov/cadsrapi40/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 http://cadsrapi.nci.nih.gov/cadsrapi40/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 http://cadsrapi.nci.nih.gov/cadsrapi40/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]
...
Example 1 - Find Data Element by Public ID and Version
Find The following examples find a Data Element where Public Id = 2178693 and Version=2.1 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 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.)into Firefox).
| Code Block | ||
|---|---|---|
| ||
https://cdebrowser.nci.nih.gov/CDEBrowser/search?dataElementDetails=9/&cdeId=2178693&version=2.1&PageId=DataElementsGroup&queryDE=yes&FirstTimer=yes |
Or alternatively...
| Code Block |
|---|
http://freestyle.nci.nih.gov/freestyle/do/cdebrowser?publicId=2178693&version=2.1 |
Sample CDE Browser Output from Example 1
Example 1b Results Displayed in XML
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http:http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=DataElement[@publicId=2178693][@version=2.1] |
Example 2 - Find Data Element by Public ID
Find 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 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=DataElement[@publicId=2178693] |
...
Or the query can retrieve only the latest version.
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=DataElement[@publicId=2178693][@latestVersionIndicator=Yes] |
Example 3 - Find Data Element by Public Id, display all related components
Find The following example finds a Data Element with Public Id = 2178693, 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 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=DataElement&DataElement[@publicId=2178693]&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 | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=DataElement&DataElementConcept[@publicId=2178546] |
Example 5 - Find Data Elements associated with a particular Data Element Concept public ID and Version
Find 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 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http:/http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=DataElement&DataElementConcept[@publicId=2178546][@version=2.1] |
...
Example 6 - Find a Form using Form public ID and Version and display basic metadata attributes
Find 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 REST-like API can be used to satisfy this query and results from both are shown below.
...
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=Form[@publicId=2392775][@version=1.0] |
Example 7 - Find a Form using only public id
Find 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.
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=Form[@publicId=2392775] |
Example 8 - Find a Form using public id, display all the metadata associated with the Data Elements
Find 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 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=Form&Form[@publicId=2392775]&returnHeavyXML=true |
Example 9 - Find all the Forms associated with a particular Data Element public id and version
Find 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 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=Form&Module&Question&DataElement[@publicId=2183364][@version=1.0] |
Example 10 - Get all Modules associated with a Form using Form public id
...
Get The following example gets all the modules for form with publicID = 2392775.
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?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
...
Get 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 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?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
...
Get The following example gets all the data elements for question with publicID = 2392779 and version = 1.0.
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=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
...
Get The following example gets all Administered Components for ClassSchemeClassSchemeItem with ID = A55C551C-1866-5ED1-E034-080020C9C0E0
. This will retrieve all AC's and sort them according to type (Form, DE, DEC, etc.).
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetXML?query=AdministeredComponent,AdministeredComponentClassSchemeItem,ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[@ID=A55C551C-1866-5ED1-E034-080020C9C0E0] |
Example 14 - Retrieve all ClassSchemeClassSchemeItem associated with a ClassificationSchemeItem and a ClassificationScheme
...
Get The following example gets all ClassSchemeClassSchemeItem for ClassificationSchemeItem with longName starting with 2014r1
and ClassificationScheme with preferredName starting with NMDP
Note, the .
| 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. |
The URL for the results from the caDSR 4.1 REST API is:
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[ClassificationScheme[@preferredName=NMDP*]]\ClassificationSchemeItem[@longName=2014r1*] |
Examples 15-17 - Get Data Elements using Concept Code or Concept Name
The Examples 15-17 below show retrieving Data Elements show how to retrieve data elements using either the Concept Code concept code or the Concept Name concept name where the concept is the Primary Concept concept of the related caDSR item. In these examples, results are are returned in HTML. All URL's are using the caDSR 4.1 REST 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.
| Code Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes] http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=DataElement,DataElementConcept,ObjectClass,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 | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C42775]][@primaryFlag=Yes] http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@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 | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41 /GetHTML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes] http://cadsrapi.nci.nih.gov/cadsrapi41 /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 | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicID=106][@version=5.1] http://cadsrapi.nci.nih.gov/cadsrapi41/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 Block | ||
|---|---|---|
| ||
http://cadsrapi.nci.nih.gov/cadsrapi41/GetHTML?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?
Answer: Yes. This can be done through any of the caDSR 4.0 APIs, as well as for restricting to Property or a Value Meaning in the CDEs Enumerated Value Domain.
Examples:
...
Example
Retrieve Data Elements with Object Class “Primary” concept named “Blood and Blood Products” (result in HTML).
Code Block title Retrieve Data Elements http://cadsrapi.nci.nih.gov/cadsrapi40/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
...
.
Code Block title Extension 1 [@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 title Retrieve Data Elements http://cadsrapi.nci.nih.gov/cadsrapi40/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 Data Element Concepts with Property “Primary” concept named “E-Mail Address”.
Code Block title Extension 2 http://cadsrapi.nci.nih.gov/cadsrapi40/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 http://cadsrapi.nci.nih.gov/cadsrapi40/GetXML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@longName=Blood and Blood Products]][@primaryFlag=Yes]
