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 Note logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Note | |
| 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. Base definition for all types defined in FHIR type system. |
| Short | Note 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. Note.note-id | |
| Definition | Note Identifier |
| Short | Note Identifier |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. Note.person-id | |
| Definition | Person |
| Short | Person |
| Control | 1..1 |
| Type | Reference(Person OMOP Table) |
| 6. Note.note-date | |
| Definition | The date the note was recorded. |
| Short | Note Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Note.note-datetime | |
| Definition | Note Datetime |
| Short | Note Datetime |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Note.note-type-concept-id | |
| Definition | The provenance of the note. Most likely this will be EHR. |
| Short | Note Type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Note.note-class-concept-id | |
| Definition | A Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note. |
| Short | Note Class |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. Note.note-title | |
| Definition | The title of the note. |
| Short | Title |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Note.note-text | |
| Definition | The content of the note. |
| Short | Text |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. Note.encoding-concept-id | |
| Definition | This is the Concept representing the character encoding type. |
| Short | Encoding |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. Note.language-concept-id | |
| Definition | The language of the note. |
| Short | Language |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Note.provider-id | |
| Definition | The Provider who wrote the note. |
| Short | Provider |
| Control | 0..1 |
| Type | Reference(Provider OMOP Table) |
| 24. Note.visit-occurrence-id | |
| Definition | The Visit during which the note was written. |
| Short | Visit Occurence |
| Control | 0..1 |
| Type | Reference(Visit Occurrence OMOP Table) |
| 26. Note.visit-detail-id | |
| Definition | The Visit Detail during which the note was written. |
| Short | Visit Detail |
| Control | 0..1 |
| Type | Reference(Visit Detail OMOP Table) |
| 28. Note.note-source-value | |
| Definition | Note Source Value |
| Short | Note Source Value |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. Note.note-event-id | |
| Definition | If the Note record is related to another record in the database, this field is the primary key of the linked record. |
| Short | Note Event |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Note.note-event-field-concept-id | |
| 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. |
| Short | Note Event Field |
| Control | 0..1 |
| Type | code |
| 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. Note | |
| 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. |
| Short | Note OMOP Table |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Note.note-id | |
| Definition | Note Identifier |
| Short | Note Identifier |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. Note.person-id | |
| Definition | Person |
| Short | Person |
| Control | 1..1 |
| Type | Reference(Person OMOP Table) |
| 6. Note.note-date | |
| Definition | The date the note was recorded. |
| Short | Note Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Note.note-datetime | |
| Definition | Note Datetime |
| Short | Note Datetime |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Note.note-type-concept-id | |
| Definition | The provenance of the note. Most likely this will be EHR. |
| Short | Note Type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Note.note-class-concept-id | |
| Definition | A Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note. |
| Short | Note Class |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. Note.note-title | |
| Definition | The title of the note. |
| Short | Title |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Note.note-text | |
| Definition | The content of the note. |
| Short | Text |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. Note.encoding-concept-id | |
| Definition | This is the Concept representing the character encoding type. |
| Short | Encoding |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. Note.language-concept-id | |
| Definition | The language of the note. |
| Short | Language |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Note.provider-id | |
| Definition | The Provider who wrote the note. |
| Short | Provider |
| Control | 0..1 |
| Type | Reference(Provider OMOP Table) |
| 24. Note.visit-occurrence-id | |
| Definition | The Visit during which the note was written. |
| Short | Visit Occurence |
| Control | 0..1 |
| Type | Reference(Visit Occurrence OMOP Table) |
| 26. Note.visit-detail-id | |
| Definition | The Visit Detail during which the note was written. |
| Short | Visit Detail |
| Control | 0..1 |
| Type | Reference(Visit Detail OMOP Table) |
| 28. Note.note-source-value | |
| Definition | Note Source Value |
| Short | Note Source Value |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. Note.note-event-id | |
| Definition | If the Note record is related to another record in the database, this field is the primary key of the linked record. |
| Short | Note Event |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Note.note-event-field-concept-id | |
| 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. |
| Short | Note Event Field |
| Control | 0..1 |
| Type | code |
| 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. Note | |
| 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. |
| Short | Note 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. Note.note-id | |
| Definition | Note Identifier |
| Short | Note Identifier |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. Note.person-id | |
| Definition | Person |
| Short | Person |
| Control | 1..1 |
| Type | Reference(Person OMOP Table) |
| 6. Note.note-date | |
| Definition | The date the note was recorded. |
| Short | Note Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Note.note-datetime | |
| Definition | Note Datetime |
| Short | Note Datetime |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Note.note-type-concept-id | |
| Definition | The provenance of the note. Most likely this will be EHR. |
| Short | Note Type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Note.note-class-concept-id | |
| Definition | A Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note. |
| Short | Note Class |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. Note.note-title | |
| Definition | The title of the note. |
| Short | Title |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Note.note-text | |
| Definition | The content of the note. |
| Short | Text |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. Note.encoding-concept-id | |
| Definition | This is the Concept representing the character encoding type. |
| Short | Encoding |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. Note.language-concept-id | |
| Definition | The language of the note. |
| Short | Language |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Note.provider-id | |
| Definition | The Provider who wrote the note. |
| Short | Provider |
| Control | 0..1 |
| Type | Reference(Provider OMOP Table) |
| 24. Note.visit-occurrence-id | |
| Definition | The Visit during which the note was written. |
| Short | Visit Occurence |
| Control | 0..1 |
| Type | Reference(Visit Occurrence OMOP Table) |
| 26. Note.visit-detail-id | |
| Definition | The Visit Detail during which the note was written. |
| Short | Visit Detail |
| Control | 0..1 |
| Type | Reference(Visit Detail OMOP Table) |
| 28. Note.note-source-value | |
| Definition | Note Source Value |
| Short | Note Source Value |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. Note.note-event-id | |
| Definition | If the Note record is related to another record in the database, this field is the primary key of the linked record. |
| Short | Note Event |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Note.note-event-field-concept-id | |
| 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. |
| Short | Note Event Field |
| Control | 0..1 |
| Type | code |
| 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