Page History

...

Retrieving the

...

Value Meaning Concept Codes for

...

Data Element that has an Enumerated Value Domain

Given a data element, you can retrieve the corresponding EVS 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 enumerated value domain 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 EVS 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

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 classObject Class, refer to the following the examples.

1. Retrieve data elements with object class, Primary, and concept code Object Class Concept "C19448"   (result in XML)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
   https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement,DataElementConcept,ObjectClass,ConceptDerivationRule&ComponentConcept[Concept[@preferredName=C19448]][@primaryFlag=Yes]

   EXTENSION 1: Additionally, you can find all data elements 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]

2. Retrieve data elements with property Primary, and concept, Data Elements with Property having the Primary Concept with the longName E-Mail Address.

   Code Block
   title Retrieve Data Elements
   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 Data Element Concepts (DECs) with it's Property Primary Concept longName E-Mail address as the primary conceptAddress, remove DataElement (the first item in the query argument list in Example 2):

   Retrieve DECs with property Primary, and concept Property Primary Concept name E-Mail Address.

   Code Block
   title Extension 2
   https://cadsrapi.nci.nih.gov/cadsrapi4/GetXML?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”) Data Elements with it's Value Domain's having a ValueMeaning with a Primary Concept longName 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]

...