xCaliber healthCare Data Mesh

Letter Document

Source Object: Letter Document

Overview and Usage: The "Letter Document" source object in the athena EHR system is designed to manage and store various types of letter documents, including correspondence, medical reports, and other written communications. Developers can access and utilize this object for applications involving letter generation, storage, and retrieval. Key data fields include:

  • Action Note: Records actions or comments associated with the letter document.
  • Appointment ID: Links the letter document to a specific appointment.
  • Assigned To: Identifies the recipient or responsible party for the letter.
  • Created Date and Time: Indicates when the letter document was initially created.
  • Created User: Represents the user responsible for creating the letter.
  • Deleted Date and Time: If applicable, marks when the letter document was deleted or removed.
  • Department ID: Specifies the department or entity associated with the letter.
  • Description: Provides a brief description or summary of the content of the letter.
  • Document Source and Subclass: Categorizes the source and type of the document for classification.
  • Encounter ID: Associates the letter document with a specific patient encounter.
  • Entity Type: Identifies the type or category of the entity that the letter pertains to.
  • Internal Note: Allows for internal notes or comments related to the letter document.
  • Last Modified Date: Records the last date of modification for the letter document.
  • Last Modified User: Specifies the user responsible for the most recent modifications.
  • Pages (Content Type, Href, Page ID, Page Ordering): Facilitates page management and layout for multi-page letters.
  • Patient ID: Links the letter document to the relevant patient.
  • Priority: Indicates the level of urgency or importance assigned to the letter.
  • Provider ID: Identifies the healthcare provider or clinician associated with the letter document.
  • Provider Username: Specifies the username of the provider responsible for the letter.
  • Status: Describes the status of the letter document (e.g., draft, pending, approved).
  • Subject: Provides the subject or topic of the letter.
  • Clinical Provider ID: Identifies the healthcare provider associated with the clinical aspects of the letter.
  • Declined Reason Text: If declined, captures the reason or explanation for the letter's decline.
  • Document Class and Type: Categorizes the letter by class and type for organization and searchability.
  • External Accession ID: Links the letter document to an external accession identifier.
  • External Note: Records external notes or comments related to the letter document.
  • Internal Accession ID: Associates the letter with an internal accession identifier.
  • Recipient Name: Specifies the name of the recipient or addressee of the letter.
  • Approved Date and User: Records the approval date and the user responsible for approval.
  • Attachments Link: Stores links or references to any attached documents or files.
  • Callback Number: Provides a callback contact number for the letter recipient.
  • Create From Order ID: If generated from an order, links to the original order.
  • HTML: Contains the letter content in HTML format.
  • Letter ID: Serves as a unique identifier for the letter document.
  • Letter Text: Stores the textual content of the letter.
  • Paper Form Name: If applicable, specifies the name of the associated paper form.
  • XML: Contains the letter content in XML format.
  • XML Title: Stores the title associated with the XML content.
  • XML Type: Indicates the type of XML content within the letter document.

Developers can leverage the "Letter Document" source object to create applications that facilitate the creation, management, and distribution of various letter documents, streamlining communication within healthcare settings or other industries.

Mapping Table

Data FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
actionnote-The most recent action note for a document.string0..1DocumentReferenceextension.valueStringaction-noteTop Level
appointmentid-The appointment ID for this document.integer0..1DocumentReferencecontext.related.referenceappointment-idTop Level
assignedto-Person the document is assigned to.string0..1DocumentReferenceextension.valueStringassigned-toTop Level
createddatetime-Date the document was created. Please use createddatetime instead.string0..1DocumentReferencedateTop Level
createduser-The user who created this document.string0..1DocumentReferenceextension.valueStringcreated-userTop Level
deleteddatetime-Date/time (ISO 8601) the document was deleted.string0..1DocumentReferenceextension.valueDatetimedeleted-datetimeTop Level
departmentid-Department for the document.string0..1DocumentReferenceextension.valueStringdepartment-idTop Level
description-Description of the document type.string0..1DocumentReferencecategory.coding.displayTop Level
documentsource-Explains where this document originated.string0..1DocumentReferenceextension.valueStringdocument-sourceTop Level
documentsubclass-Specific type of document.string0..1DocumentReferencecategory.extension.valueStringdocument-subclassTop Level
encounterid-Encounter ID.string0..1DocumentReferencecontext.encounter.referenceTop Level
entitytype-Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.string0..1DocumentReferenceextension.valueStringentity-typeTop Level
internalnote-The 'Internal Note' attached to this document.string0..1DocumentReferenceextension.valueStringinternal-noteTop Level
lastmodifieddate-Date/time (ISO 8601) the document was last modified.string0..1DocumentReferenceextension.valueDateTimelast-modified-dateTop Level
lastmodifieduser-The user who last modified this document.string0..1DocumentReferenceextension.valueStringlast-modified-userTop Level
pages.contenttype-The content-type that will be returned by the page image call.string0..1DocumentReferencecontent.attachment.contentTypeTop Level
pages.href-The URL to get the document image.string0..1DocumentReferencecontent.attachment.urlTop Level
pages.pageid-The ID to use in a call to get the page image.string0..1DocumentReferencecontent.attachment.idTop Level
pages.pageordering-Within this list of pages, the ordering (starting with 1).string0..1DocumentReferencecontent.attachment.extension.valueStringpage-orderingTop Level
patientid-The athenaNet patient ID.integer0..1DocumentReferencesubject.referenceTop Level
priority-Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.string0..1DocumentReferenceextension.valueStringpriorityTop Level
providerid-Provider ID for this document.integer0..1DocumentReferenceauthor.referenceTop Level
providerusername-The username of the provider associated with this lab result document.string0..1DocumentReferenceauthor.reference.displayTop Level
status-Status of the document.string0..1DocumentReferencestatusTop Level
subject-Subject of the document.string0..1DocumentReferenceextension.valueStringsubjectTop Level
clinicalproviderid-The clinical provider ID of the performing provider.number0..1DocumentReferencecustodian.referenceTop Level
declinedreasontext-The user-facing description of the reason the order was not given.string0..1DocumentReferenceextension.valueStringdeclined-reason-textTop Level
documentclass-Class of document.string0..1DocumentReferencecategory.coding.codeTop Level
documentdescription-Description of the document type.string0..1DocumentReferencedescriptionTop Level
documentroute-Explains method by which the document was entered into the athenaNet (INTERFACE (digital), FAX, etc.).string0..1DocumentReferenceextension.valueStringdocument-routeTop Level
documenttype-The description for this document.string0..1DocumentReferenceextension.valueStringdocument-typeTop Level
documenttypeid-The ID of the description for this document.number0..1DocumentReferenceextension.valueStringdocument-type-idTop Level
externalaccessionid-The external accession ID for this document. Format depends on the system the ID belongs to.string0..1DocumentReferenceextension.valueStringexternal-accession-idTop Level
externalnote-External note for the patient.string0..1DocumentReferenceextension.valueStringexternal-noteTop Level
internalaccessionid-The internal accession ID for this document. Format depends on the system the ID belongs to.string0..1DocumentReferenceextension.valueStringinternal-accession-idTop Level
internalnote-The 'Internal Note' attached to this document.string0..1DocumentReferenceextension.valueStringinternal-noteTop Level
lastmodifieddatetime-Date/time (ISO 8601) the document was last modified.string0..1DocumentReferenceextension.valueDateTimelast-modified-datetimeTop Level
observationdatetime-Date/time (ISO 8601) the observation was taken.string0..1DocumentReferenceextension.valueDateTimeobservation-datetimeTop Level
recipientname-Name of the recipient of this document.String0..1DocumentReferenceextension.valueStringrecipient-nameTop Level
approveddate-The date this document was approved.String0..1DocumentReferenceextension.valueDateapproved-dateTop Level
approveduser-The username of the person who approved this document.String0..1DocumentReferenceextension.valueStringapproved-userTop Level
attachmentslink-Link to an endpoint that can be used to retrieve the clinical letter attachments.String0..1DocumentReferenceextension.valueStringattachments-linkTop Level
callbacknumber-The phone number to use to call back the patient.String0..1DocumentReferenceextension.valueStringcall-back-numberTop Level
createfromorderid-Id of the order document which created this document.integer0..1DocumentReferenceextension.valueStringcreate-from-order-idTop Level
html-The contents of this document in html format.string0..1DocumentReferenceextension.valueStringhtmlTop Level
letterid-The ID for this letter document.integer0..1DocumentReferenceidTop Level
lettertext-Text of this letter. May contain html.string0..1DocumentReferenceextension.valueStringletter-textTop Level
paperformname-Name of the paper form used to generate this document.string0..1DocumentReferenceextension.valueStringpaper-form-nameTop Level
xml-If there is XML with this letter, the raw XML.string0..1DocumentReferenceextension.valueStringxmlTop Level
xmltitle-If there is XML with this letter, the title associated with the XML.string0..1DocumentReferenceextension.valueStringxml-titleTop Level
xmltype-If there is XML with this letter, the type. For example, CCDAs are associated with patient care summaries.string0..1DocumentReferenceextension.valueStringxml-typeTop Level