{
  "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.",
  "_filename": "StructureDefinition-Note.json",
  "package_name": "hl7.fhir.uv.omop",
  "date": "2025-07-29T21:03:04+00:00",
  "derivation": "specialization",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "fhirVersion": "5.0.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "Note",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Note",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Note OMOP Table",
  "package_version": "1.0.0-ballot",
  "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"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "path": "Note",
      "min": 0,
      "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.",
      "isModifier": false,
      "short": "Note OMOP Table",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "Note",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "Note.note-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.note_id"
      },
      "path": "Note.note_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note Identifier",
      "definition": "Note Identifier"
    }, {
      "id": "Note.person-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.person_id"
      },
      "path": "Note.person_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Person" ]
      } ],
      "short": "Person",
      "definition": "Person"
    }, {
      "id": "Note.note-date",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.note_date"
      },
      "path": "Note.note_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "Note Date",
      "definition": "The date the note was recorded."
    }, {
      "id": "Note.note-datetime",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.note_datetime"
      },
      "path": "Note.note_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Note Datetime",
      "definition": "Note Datetime"
    }, {
      "id": "Note.note-type-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.note_type_concept_id"
      },
      "path": "Note.note_type_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note Type",
      "definition": "The provenance of the note. Most likely this will be EHR."
    }, {
      "id": "Note.note-class-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.note_class_concept_id"
      },
      "path": "Note.note_class_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note Class",
      "definition": "A Standard Concept Id representing the HL7 LOINC\nDocument Type Vocabulary classification of the note."
    }, {
      "id": "Note.note-title",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.note_title"
      },
      "path": "Note.note_title",
      "type": [ {
        "code": "string"
      } ],
      "short": "Title",
      "definition": "The title of the note."
    }, {
      "id": "Note.note-text",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.note_text"
      },
      "path": "Note.note_text",
      "type": [ {
        "code": "string"
      } ],
      "short": "Text",
      "definition": "The content of the note."
    }, {
      "id": "Note.encoding-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.encoding_concept_id"
      },
      "path": "Note.encoding_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Encoding",
      "definition": "This is the Concept representing the character encoding type."
    }, {
      "id": "Note.language-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Note.language_concept_id"
      },
      "path": "Note.language_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Language",
      "definition": "The language of the note."
    }, {
      "id": "Note.provider-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.provider_id"
      },
      "path": "Note.provider_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider" ]
      } ],
      "short": "Provider",
      "definition": "The Provider who wrote the note."
    }, {
      "id": "Note.visit-occurrence-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.visit_occurrence_id"
      },
      "path": "Note.visit_occurrence_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence" ]
      } ],
      "short": "Visit Occurence",
      "definition": "The Visit during which the note was written."
    }, {
      "id": "Note.visit-detail-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.visit_detail_id"
      },
      "path": "Note.visit_detail_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail" ]
      } ],
      "short": "Visit Detail",
      "definition": "The Visit Detail during which the note was written."
    }, {
      "id": "Note.note-source-value",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.note_source_value"
      },
      "path": "Note.note_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Note Source Value",
      "definition": "Note Source Value"
    }, {
      "id": "Note.note-event-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.note_event_id"
      },
      "path": "Note.note_event_id",
      "type": [ {
        "code": "integer"
      } ],
      "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."
    }, {
      "id": "Note.note-event-field-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Note.note_event_field_concept_id"
      },
      "path": "Note.note_event_field_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "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."
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "5.0.0"
    } ]
  },
  "status": "active",
  "id": "b9e840bf-ad55-4589-a0cf-2267289d91e3",
  "kind": "logical",
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Note",
  "version": "1.0.0-ballot",
  "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",
      "max": "1",
      "min": 1,
      "path": "Note.note_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note Identifier",
      "definition": "Note Identifier"
    }, {
      "id": "Note.person-id",
      "max": "1",
      "min": 1,
      "path": "Note.person_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Person" ]
      } ],
      "short": "Person",
      "definition": "Person"
    }, {
      "id": "Note.note-date",
      "max": "1",
      "min": 1,
      "path": "Note.note_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "Note Date",
      "definition": "The date the note was recorded."
    }, {
      "id": "Note.note-datetime",
      "max": "1",
      "min": 0,
      "path": "Note.note_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Note Datetime",
      "definition": "Note Datetime"
    }, {
      "id": "Note.note-type-concept-id",
      "max": "1",
      "min": 1,
      "path": "Note.note_type_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note Type",
      "definition": "The provenance of the note. Most likely this will be EHR."
    }, {
      "id": "Note.note-class-concept-id",
      "max": "1",
      "min": 1,
      "path": "Note.note_class_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Note Class",
      "definition": "A Standard Concept Id representing the HL7 LOINC\nDocument Type Vocabulary classification of the note."
    }, {
      "id": "Note.note-title",
      "max": "1",
      "min": 0,
      "path": "Note.note_title",
      "type": [ {
        "code": "string"
      } ],
      "short": "Title",
      "definition": "The title of the note."
    }, {
      "id": "Note.note-text",
      "max": "1",
      "min": 1,
      "path": "Note.note_text",
      "type": [ {
        "code": "string"
      } ],
      "short": "Text",
      "definition": "The content of the note."
    }, {
      "id": "Note.encoding-concept-id",
      "max": "1",
      "min": 1,
      "path": "Note.encoding_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Encoding",
      "definition": "This is the Concept representing the character encoding type."
    }, {
      "id": "Note.language-concept-id",
      "max": "1",
      "min": 1,
      "path": "Note.language_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Language",
      "definition": "The language of the note."
    }, {
      "id": "Note.provider-id",
      "max": "1",
      "min": 0,
      "path": "Note.provider_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider" ]
      } ],
      "short": "Provider",
      "definition": "The Provider who wrote the note."
    }, {
      "id": "Note.visit-occurrence-id",
      "max": "1",
      "min": 0,
      "path": "Note.visit_occurrence_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence" ]
      } ],
      "short": "Visit Occurence",
      "definition": "The Visit during which the note was written."
    }, {
      "id": "Note.visit-detail-id",
      "max": "1",
      "min": 0,
      "path": "Note.visit_detail_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail" ]
      } ],
      "short": "Visit Detail",
      "definition": "The Visit Detail during which the note was written."
    }, {
      "id": "Note.note-source-value",
      "max": "1",
      "min": 0,
      "path": "Note.note_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Note Source Value",
      "definition": "Note Source Value"
    }, {
      "id": "Note.note-event-id",
      "max": "1",
      "min": 0,
      "path": "Note.note_event_id",
      "type": [ {
        "code": "integer"
      } ],
      "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."
    }, {
      "id": "Note.note-event-field-concept-id",
      "max": "1",
      "min": 0,
      "path": "Note.note_event_field_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "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."
    } ]
  },
  "contact": [ {
    "name": "HL7 International / Biomedical Research and Regulation",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/rcrim",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}