xCaliber healthCare Data Mesh

Visit Note

Visit Note

Source Object: Visit Note

The Visit Note source object represents detailed information about patient visits in a healthcare setting, including clinical notes, checklists, amendments, and other related data.

Overview

Visit Notes are an essential part of the healthcare record, capturing detailed information about a patient's visit to a healthcare provider. They include the patient's medical history, examination details, diagnoses, treatments, and more.

Usage

The Visit Note source object serves multiple purposes in a healthcare platform:

  1. Visit Identification: Each visit note is assigned a unique identifier ("id") for easy reference and retrieval.
  2. Visit Date: The "chart_date" field specifies the date of the patient's visit.
  3. Physician and Patient: Visit notes are associated with a specific physician and patient, providing information about the healthcare provider responsible for the note and the patient for whom the visit was recorded.
  4. Creation and Modification: Visit notes have "created_date" and "deleted_date" fields to track when they were created or, if applicable, deleted. The "signed_date" field represents the date the note was signed.
  5. Visit Confidentiality: The "confidential" field indicates whether the visit note is considered confidential.
  6. Note Type: The "type" field specifies the type of note, such as progress notes, SOAP notes, or other clinical note formats.
  7. Amendments and Edits: Visit notes may have associated amendments, reflecting changes or additions made after the initial note creation. Edits, such as BMI changes, note time adjustments, or weight changes, are captured in the "edits" section.
  8. Templates: Visit notes can be created using predefined templates, and the "template" field stores information about the template used.
  9. Content Structure: Visit notes often include bullet points and checklists to structure the information. These are stored in the "bullets" and "checklists" sections, respectively.

Mapping Table

Data FieldSource Field Data TypeResource Mapping ContextSource Data Field CardinalitySource Data Field DescriptionExample ValueSource Data Field Validation RuleMapped FHIR ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapped FHIR Data Field Type
amendment_requestTBDTop Level0..1-null-DocumentReferenceextension[*].valueString-NAamendment-requeststring
bulletsObjectTop Level1..*list of bullets--DocumentReference--NA-TBD
bullets.categoryValueSetTop Level0..1-Problem"Problem", "Past", "Family", "Social", "Instr", "PE", "ROS", "Med", "Data", "Assessment", "Test", "Tx", "Narrative", "Followup", "Reason", "Plan", "Objective", "Hpi", "Allergies", "Habits", "Assessplan", "Consultant", "Attending", "Dateprocedure", "Surgical", "Orders", "Referenced", "Procedure"DocumentReferencecontent[*].attachment.title-NA-TBD
bullets.childrenObjectTop Level0..*ALPHA. Not visible in the Find Visit Notes endpoint--DocumentReference--NA-TBD
bullets.textStringTop Level0..1-Dizzinessstring(500)DocumentReferencecontent[*].attachment.data-NA-TBD
chart_dateDateTimeTop Level1..1-2010-06-10T11:05:08Z-DocumentReferencecontext.period.start-NA-TBD
checklistsObjectTop Level0..1ROS and/or PE--DocumentReference--NA-TBD
checklists.PEObjectTop Level0..*Physical Exam--DocumentReference--NA-TBD
checklists.PE.nameStringTop Level0..1-General-DocumentReferencecontent[*].attachment.title-NA-TBD
checklists.PE.sequenceIntegerTop Level0..1-0-DocumentReferencecontent[].attachment.extension[].valueInteger-NApe-sequenceinteger
checklists.PE.valueStringTop Level0..1-well nourished-DocumentReferencecontent[*].attachment.data-NA-TBD
checklists.ROSObjectTop Level0..*Review of Systems--DocumentReference--NA-TBD
checklists.ROS.nameStringTop Level0..1-General-DocumentReferencecontent[*].attachment.title-NA-TBD
checklists.ROS.sequenceIntegerTop Level0..1-0-DocumentReferencecontent[].attachment.extension[].valueInteger-NAros-sequenceinteger
checklists.ROS.valueStringTop Level0..1-Denies fever-DocumentReferencecontent[*].attachment.data-NA-TBD
confidentialBooleanTop Level0..1-FALSE-DocumentReferencesecurityLabel[1].coding[1].code and securityLabel[1].coding[1].display-NA-TBD
created_dateDateTimeTop Level0..1-2010-06-10T11:05:08Z-DocumentReferenceextension[*].valueString-NAcreated-datestring
deleted_dateDateTimeTop Level0..1-null-DocumentReferenceextension[*].valueString-NAdeleted-datestring
document_dateDateTimeTop Level1..1-2010-06-10T11:05:08Z-DocumentReferencedate-NA-TBD
editsObjectTop Level0..*---DocumentReference--NA-TBD
idLongTop Level0..1-99024920long(64)DocumentReferenceid-NA-TBD
patientIntegerTop Level1..1-1638401-DocumentReferencesubject.reference-NA-TBD
physicianIntegerTop Level0..1-131074-DocumentReferenceauthor[1].reference-NA-TBD
practiceIntegerTop Level0..1-34323-DocumentReferenceextension[*].valueString-NApracticestring
signed_byIntegerTop Level0..1-131074-DocumentReferenceextension[*].valueString-NAsigned-bystring
signed_dateDateTimeTop Level0..1-2010-06-10T11:05:08Z-DocumentReferenceextension[*].valueString-NAsigned-datestring
templateValueSetTop Level1..1-SOAP"Simple", "SOAP", "Complete H\&P (1 col)", "Complete H\&P (2 col)", "Complete H\&P (2 col A/P)", "Pre-Op"DocumentReferenceextension[*].valueString-NAtemplateTBD
typeStringTop Level0..1This list is managed in the practice's setting pageOffice Visit Notestring(50)DocumentReferencetype.coding[*].display-NA-TBD
edits.create_userIntegerContained0..1-1273-Observationcontained[].extension[].valueInteger-NAcreate-userinteger
edits.created_dateDateTimeContained0..1-2021-07-21T08:14:40Z-Observationcontained[*].issued-NA-TBD
edits.new_bmiDecimalContained0..1-None-Observationcontained[].extension[].valueDecimal-NAnew-bmiTBD
edits.new_note_timeDateTimeContained0..1-None-Observationcontained[].extension[].valueDateTime-NAnew-note-timeTBD
edits.new_prev_bmiDecimalContained0..1-None-Observationcontained[].extension[].valueDecimal-NAnew-prev-bmiTBD
edits.new_prev_timeDateTimeContained0..1-None-Observationcontained[].extension[].valueDateTime-NAnew-prev-timeTBD
edits.new_prev_weightDecimalContained0..1-None-Observationcontained[].extension[].valueDecimal-NAnew-prev-weightTBD
edits.previous_bmiDecimalContained0..1-None-Observationcontained[].extension[].valueDecimal-NAprevious-bmiTBD
edits.previous_note_timeDateTimeContained0..1-None-Observationcontained[].extension[].valueDateTime-NAprevious-note-timeTBD
edits.previous_prev_bmiDecimalContained0..1-None-Observationcontained[].extension[].valueDecimal-NAprevious-prev-bmiTBD
edits.previous_prev_timeDateTimeContained0..1-None-Observationcontained[].extension[].valueDateTime-NAprevious-prev-timeTBD
edits.previous_prev_weightDecimalContained0..1-None-Observationcontained[].extension[].valueDecimal-NAprevious-prev-weightTBD
edits.visit_noteIntegerContained0..1-140755736526872-Observationcontained[*].note[1].authorReference.reference-NA-TBD