Guide d'implémentation du GT Standards et Interopérabilité pour les EDS
0.1.0 - ci-build France flag

Guide d'implémentation du GT Standards et Interopérabilité pour les EDS - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: OMOPNote - Detailed Descriptions

Draft as of 2024-11-23

Definitions for the OMOPNote logical model.

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

0. OMOPNote
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.

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

Note Identifier

ShortNote Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. OMOPNote.person-id
Definition

Person

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. OMOPNote.note-date
Definition

The date the note was recorded.

ShortNote Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. OMOPNote.note-datetime
Definition

Note Datetime

ShortNote Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. OMOPNote.note-type-concept-id
Definition

The provenance of the note. Most likely this will be EHR.

ShortNote Type
Control1..1
TypeReference(Concept OMOP Table)
12. OMOPNote.note-class-concept-id
Definition

A Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note.

ShortNote Class
Control1..1
TypeReference(Concept OMOP Table)
14. OMOPNote.note-title
Definition

The title of the note.

ShortTitle
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. OMOPNote.note-text
Definition

The content of the note.

ShortText
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. OMOPNote.encoding-concept-id
Definition

This is the Concept representing the character encoding type.

ShortEncoding
Control1..1
TypeReference(Concept OMOP Table)
20. OMOPNote.language-concept-id
Definition

The language of the note.

ShortLanguage
Control1..1
TypeReference(Concept OMOP Table)
22. OMOPNote.provider-id
Definition

The Provider who wrote the note.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
24. OMOPNote.visit-occurrence-id
Definition

The Visit during which the note was written.

ShortVisit Occurence
Control0..1
TypeReference(Visit Occurrence OMOP Table)
26. OMOPNote.visit-detail-id
Definition

The Visit Detail during which the note was written.

ShortVisit Detail
Control0..1
TypeReference(Visit Detail OMOP Table)
28. OMOPNote.note-source-value
Definition

Note Source Value

ShortNote Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. OMOPNote.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.

ShortNote Event
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. OMOPNote.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.

ShortNote Event Field
Control0..1
TypeReference(Concept OMOP Table)

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

0. OMOPNote
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.

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

Note Identifier

ShortNote Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. OMOPNote.person-id
Definition

Person

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. OMOPNote.note-date
Definition

The date the note was recorded.

ShortNote Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. OMOPNote.note-datetime
Definition

Note Datetime

ShortNote Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. OMOPNote.note-type-concept-id
Definition

The provenance of the note. Most likely this will be EHR.

ShortNote Type
Control1..1
TypeReference(Concept OMOP Table)
12. OMOPNote.note-class-concept-id
Definition

A Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note.

ShortNote Class
Control1..1
TypeReference(Concept OMOP Table)
14. OMOPNote.note-title
Definition

The title of the note.

ShortTitle
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. OMOPNote.note-text
Definition

The content of the note.

ShortText
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. OMOPNote.encoding-concept-id
Definition

This is the Concept representing the character encoding type.

ShortEncoding
Control1..1
TypeReference(Concept OMOP Table)
20. OMOPNote.language-concept-id
Definition

The language of the note.

ShortLanguage
Control1..1
TypeReference(Concept OMOP Table)
22. OMOPNote.provider-id
Definition

The Provider who wrote the note.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
24. OMOPNote.visit-occurrence-id
Definition

The Visit during which the note was written.

ShortVisit Occurence
Control0..1
TypeReference(Visit Occurrence OMOP Table)
26. OMOPNote.visit-detail-id
Definition

The Visit Detail during which the note was written.

ShortVisit Detail
Control0..1
TypeReference(Visit Detail OMOP Table)
28. OMOPNote.note-source-value
Definition

Note Source Value

ShortNote Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. OMOPNote.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.

ShortNote Event
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. OMOPNote.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.

ShortNote Event Field
Control0..1
TypeReference(Concept OMOP Table)

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

0. OMOPNote
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.

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

Note Identifier

ShortNote Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. OMOPNote.person-id
Definition

Person

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. OMOPNote.note-date
Definition

The date the note was recorded.

ShortNote Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. OMOPNote.note-datetime
Definition

Note Datetime

ShortNote Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. OMOPNote.note-type-concept-id
Definition

The provenance of the note. Most likely this will be EHR.

ShortNote Type
Control1..1
TypeReference(Concept OMOP Table)
12. OMOPNote.note-class-concept-id
Definition

A Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note.

ShortNote Class
Control1..1
TypeReference(Concept OMOP Table)
14. OMOPNote.note-title
Definition

The title of the note.

ShortTitle
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. OMOPNote.note-text
Definition

The content of the note.

ShortText
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. OMOPNote.encoding-concept-id
Definition

This is the Concept representing the character encoding type.

ShortEncoding
Control1..1
TypeReference(Concept OMOP Table)
20. OMOPNote.language-concept-id
Definition

The language of the note.

ShortLanguage
Control1..1
TypeReference(Concept OMOP Table)
22. OMOPNote.provider-id
Definition

The Provider who wrote the note.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
24. OMOPNote.visit-occurrence-id
Definition

The Visit during which the note was written.

ShortVisit Occurence
Control0..1
TypeReference(Visit Occurrence OMOP Table)
26. OMOPNote.visit-detail-id
Definition

The Visit Detail during which the note was written.

ShortVisit Detail
Control0..1
TypeReference(Visit Detail OMOP Table)
28. OMOPNote.note-source-value
Definition

Note Source Value

ShortNote Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. OMOPNote.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.

ShortNote Event
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. OMOPNote.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.

ShortNote Event Field
Control0..1
TypeReference(Concept OMOP Table)