cancerDHC / ccdh-terminology-service

CCDH Terminology and Mapping Service
3 stars 4 forks source link

Update node query for: `​/models​/{model}​/entities​/{entity}​/attributes​/{attribute}` #94

Open joeflack4 opened 2 years ago

joeflack4 commented 2 years ago

Description

There is an inconsistency in the kind of response you get based on the model you are querying, whether node model or CRDC-H.

When querying a CRDC-H entity attr here, you get mappings to nodes, as well as an enumeration.

When querying a node entity attr, you just get a small amount of information about the attribute.

Tasks

Examples

https://terminology.ccdh.io/models/CRDC-H/entities/BodySite/attributes/qualifier

{
  "system": "CRDC-H",
  "entity": "BodySite",
  "attribute": "qualifier",
  "definition": "A qualifier that further refines or specifies the location of the body site (e.g. to indicate laterality, upper v. lower, containment, etc).",
  "node_attributes": [
    {
      "system": "PDC",
      "entity": "Sample",
      "attribute": "biospecimen_laterality",
      "definition": "For tumors in paired organs, designates the side on which the specimen was obtained."
    },
    {
      "system": "GDC",
      "entity": "Sample",
      "attribute": "biospecimen_laterality",
      "definition": "For tumors in paired organs, designates the side on which the specimen was obtained."
    }
  ],
  "concept_references": [
    {
      "code": "C25228",
      "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C25228",
      "designation": "Right",
      "definition": "Being or located on or directed toward the side of the body to the east when facing north.",
      "reference": "https://ncit.nci.nih.gov/ncitbrowser/pages/concept_details.jsf?dictionary=NCI%20Thesaurus&code=C25228"
    },
    {
      "code": "C25229",
      "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C25229",
      "designation": "Left",
      "definition": "Being or located on or directed toward the side of the body to the west when facing north.",
      "reference": "https://ncit.nci.nih.gov/ncitbrowser/pages/concept_details.jsf?dictionary=NCI%20Thesaurus&code=C25229"
    },
    {
      "code": "C13332",
      "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C13332",
      "designation": "Bilateral",
      "definition": "Affecting both sides of the body or a matched pair of organs.",
      "reference": "https://ncit.nci.nih.gov/ncitbrowser/pages/concept_details.jsf?dictionary=NCI%20Thesaurus&code=C13332"
    },
    {
      "code": "C43234",
      "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C43234",
      "designation": "Not Reported",
      "definition": "Not provided or available.",
      "reference": "https://ncit.nci.nih.gov/ncitbrowser/pages/concept_details.jsf?dictionary=NCI%20Thesaurus&code=C43234"
    },
    {
      "code": "C17998",
      "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C17998",
      "designation": "Unknown",
      "definition": "Not known, not observed, not recorded, or refused.",
      "reference": "https://ncit.nci.nih.gov/ncitbrowser/pages/concept_details.jsf?dictionary=NCI%20Thesaurus&code=C17998"
    }
  ]
}

https://terminology.ccdh.io/models/PDC/entities/Sample/attributes/biospecimen_laterality

{
  "system": "PDC",
  "entity": "Sample",
  "attribute": "biospecimen_laterality",
  "definition": "For tumors in paired organs, designates the side on which the specimen was obtained."
}