NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Copyedited.

The following topics are included in this page.Please note that the query parameter for the "model" attribute is a "Like" query with a wildcard to the right (as in '<model>%%'). So Therefore, "PCOR" finds "PCORNet CDM 4.0" , and "CRDC" finds "All CRDC Standard Data Elements". Models are currently represented in caDSR using a Classification Scheme, the . The Classification Scheme Name is the Model Name, the . The Classification Scheme Version is used to represent represents the specific version of the Model. The Table names in the Model are represented using a Classification Scheme Item Name and Version.   CDEs are classified by one or more Classification Scheme/Classification Scheme Item, so the same CDE can be in one or more models.

The returned content is our first pass at what end user users wanted to know. We can add additional information about the CDEs into the APIs based on customer requirements, as long as the information is registered in caDSR. 

in In these APIs, mappings between CDEs are based on common semantic annotations that are used when creating the CDEs. The annotation annotations are made using NCI Thesaurus Concepts Codes instead of direct model-model, CDE-CDE mappings.   The For future expansion of these capabilities, we are investigating the addition of more complex mappings that are not soley solely based on 1-1 semantics is being investigated for future expansion of these capabilities.

The following topics are included in this page.

Numbered Headings
start-numbering-with5
start-numbering-ath2
Panel
titleContents of This Page

Table of Contents
maxLevel3

Get Target CDM Mapped Data Element Name

The ModelMappedElements parameter retrieves all the Target data elements that have been mapped between a specific Source table/attribute and the Target model.

The following table lists the input components and an example value for each component:

Input ComponentExample
Source ModelOMOP
Source Model Version5.3.1
Source TablePerson
Source Attributegender_concept_id
Target ModelPCORnet
Target Model Version4

The example input requests the table/attribute in PCORnet 4.0 that has been mapped to OMOP 5.3.1 element Person/gender_concept_id. 

The following table lists the output components and an example value for each component:

Output ComponentExample
SourcePublicID6144640
SourceVersion1
TargetPublicID6144639
TargetVersion1
TargetTableDEMOGRAPHIC
TargetAttributeSEX

For this example, the output indicates that the element DEMOGRAPHIC/SEX in PCORnet 4.0 has been mapped to Person/gender_concept_id in OMOP 5.3.1.

Code Block
https://cadsrapi.cancer.gov/invoke/caDSRII.ModelApi/GetXML?query=ModelMappedElements[@model=OMOP,@version=5.31,@table=Person,@attributeName=gender_concept_id,@targetModelName=PCORnet,@targetModelVersion=4]


Get Target CDM Data Element and Permitted Value

The ModelMappedValues parameter retrieves the mapped permissible value for a particular Data Element between the Source and Target models.

The following table lists the input components and an example value for each component:

Input ComponentExample
Source ModelOMOP
Source Model Version5.31
Source TablePerson
Source Attributegender_concept_id
Source ValueF
Target ModelPCORnet
Target Model Version4

The example input requests the equivalent permissible value for a CDE in PCORnet model, version 4 that has been mapped to OMOP Model version 5.31 Table = Person, OMOP Name =gender_concept_id, with permissible value "F".

Representation in caDSR of "model" elements:

  • The commonly-used short model name and version is stored in the CS Preferred Name/short name in the Context for the Project.
  • The table name is stored as the CSI Long Name, and also as an alternate Name for each data element with a name type of the model.

For example, in Data Element 6144640 version 1:

  • Owning Context = CDMH Phase I
  • DE is classified by CS/CSI "OMOP 5.31/Person"
  • DEC = 3175307
  • DE Short Name/Preferred Name = gender_concept_id, Alternate name type="OMOP Name"
  • DE Alternate name = PERSON, Alternate name type = "OMOP Table"

The following table lists the output components and an example value for each component:

Output ComponentExample
PublicID6144639
Version1
TargetTableDEMOGRAPHIC
TargetAttributeSEX
TargetValueF
TargetValueConceptC16576

For this example, the output indicates that PCORnet 4.0 table Demographic attribute "sex" with value "F"  has been mapped to OMOP 5.31 table Person attribute gender_concept_id value "F".

Code Block
https://cadsrapi.cancer.gov/invoke/caDSRII.ModelApi/GetXML?query=ModelMappedValues[@model=OMOP,@version=5.31,@table=Person,@attributeName=gender_concept_id,@attributeValue=F,@targetModelName=PCORnet,@targetModelVersion=4]


Get All Target CDM Elements Mapped to Source CDM Table

The ModelMappedTableElements parameter retrieves all the table/attributes in the Source Model table that have been mapped to table/attributes Target Model. 

The following table lists the input components and an example value for each component:

Input ComponentExample
Source ModelOMOP
Source Model Version5.3.1
Source TablePerson
Target ModelPCORnet
Target Model Version4

The example input requests all the mapped data elements from PCORnet version 4.0 that have been mapped to the Person table in OMOP 5.3.1

The following table lists the output components and an example value for each component:

Output ComponentExampleExample
SourcePublicID61446406093481
SourceVersion11
SourceAttributegender_concept_idrace_concept_id
SourceTablePersonPerson
TargetPublicID61446396093452
TargetVersion11
TargetTableDemographicDemographic
TargetAttributeSEXRACE


The API returns all mapped attributes.

Code Block
https://cadsrapi.cancer.gov/invoke/caDSRII.ModelApi/GetXML?query=ModelMappedTableElements[@model=OMOP,@version=5.31,@table=Person,@targetModelName=PCORnet,@targetModelVersion=4]


Get All Attributes in a Model

The ModelAttributes parameter retrieves all the data elements that have been recorded in caDSR for a given version of a model. 

The following table lists the input components and an example value for each component:

Input ComponentExample
Source ModelPCOR
Source Model Version4.0

The example input retrieves all Data Elements classified by the PCOR 4.0 CS and organized by all of its CSIs.

The following table lists the output components and an example value for each component:

Output ComponentExampleExample
Table NameConditionPrescribing
Public ID63652986421699
Version11
AttributeONSET_DATERX_REFILLS
Code Block
https://cadsrapi.cancer.gov/invoke/caDSRII.ModelApi/GetXML?query=ModelAttributes[@model=PCOR,@version=4.0]

...