{
  "description": "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note.",
  "_filename": "StructureDefinition-NoteNLP.json",
  "package_name": "hl7.fhir.uv.omop",
  "date": "2025-07-29T21:03:04+00:00",
  "derivation": "specialization",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "fhirVersion": "5.0.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "NoteNLP",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/NoteNLP",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Note NLP OMOP Table",
  "package_version": "1.0.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
    "valueCode": "can-be-target"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "brr"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 1,
    "_valueInteger": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
      } ]
    }
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "informative",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "path": "NoteNLP",
      "min": 0,
      "definition": "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note.",
      "isModifier": false,
      "short": "Note NLP OMOP Table",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "NoteNLP",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "NoteNLP.note-nlp-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "NoteNLP.note_nlp_id"
      },
      "path": "NoteNLP.note_nlp_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note NLP Identifier",
      "definition": "Note NLP Identifier"
    }, {
      "id": "NoteNLP.note-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "NoteNLP.note_id"
      },
      "path": "NoteNLP.note_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Note" ]
      } ],
      "short": "Note",
      "definition": "This is the NOTE_ID for the NOTE record the NLP record is associated to."
    }, {
      "id": "NoteNLP.section-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.section_concept_id"
      },
      "path": "NoteNLP.section_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Section",
      "definition": "Section"
    }, {
      "id": "NoteNLP.snippet",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.snippet"
      },
      "path": "NoteNLP.snippet",
      "type": [ {
        "code": "string"
      } ],
      "short": "Snippet",
      "definition": "A small window of text surrounding the term"
    }, {
      "id": "NoteNLP.offset",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.offset"
      },
      "path": "NoteNLP.offset",
      "type": [ {
        "code": "string"
      } ],
      "short": "Offset",
      "definition": "Character offset of the extracted term in the input note"
    }, {
      "id": "NoteNLP.lexical-variant",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "NoteNLP.lexical_variant"
      },
      "path": "NoteNLP.lexical_variant",
      "type": [ {
        "code": "string"
      } ],
      "short": "Lexical Variant",
      "definition": "Raw text extracted from the NLP tool."
    }, {
      "id": "NoteNLP.note-nlp-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.note_nlp_concept_id"
      },
      "path": "NoteNLP.note_nlp_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note NLP",
      "definition": "Note NLP"
    }, {
      "id": "NoteNLP.note-nlp-source-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.note_nlp_source_concept_id"
      },
      "path": "NoteNLP.note_nlp_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note NLP Source",
      "definition": "Note NLP Source"
    }, {
      "id": "NoteNLP.nlp-system",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.nlp_system"
      },
      "path": "NoteNLP.nlp_system",
      "type": [ {
        "code": "string"
      } ],
      "short": "NLP System",
      "definition": "NLP System"
    }, {
      "id": "NoteNLP.nlp-date",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "NoteNLP.nlp_date"
      },
      "path": "NoteNLP.nlp_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "NLP Date",
      "definition": "The date of the note processing."
    }, {
      "id": "NoteNLP.nlp-datetime",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.nlp_datetime"
      },
      "path": "NoteNLP.nlp_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "NLP Datetime",
      "definition": "The date and time of the note processing."
    }, {
      "id": "NoteNLP.term-exists",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.term_exists"
      },
      "path": "NoteNLP.term_exists",
      "type": [ {
        "code": "string"
      } ],
      "short": "Term Exists",
      "definition": "Term Exists"
    }, {
      "id": "NoteNLP.term-temporal",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.term_temporal"
      },
      "path": "NoteNLP.term_temporal",
      "type": [ {
        "code": "string"
      } ],
      "short": "Term Temporal",
      "definition": "Term Temporal"
    }, {
      "id": "NoteNLP.term-modifiers",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "NoteNLP.term_modifiers"
      },
      "path": "NoteNLP.term_modifiers",
      "type": [ {
        "code": "string"
      } ],
      "short": "Term Modifiers",
      "definition": "Term Modifiers"
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "5.0.0"
    } ]
  },
  "status": "active",
  "id": "c4832be4-4993-4bf4-8d61-dc45fe91b16b",
  "kind": "logical",
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/NoteNLP",
  "version": "1.0.0-ballot",
  "differential": {
    "element": [ {
      "id": "NoteNLP",
      "path": "NoteNLP",
      "short": "Note NLP OMOP Table",
      "definition": "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note."
    }, {
      "id": "NoteNLP.note-nlp-id",
      "max": "1",
      "min": 1,
      "path": "NoteNLP.note_nlp_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note NLP Identifier",
      "definition": "Note NLP Identifier"
    }, {
      "id": "NoteNLP.note-id",
      "max": "1",
      "min": 1,
      "path": "NoteNLP.note_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Note" ]
      } ],
      "short": "Note",
      "definition": "This is the NOTE_ID for the NOTE record the NLP record is associated to."
    }, {
      "id": "NoteNLP.section-concept-id",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.section_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Section",
      "definition": "Section"
    }, {
      "id": "NoteNLP.snippet",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.snippet",
      "type": [ {
        "code": "string"
      } ],
      "short": "Snippet",
      "definition": "A small window of text surrounding the term"
    }, {
      "id": "NoteNLP.offset",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.offset",
      "type": [ {
        "code": "string"
      } ],
      "short": "Offset",
      "definition": "Character offset of the extracted term in the input note"
    }, {
      "id": "NoteNLP.lexical-variant",
      "max": "1",
      "min": 1,
      "path": "NoteNLP.lexical_variant",
      "type": [ {
        "code": "string"
      } ],
      "short": "Lexical Variant",
      "definition": "Raw text extracted from the NLP tool."
    }, {
      "id": "NoteNLP.note-nlp-concept-id",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.note_nlp_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note NLP",
      "definition": "Note NLP"
    }, {
      "id": "NoteNLP.note-nlp-source-concept-id",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.note_nlp_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note NLP Source",
      "definition": "Note NLP Source"
    }, {
      "id": "NoteNLP.nlp-system",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.nlp_system",
      "type": [ {
        "code": "string"
      } ],
      "short": "NLP System",
      "definition": "NLP System"
    }, {
      "id": "NoteNLP.nlp-date",
      "max": "1",
      "min": 1,
      "path": "NoteNLP.nlp_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "NLP Date",
      "definition": "The date of the note processing."
    }, {
      "id": "NoteNLP.nlp-datetime",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.nlp_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "NLP Datetime",
      "definition": "The date and time of the note processing."
    }, {
      "id": "NoteNLP.term-exists",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.term_exists",
      "type": [ {
        "code": "string"
      } ],
      "short": "Term Exists",
      "definition": "Term Exists"
    }, {
      "id": "NoteNLP.term-temporal",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.term_temporal",
      "type": [ {
        "code": "string"
      } ],
      "short": "Term Temporal",
      "definition": "Term Temporal"
    }, {
      "id": "NoteNLP.term-modifiers",
      "max": "1",
      "min": 0,
      "path": "NoteNLP.term_modifiers",
      "type": [ {
        "code": "string"
      } ],
      "short": "Term Modifiers",
      "definition": "Term Modifiers"
    } ]
  },
  "contact": [ {
    "name": "HL7 International / Biomedical Research and Regulation",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/rcrim",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}