Schema: Structure

Understanding the JSON schema for the structure endpoint.

JSON Response

Skip to key:value pairs.

{
  "text": "The patient was diagnosed with CHF and renal failure and administered statins.",
  "spans": [
    {
      "concept_id": "UMLS:C0086418",
      "concept_name": "Homo sapiens",
      "concept_type": "Species & Viruses",
      "pos_end": 11,
      "pos_start": 4,
      "score_id": 0.9999945163726807,
      "score_type": 0.9999994039535522,
      "text": "patient"
    },
    {
      "concept_id": "UMLS:C0018801",
      "concept_name": "Heart failure",
      "concept_type": "Medical Conditions",
      "pos_end": 34,
      "pos_start": 31,
      "score_id": 0.997938334941864,
      "score_type": 0.9998775720596313,
      "text": "CHF"
    },
    {
      "concept_id": "UMLS:C0035078",
      "concept_name": "Kidney Failure",
      "concept_type": "Medical Conditions",
      "pos_end": 52,
      "pos_start": 39,
      "score_id": 0.9999425411224365,
      "score_type": 0.9999667406082153,
      "text": "renal failure"
    },
    {
      "concept_id": "UMLS:C0360714",
      "concept_name": "Hydroxymethylglutaryl-CoA Reductase Inhibitors",
      "concept_type": "Chemicals & Drugs",
      "pos_end": 77,
      "pos_start": 70,
      "score_id": 0.9997879862785339,
      "score_type": 0.9999738931655884,
      "text": "statins"
    }
  ]
}

Key:Value Pairs

KeyValue
concept_idThe unique identifier for the medical concept found in the healthcare text (i.e. a UMLS code). This identifier is sourced from the primary ontology and is tied to the concept, not the instance.
concept_nameThe standard reference name for the concept_id. Increases readability by removing the need to look up the unique identifier.
concept_typeThe broad category to which the specific healthcare text was assigned.
pos_endUsed with pos_start under spans. The precise ending index of the healthcare text in text.
pos_startUsed with pos_end under spans. The precise starting index of the healthcare text in text.
score_idThe confidence our API’s model has in its mapping of the healthcare text to the concept_id; 1.0 signifies full confidence from the model for the specified label.
score_typeThe confidence our API’s model has in its mapping of the healthcare text to the concept_type; 1.0 signifies full confidence from the model for the specified label.
spansContains the groups of keys related to each piece of healthcare text.
textThe original text sent to the API for analysis.
text (under spans)A piece of text from the request that is recognized as healthcare information.