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

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

## Logical Model: Note OMOP Table 

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

 
The NOTE table captures unstructured information that was recorded by a provider about a patient in free text (in ASCII, or preferably in UTF8 format) notes on a given date. The type of note_text is CLOB or varchar(MAX) depending on RDBMS. 

**Usages:**

* Refer to this Logical Model: [Note NLP OMOP Table](StructureDefinition-OMOPNoteNLP.md)

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

### 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-OMOPNote.csv), [Excel](StructureDefinition-OMOPNote.xlsx) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "OMOPNote",
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode" : "can-be-target"
    }
  ],
  "url" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPNote",
  "version" : "0.1.0",
  "name" : "OMOPNote",
  "title" : "Note 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 table captures unstructured information that was recorded by a provider about a patient in free text (in ASCII, or preferably in UTF8 format) notes on a given date. The type of note_text is CLOB or varchar(MAX) depending on RDBMS.",
  "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/OMOPNote",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "differential" : {
    "element" : [
      {
        "id" : "OMOPNote",
        "path" : "OMOPNote",
        "short" : "Note OMOP Table",
        "definition" : "The NOTE table captures unstructured information that was recorded by a provider about a patient in free text (in ASCII, or preferably in UTF8 format) notes on a given date. The type of note_text is CLOB or varchar(MAX) depending on RDBMS."
      },
      {
        "id" : "OMOPNote.note-id",
        "path" : "OMOPNote.note_id",
        "short" : "Note Identifier",
        "definition" : "Note Identifier",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPNote.person-id",
        "path" : "OMOPNote.person_id",
        "short" : "Person",
        "definition" : "Person",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPerson"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.note-date",
        "path" : "OMOPNote.note_date",
        "short" : "Note Date",
        "definition" : "The date the note was recorded.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "date"
          }
        ]
      },
      {
        "id" : "OMOPNote.note-datetime",
        "path" : "OMOPNote.note_datetime",
        "short" : "Note Datetime",
        "definition" : "Note Datetime",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "dateTime"
          }
        ]
      },
      {
        "id" : "OMOPNote.note-type-concept-id",
        "path" : "OMOPNote.note_type_concept_id",
        "short" : "Note Type",
        "definition" : "The provenance of the note. Most likely this will be EHR.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.note-class-concept-id",
        "path" : "OMOPNote.note_class_concept_id",
        "short" : "Note Class",
        "definition" : "A Standard Concept Id representing the HL7 LOINC\nDocument Type Vocabulary classification of the note.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.note-title",
        "path" : "OMOPNote.note_title",
        "short" : "Title",
        "definition" : "The title of the note.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNote.note-text",
        "path" : "OMOPNote.note_text",
        "short" : "Text",
        "definition" : "The content of the note.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNote.encoding-concept-id",
        "path" : "OMOPNote.encoding_concept_id",
        "short" : "Encoding",
        "definition" : "This is the Concept representing the character encoding type.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.language-concept-id",
        "path" : "OMOPNote.language_concept_id",
        "short" : "Language",
        "definition" : "The language of the note.",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.provider-id",
        "path" : "OMOPNote.provider_id",
        "short" : "Provider",
        "definition" : "The Provider who wrote the note.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPProvider"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.visit-occurrence-id",
        "path" : "OMOPNote.visit_occurrence_id",
        "short" : "Visit Occurence",
        "definition" : "The Visit during which the note was written.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPVisitOccurrence"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.visit-detail-id",
        "path" : "OMOPNote.visit_detail_id",
        "short" : "Visit Detail",
        "definition" : "The Visit Detail during which the note was written.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPVisitDetail"
            ]
          }
        ]
      },
      {
        "id" : "OMOPNote.note-source-value",
        "path" : "OMOPNote.note_source_value",
        "short" : "Note Source Value",
        "definition" : "Note Source Value",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPNote.note-event-id",
        "path" : "OMOPNote.note_event_id",
        "short" : "Note Event",
        "definition" : "If the Note record is related to another record in the database, this field is the primary key of the linked record.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPNote.note-event-field-concept-id",
        "path" : "OMOPNote.note_event_field_concept_id",
        "short" : "Note Event Field",
        "definition" : "If the Note record is related to another record in the database, this field is the CONCEPT_ID that identifies which table the primary key of the linked record came from.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      }
    ]
  }
}

```
