FHIR to OMOP FHIR IG
1.0.0-ballot - INFORMATIVE 1 - Ballot
FHIR to OMOP FHIR IG
1.0.0-ballot - INFORMATIVE 1 - Ballot
This page is part of the Vulcan FHIR to OMOP FHIR Implementation Guide (v1.0.0-ballot: INFORMATIVE 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Page standards status: Informative | Maturity Level: 1 |
Definitions for the NoteNLP logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. NoteNLP | |
| Definition | The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note. Base definition for all types defined in FHIR type system. |
| Short | Note NLP OMOP TableBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. NoteNLP.note-nlp-id | |
| Definition | Note NLP Identifier |
| Short | Note NLP Identifier |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. NoteNLP.note-id | |
| Definition | This is the NOTE_ID for the NOTE record the NLP record is associated to. |
| Short | Note |
| Control | 1..1 |
| Type | Reference(Note OMOP Table) |
| 6. NoteNLP.section-concept-id | |
| Definition | Section |
| Short | Section |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. NoteNLP.snippet | |
| Definition | A small window of text surrounding the term |
| Short | Snippet |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. NoteNLP.offset | |
| Definition | Character offset of the extracted term in the input note |
| Short | Offset |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. NoteNLP.lexical-variant | |
| Definition | Raw text extracted from the NLP tool. |
| Short | Lexical Variant |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. NoteNLP.note-nlp-concept-id | |
| Definition | Note NLP |
| Short | Note NLP |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. NoteNLP.note-nlp-source-concept-id | |
| Definition | Note NLP Source |
| Short | Note NLP Source |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. NoteNLP.nlp-system | |
| Definition | NLP System |
| Short | NLP System |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. NoteNLP.nlp-date | |
| Definition | The date of the note processing. |
| Short | NLP Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. NoteNLP.nlp-datetime | |
| Definition | The date and time of the note processing. |
| Short | NLP Datetime |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. NoteNLP.term-exists | |
| Definition | Term Exists |
| Short | Term Exists |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. NoteNLP.term-temporal | |
| Definition | Term Temporal |
| Short | Term Temporal |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. NoteNLP.term-modifiers | |
| Definition | Term Modifiers |
| Short | Term Modifiers |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. NoteNLP | |
| Definition | The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note. |
| Short | Note NLP OMOP Table |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. NoteNLP.note-nlp-id | |
| Definition | Note NLP Identifier |
| Short | Note NLP Identifier |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. NoteNLP.note-id | |
| Definition | This is the NOTE_ID for the NOTE record the NLP record is associated to. |
| Short | Note |
| Control | 1..1 |
| Type | Reference(Note OMOP Table) |
| 6. NoteNLP.section-concept-id | |
| Definition | Section |
| Short | Section |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. NoteNLP.snippet | |
| Definition | A small window of text surrounding the term |
| Short | Snippet |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. NoteNLP.offset | |
| Definition | Character offset of the extracted term in the input note |
| Short | Offset |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. NoteNLP.lexical-variant | |
| Definition | Raw text extracted from the NLP tool. |
| Short | Lexical Variant |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. NoteNLP.note-nlp-concept-id | |
| Definition | Note NLP |
| Short | Note NLP |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. NoteNLP.note-nlp-source-concept-id | |
| Definition | Note NLP Source |
| Short | Note NLP Source |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. NoteNLP.nlp-system | |
| Definition | NLP System |
| Short | NLP System |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. NoteNLP.nlp-date | |
| Definition | The date of the note processing. |
| Short | NLP Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. NoteNLP.nlp-datetime | |
| Definition | The date and time of the note processing. |
| Short | NLP Datetime |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. NoteNLP.term-exists | |
| Definition | Term Exists |
| Short | Term Exists |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. NoteNLP.term-temporal | |
| Definition | Term Temporal |
| Short | Term Temporal |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. NoteNLP.term-modifiers | |
| Definition | Term Modifiers |
| Short | Term Modifiers |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. NoteNLP | |
| Definition | The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note. |
| Short | Note NLP OMOP Table |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. NoteNLP.note-nlp-id | |
| Definition | Note NLP Identifier |
| Short | Note NLP Identifier |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. NoteNLP.note-id | |
| Definition | This is the NOTE_ID for the NOTE record the NLP record is associated to. |
| Short | Note |
| Control | 1..1 |
| Type | Reference(Note OMOP Table) |
| 6. NoteNLP.section-concept-id | |
| Definition | Section |
| Short | Section |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. NoteNLP.snippet | |
| Definition | A small window of text surrounding the term |
| Short | Snippet |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. NoteNLP.offset | |
| Definition | Character offset of the extracted term in the input note |
| Short | Offset |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. NoteNLP.lexical-variant | |
| Definition | Raw text extracted from the NLP tool. |
| Short | Lexical Variant |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. NoteNLP.note-nlp-concept-id | |
| Definition | Note NLP |
| Short | Note NLP |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. NoteNLP.note-nlp-source-concept-id | |
| Definition | Note NLP Source |
| Short | Note NLP Source |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. NoteNLP.nlp-system | |
| Definition | NLP System |
| Short | NLP System |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. NoteNLP.nlp-date | |
| Definition | The date of the note processing. |
| Short | NLP Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. NoteNLP.nlp-datetime | |
| Definition | The date and time of the note processing. |
| Short | NLP Datetime |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. NoteNLP.term-exists | |
| Definition | Term Exists |
| Short | Term Exists |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. NoteNLP.term-temporal | |
| Definition | Term Temporal |
| Short | Term Temporal |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. NoteNLP.term-modifiers | |
| Definition | Term Modifiers |
| Short | Term Modifiers |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2023+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.uv.omop#1.0.0-ballot based on FHIR 5.0.0. Generated 2025-07-29
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change