FHIR to OMOP FHIR IG
0.1.0 - ci-build International flag

FHIR to OMOP FHIR IG, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-omop-ig/ and changes regularly. See the Directory of published versions

Logical Model: NoteNLP - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the NoteNLP logical model.

Guidance on how to interpret the contents of this table can be found here

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.

ShortNote NLP OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. NoteNLP.note-nlp-id
Definition

Note NLP Identifier

ShortNote NLP Identifier
Control1..1
Typecode
Primitive ValueThis 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.

ShortNote
Control1..1
TypeReference(Note OMOP Table)
6. NoteNLP.section-concept-id
Definition

Section

ShortSection
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. NoteNLP.snippet
Definition

A small window of text surrounding the term

ShortSnippet
Control0..1
Typestring
Primitive ValueThis 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

ShortOffset
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. NoteNLP.lexical-variant
Definition

Raw text extracted from the NLP tool.

ShortLexical Variant
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. NoteNLP.note-nlp-concept-id
Definition

Note NLP

ShortNote NLP
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. NoteNLP.note-nlp-source-concept-id
Definition

Note NLP Source

ShortNote NLP Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. NoteNLP.nlp-system
Definition

NLP System

ShortNLP System
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. NoteNLP.nlp-date
Definition

The date of the note processing.

ShortNLP Date
Control1..1
Typedate
Primitive ValueThis 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.

ShortNLP Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. NoteNLP.term-exists
Definition

Term Exists

ShortTerm Exists
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. NoteNLP.term-temporal
Definition

Term Temporal

ShortTerm Temporal
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. NoteNLP.term-modifiers
Definition

Term Modifiers

ShortTerm Modifiers
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

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.

ShortNote NLP OMOP TableBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. NoteNLP.note-nlp-id
Definition

Note NLP Identifier

ShortNote NLP Identifier
Control1..1
Typecode
Primitive ValueThis 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.

ShortNote
Control1..1
TypeReference(Note OMOP Table)
6. NoteNLP.section-concept-id
Definition

Section

ShortSection
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. NoteNLP.snippet
Definition

A small window of text surrounding the term

ShortSnippet
Control0..1
Typestring
Primitive ValueThis 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

ShortOffset
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. NoteNLP.lexical-variant
Definition

Raw text extracted from the NLP tool.

ShortLexical Variant
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. NoteNLP.note-nlp-concept-id
Definition

Note NLP

ShortNote NLP
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. NoteNLP.note-nlp-source-concept-id
Definition

Note NLP Source

ShortNote NLP Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. NoteNLP.nlp-system
Definition

NLP System

ShortNLP System
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. NoteNLP.nlp-date
Definition

The date of the note processing.

ShortNLP Date
Control1..1
Typedate
Primitive ValueThis 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.

ShortNLP Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. NoteNLP.term-exists
Definition

Term Exists

ShortTerm Exists
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. NoteNLP.term-temporal
Definition

Term Temporal

ShortTerm Temporal
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. NoteNLP.term-modifiers
Definition

Term Modifiers

ShortTerm Modifiers
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

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.

ShortNote NLP OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. NoteNLP.note-nlp-id
Definition

Note NLP Identifier

ShortNote NLP Identifier
Control1..1
Typecode
Primitive ValueThis 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.

ShortNote
Control1..1
TypeReference(Note OMOP Table)
6. NoteNLP.section-concept-id
Definition

Section

ShortSection
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. NoteNLP.snippet
Definition

A small window of text surrounding the term

ShortSnippet
Control0..1
Typestring
Primitive ValueThis 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

ShortOffset
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. NoteNLP.lexical-variant
Definition

Raw text extracted from the NLP tool.

ShortLexical Variant
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. NoteNLP.note-nlp-concept-id
Definition

Note NLP

ShortNote NLP
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. NoteNLP.note-nlp-source-concept-id
Definition

Note NLP Source

ShortNote NLP Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. NoteNLP.nlp-system
Definition

NLP System

ShortNLP System
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. NoteNLP.nlp-date
Definition

The date of the note processing.

ShortNLP Date
Control1..1
Typedate
Primitive ValueThis 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.

ShortNLP Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. NoteNLP.term-exists
Definition

Term Exists

ShortTerm Exists
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. NoteNLP.term-temporal
Definition

Term Temporal

ShortTerm Temporal
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. NoteNLP.term-modifiers
Definition

Term Modifiers

ShortTerm Modifiers
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension