# Note NLP OMOP Table - Data Management with FHIR v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Note NLP OMOP Table**

## Logical Model: Note NLP OMOP Table 

| | |
| :--- | :--- |
| *Official URL*:https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPNoteNLP | *Version*:0.1.0 |
| Draft as of 2025-10-23 | *Computable Name*:OMOPNoteNLP |

 
The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note. 

**Usages:**

* This Logical Model is not used by any profiles in this Implementation Guide

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/aphp.fhir.fr.dm|current/StructureDefinition/OMOPNoteNLP)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-OMOPNoteNLP.csv), [Excel](StructureDefinition-OMOPNoteNLP.xlsx) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "OMOPNoteNLP",
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode" : "can-be-target"
    }
  ],
  "url" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPNoteNLP",
  "version" : "0.1.0",
  "name" : "OMOPNoteNLP",
  "title" : "Note NLP OMOP Table",
  "status" : "draft",
  "date" : "2025-10-23T20:49:03+00:00",
  "publisher" : "AP-HP",
  "contact" : [
    {
      "name" : "AP-HP",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://aphp.fr"
        }
      ]
    }
  ],
  "description" : "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "FR",
          "display" : "France"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPNoteNLP",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "differential" : {
    "element" : [
      {
        "id" : "OMOPNoteNLP",
        "path" : "OMOPNoteNLP",
        "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" : "OMOPNoteNLP.note-nlp-id",
        "path" : "OMOPNoteNLP.note_nlp_id",
        "short" : "Note NLP Identifier",
        "definition" : "Note NLP Identifier",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.note-id",
        "path" : "OMOPNoteNLP.note_id",
        "short" : "Note",
        "definition" : "This is the NOTE_ID for the NOTE record the NLP record is associated to.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPNote"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.section-concept-id",
        "path" : "OMOPNoteNLP.section_concept_id",
        "short" : "Section",
        "definition" : "Section",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.snippet",
        "path" : "OMOPNoteNLP.snippet",
        "short" : "Snippet",
        "definition" : "A small window of text surrounding the term",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.offset",
        "path" : "OMOPNoteNLP.offset",
        "short" : "Offset",
        "definition" : "Character offset of the extracted term in the input note",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.lexical-variant",
        "path" : "OMOPNoteNLP.lexical_variant",
        "short" : "Lexical Variant",
        "definition" : "Raw text extracted from the NLP tool.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.note-nlp-concept-id",
        "path" : "OMOPNoteNLP.note_nlp_concept_id",
        "short" : "Note NLP",
        "definition" : "Note NLP",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.note-nlp-source-concept-id",
        "path" : "OMOPNoteNLP.note_nlp_source_concept_id",
        "short" : "Note NLP Source",
        "definition" : "Note NLP Source",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.nlp-system",
        "path" : "OMOPNoteNLP.nlp_system",
        "short" : "NLP System",
        "definition" : "NLP System",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.nlp-date",
        "path" : "OMOPNoteNLP.nlp_date",
        "short" : "NLP Date",
        "definition" : "The date of the note processing.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "date"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.nlp-datetime",
        "path" : "OMOPNoteNLP.nlp_datetime",
        "short" : "NLP Datetime",
        "definition" : "The date and time of the note processing.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "dateTime"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.term-exists",
        "path" : "OMOPNoteNLP.term_exists",
        "short" : "Term Exists",
        "definition" : "Term Exists",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.term-temporal",
        "path" : "OMOPNoteNLP.term_temporal",
        "short" : "Term Temporal",
        "definition" : "Term Temporal",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNoteNLP.term-modifiers",
        "path" : "OMOPNoteNLP.term_modifiers",
        "short" : "Term Modifiers",
        "definition" : "Term Modifiers",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      }
    ]
  }
}

```
