NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the context root in the URLs from 'cadsrapi41' & 'cadsrapi40' to 'cadsrapi4'

...

Code Block
titleResult Set and Page Size
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.Form&gov.nih.nci.cadsr.domain.Form[@workflowStatusName=RELEASED]&startIndex=0&pageSize=30&resultCounter=300 

...

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

    Code Block
    titleRetrieve Data Elements
    http://cadsrapi.nci.nih.gov/cadsrapi40cadsrapi4/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
    titleExtension 1
    [@primaryFlag=Yes]
  2. Retrieve data elements with property Primary, and concept, E-Mail Address.

    Code Block
    titleRetrieve Data Elements
    http://cadsrapi.nci.nih.gov/cadsrapi40cadsrapi4/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
    titleExtension 2
    http://cadsrapi.nci.nih.gov/cadsrapi40cadsrapi4/GetHTML?query=DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@longName=E-mail%20Address]][@primaryFlag=Yes]
    
  3. Retrieve data elements with value domain's value meaning Primary concept code= C19448 (Blood and Blood Products”) (result in XML).

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

...

Code Block
titleExample 1b URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=DataElement[@publicId=2178693][@version=2.1]

...

Code Block
titleExample 2 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=DataElement[@publicId=2178693]

...

Code Block
titleExample 2
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=DataElement[@publicId=2178693][@latestVersionIndicator=Yes]

...

Code Block
titleExample 3 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=DataElement&DataElement[@publicId=2178693]&returnHeavyXML=true

...

Code Block
titleExample 4 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=DataElement&DataElementConcept[@publicId=2178546]

...

Code Block
titleExample 5 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=DataElement&DataElementConcept[@publicId=2178546][@version=2.1]

...

Code Block
titleExample 6b URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=Form[@publicId=2392775][@version=1.0]

...

Code Block
titleExample 7 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=Form[@publicId=2392775]

...

Code Block
titleExample 8 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=Form&Form[@publicId=2392775]&returnHeavyXML=true

...

Code Block
titleExample 9 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=Form&Module&Question&DataElement[@publicId=2183364][@version=1.0]

...

Code Block
titleExample 10 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.Module&gov.nih.nci.cadsr.domain.Form[@version=1.0][@publicID=2392775]

...

Code Block
titleExample 11 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.Question&gov.nih.nci.cadsr.domain.Module[@version=1.0][@publicID=2392777]

...

Code Block
titleExample 12 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=gov.nih.nci.cadsr.domain.DataElement&gov.nih.nci.cadsr.domain.Question[@version=1.0][@publicID=2392779]

...

Code Block
titleExample 13 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetXML?query=AdministeredComponent,AdministeredComponentClassSchemeItem,ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[@ID=A55C551C-1866-5ED1-E034-080020C9C0E0]

...

Code Block
titleExample 14 URL for Results
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetHTML?query=ClassSchemeClassSchemeItem&ClassSchemeClassSchemeItem[ClassificationScheme[@preferredName=NMDP*]]\ClassificationSchemeItem[@longName=2014r1*]

...

Code Block
titleExample 15
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetHTML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

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

...

Code Block
titleExample 16
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetHTML?query=DataElement,DataElementConcept,Property,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C42775]][@primaryFlag=Yes]

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

...

Code Block
titleExample 17
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4
/GetHTML?query=DataElement,EnumeratedValueDomain,ValueDomainPermissibleValue,PermissibleValue,ValueMeaning,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

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

...

Code Block
titleExample 18
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetHTML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicID=106][@version=5.1]

http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetHTML?query=PermissibleValue,ValueDomainPermissibleValue,EnumeratedValueDomain,ValueDomain&DataElement[@publicID=106][@latestVersionIndicator=Yes]

...

Code Block
titleExample 19
http://cadsrapi.nci.nih.gov/cadsrapi41cadsrapi4/GetHTML?query=Concept[@preferredName=C42614]

...

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

    Code Block
    titleRetrieve Data Elements
    http://cadsrapi.nci.nih.gov/cadsrapi40cadsrapi4/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
    titleExtension 1
    [@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”.

    Code Block
    titleRetrieve Data Elements
    http://cadsrapi.nci.nih.gov/cadsrapi40cadsrapi4/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”.

    Code Block
    titleExtension 2
    http://cadsrapi.nci.nih.gov/cadsrapi40cadsrapi4/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).

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