FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/Note

Packagehl7.fhir.uv.omop
TypeStructureDefinition
IdNote
FHIR VersionR5
Sourcehttp://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-Note.html
URLhttp://hl7.org/fhir/uv/omop/StructureDefinition/Note
Version1.0.0-ballot
Statusactive
Date2025-07-22T19:48:02+00:00
NameNote
TitleNote OMOP Table
Realmuv
Authorityhl7
DescriptionThe 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.
Typehttp://hl7.org/fhir/uv/omop/StructureDefinition/Note
Kindlogical

Resources that use this resource

StructureDefinition
NoteNLPNote NLP OMOP Table

Resources that this resource uses

StructureDefinition
PersonPerson OMOP Table
ProviderProvider OMOP Table
VisitDetailVisit Detail OMOP Table
VisitOccurrenceVisit Occurrence OMOP Table

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition Note

NameFlagsCard.TypeDescription & Constraintsdoco
.. Note 0..*BaseNote OMOP Table
Instances of this logical model can be the target of a Reference
... note_id 1..1codeNote Identifier
... person_id 1..1Reference(Person OMOP Table)Person
... note_date 1..1dateNote Date
... note_datetime 0..1dateTimeNote Datetime
... note_type_concept_id 1..1codeNote Type
... note_class_concept_id 1..1codeNote Class
... note_title 0..1stringTitle
... note_text 1..1stringText
... encoding_concept_id 1..1codeEncoding
... language_concept_id 1..1codeLanguage
... provider_id 0..1Reference(Provider OMOP Table)Provider
... visit_occurrence_id 0..1Reference(Visit Occurrence OMOP Table)Visit Occurence
... visit_detail_id 0..1Reference(Visit Detail OMOP Table)Visit Detail
... note_source_value 0..1stringNote Source Value
... note_event_id 0..1integerNote Event
... note_event_field_concept_id 0..1codeNote Event Field

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "Note",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "brr"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "informative",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Note",
  "version": "1.0.0-ballot",
  "name": "Note",
  "title": "Note OMOP Table",
  "status": "active",
  "date": "2025-07-22T19:48:02+00:00",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "contact": [
    {
      "name": "HL7 International / Biomedical Research and Regulation",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/rcrim"
        }
      ]
    }
  ],
  "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": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Note",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "Note",
        "path": "Note",
        "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.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Note.note-id",
        "path": "Note.note_id",
        "short": "Note Identifier",
        "definition": "Note Identifier",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.note_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.person-id",
        "path": "Note.person_id",
        "short": "Person",
        "definition": "Person",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.person_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "Note.note-date",
        "path": "Note.note_date",
        "short": "Note Date",
        "definition": "The date the note was recorded.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.note_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "Note.note-datetime",
        "path": "Note.note_datetime",
        "short": "Note Datetime",
        "definition": "Note Datetime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Note.note_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Note.note-type-concept-id",
        "path": "Note.note_type_concept_id",
        "short": "Note Type",
        "definition": "The provenance of the note. Most likely this will be EHR.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.note_type_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.note-class-concept-id",
        "path": "Note.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",
        "base": {
          "path": "Note.note_class_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.note-title",
        "path": "Note.note_title",
        "short": "Title",
        "definition": "The title of the note.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Note.note_title",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Note.note-text",
        "path": "Note.note_text",
        "short": "Text",
        "definition": "The content of the note.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.note_text",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Note.encoding-concept-id",
        "path": "Note.encoding_concept_id",
        "short": "Encoding",
        "definition": "This is the Concept representing the character encoding type.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.encoding_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.language-concept-id",
        "path": "Note.language_concept_id",
        "short": "Language",
        "definition": "The language of the note.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Note.language_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.provider-id",
        "path": "Note.provider_id",
        "short": "Provider",
        "definition": "The Provider who wrote the note.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Note.provider_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider"
            ]
          }
        ]
      },
      {
        "id": "Note.visit-occurrence-id",
        "path": "Note.visit_occurrence_id",
        "short": "Visit Occurence",
        "definition": "The Visit during which the note was written.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Note.visit_occurrence_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"
            ]
          }
        ]
      },
      {
        "id": "Note.visit-detail-id",
        "path": "Note.visit_detail_id",
        "short": "Visit Detail",
        "definition": "The Visit Detail during which the note was written.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Note.visit_detail_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail"
            ]
          }
        ]
      },
      {
        "id": "Note.note-source-value",
        "path": "Note.note_source_value",
        "short": "Note Source Value",
        "definition": "Note Source Value",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Note.note_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Note.note-event-id",
        "path": "Note.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",
        "base": {
          "path": "Note.note_event_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "Note.note-event-field-concept-id",
        "path": "Note.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",
        "base": {
          "path": "Note.note_event_field_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Note",
        "path": "Note",
        "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": "Note.note-id",
        "path": "Note.note_id",
        "short": "Note Identifier",
        "definition": "Note Identifier",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.person-id",
        "path": "Note.person_id",
        "short": "Person",
        "definition": "Person",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "Note.note-date",
        "path": "Note.note_date",
        "short": "Note Date",
        "definition": "The date the note was recorded.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "Note.note-datetime",
        "path": "Note.note_datetime",
        "short": "Note Datetime",
        "definition": "Note Datetime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Note.note-type-concept-id",
        "path": "Note.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": "code"
          }
        ]
      },
      {
        "id": "Note.note-class-concept-id",
        "path": "Note.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": "code"
          }
        ]
      },
      {
        "id": "Note.note-title",
        "path": "Note.note_title",
        "short": "Title",
        "definition": "The title of the note.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Note.note-text",
        "path": "Note.note_text",
        "short": "Text",
        "definition": "The content of the note.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Note.encoding-concept-id",
        "path": "Note.encoding_concept_id",
        "short": "Encoding",
        "definition": "This is the Concept representing the character encoding type.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.language-concept-id",
        "path": "Note.language_concept_id",
        "short": "Language",
        "definition": "The language of the note.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Note.provider-id",
        "path": "Note.provider_id",
        "short": "Provider",
        "definition": "The Provider who wrote the note.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider"
            ]
          }
        ]
      },
      {
        "id": "Note.visit-occurrence-id",
        "path": "Note.visit_occurrence_id",
        "short": "Visit Occurence",
        "definition": "The Visit during which the note was written.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"
            ]
          }
        ]
      },
      {
        "id": "Note.visit-detail-id",
        "path": "Note.visit_detail_id",
        "short": "Visit Detail",
        "definition": "The Visit Detail during which the note was written.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail"
            ]
          }
        ]
      },
      {
        "id": "Note.note-source-value",
        "path": "Note.note_source_value",
        "short": "Note Source Value",
        "definition": "Note Source Value",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Note.note-event-id",
        "path": "Note.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": "Note.note-event-field-concept-id",
        "path": "Note.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": "code"
          }
        ]
      }
    ]
  }
}