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 Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
---|---|---|---|---|---|---|---|---|---|---|
actionnote | - | The most recent action note for a document. | string | 0..1 | DocumentReference | extension.valueString | action-note | Top Level | ||
appointmentid | - | The appointment ID for this document. | integer | 0..1 | DocumentReference | context.related.reference | appointment-id | Top Level | ||
assignedto | - | Person the document is assigned to. | string | 0..1 | DocumentReference | extension.valueString | assigned-to | Top Level | ||
createddatetime | - | Date the document was created. Please use createddatetime instead. | string | 0..1 | DocumentReference | date | Top Level | |||
createduser | - | The user who created this document. | string | 0..1 | DocumentReference | extension.valueString | created-user | Top Level | ||
deleteddatetime | - | Date/time (ISO 8601) the document was deleted. | string | 0..1 | DocumentReference | extension.valueDatetime | deleted-datetime | Top Level | ||
departmentid | - | Department for the document. | string | 0..1 | DocumentReference | extension.valueString | department-id | Top Level | ||
description | - | Description of the document type. | string | 0..1 | DocumentReference | category.coding.display | Top Level | |||
documentsource | - | Explains where this document originated. | string | 0..1 | DocumentReference | extension.valueString | document-source | Top Level | ||
documentsubclass | - | Specific type of document. | string | 0..1 | DocumentReference | category.extension.valueString | document-subclass | Top Level | ||
encounterid | - | Encounter ID. | string | 0..1 | DocumentReference | context.encounter.reference | Top Level | |||
entitytype | - | Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS. | string | 0..1 | DocumentReference | extension.valueString | entity-type | Top Level | ||
internalnote | - | The 'Internal Note' attached to this document. | string | 0..1 | DocumentReference | extension.valueString | internal-note | Top Level | ||
lastmodifieddate | - | Date/time (ISO 8601) the document was last modified. | string | 0..1 | DocumentReference | extension.valueDateTime | last-modified-date | Top Level | ||
lastmodifieduser | - | The user who last modified this document. | string | 0..1 | DocumentReference | extension.valueString | last-modified-user | Top Level | ||
pages.contenttype | - | The content-type that will be returned by the page image call. | string | 0..1 | DocumentReference | content.attachment.contentType | Top Level | |||
pages.href | - | The URL to get the document image. | string | 0..1 | DocumentReference | content.attachment.url | Top Level | |||
pages.pageid | - | The ID to use in a call to get the page image. | string | 0..1 | DocumentReference | content.attachment.id | Top Level | |||
pages.pageordering | - | Within this list of pages, the ordering (starting with 1). | string | 0..1 | DocumentReference | content.attachment.extension.valueString | page-ordering | Top Level | ||
patientid | - | The athenaNet patient ID. | integer | 0..1 | DocumentReference | subject.reference | Top Level | |||
priority | - | Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific. | string | 0..1 | DocumentReference | extension.valueString | priority | Top Level | ||
providerid | - | Provider ID for this document. | integer | 0..1 | DocumentReference | author.reference | Top Level | |||
providerusername | - | The username of the provider associated with this lab result document. | string | 0..1 | DocumentReference | author.reference.display | Top Level | |||
status | - | Status of the document. | string | 0..1 | DocumentReference | status | Top Level | |||
subject | - | Subject of the document. | string | 0..1 | DocumentReference | extension.valueString | subject | Top Level | ||
clinicalproviderid | - | The clinical provider ID of the performing provider. | number | 0..1 | DocumentReference | custodian.reference | Top Level | |||
declinedreasontext | - | The user-facing description of the reason the order was not given. | string | 0..1 | DocumentReference | extension.valueString | declined-reason-text | Top Level | ||
documentclass | - | Class of document. | string | 0..1 | DocumentReference | category.coding.code | Top Level | |||
documentdescription | - | Description of the document type. | string | 0..1 | DocumentReference | description | Top Level | |||
documentroute | - | Explains method by which the document was entered into the athenaNet (INTERFACE (digital), FAX, etc.). | string | 0..1 | DocumentReference | extension.valueString | document-route | Top Level | ||
documenttype | - | The description for this document. | string | 0..1 | DocumentReference | extension.valueString | document-type | Top Level | ||
documenttypeid | - | The ID of the description for this document. | number | 0..1 | DocumentReference | extension.valueString | document-type-id | Top Level | ||
externalaccessionid | - | The external accession ID for this document. Format depends on the system the ID belongs to. | string | 0..1 | DocumentReference | extension.valueString | external-accession-id | Top Level | ||
externalnote | - | External note for the patient. | string | 0..1 | DocumentReference | extension.valueString | external-note | Top Level | ||
internalaccessionid | - | The internal accession ID for this document. Format depends on the system the ID belongs to. | string | 0..1 | DocumentReference | extension.valueString | internal-accession-id | Top Level | ||
internalnote | - | The 'Internal Note' attached to this document. | string | 0..1 | DocumentReference | extension.valueString | internal-note | Top Level | ||
lastmodifieddatetime | - | Date/time (ISO 8601) the document was last modified. | string | 0..1 | DocumentReference | extension.valueDateTime | last-modified-datetime | Top Level | ||
observationdatetime | - | Date/time (ISO 8601) the observation was taken. | string | 0..1 | DocumentReference | extension.valueDateTime | observation-datetime | Top Level | ||
recipientname | - | Name of the recipient of this document. | String | 0..1 | DocumentReference | extension.valueString | recipient-name | Top Level | ||
approveddate | - | The date this document was approved. | String | 0..1 | DocumentReference | extension.valueDate | approved-date | Top Level | ||
approveduser | - | The username of the person who approved this document. | String | 0..1 | DocumentReference | extension.valueString | approved-user | Top Level | ||
attachmentslink | - | Link to an endpoint that can be used to retrieve the clinical letter attachments. | String | 0..1 | DocumentReference | extension.valueString | attachments-link | Top Level | ||
callbacknumber | - | The phone number to use to call back the patient. | String | 0..1 | DocumentReference | extension.valueString | call-back-number | Top Level | ||
createfromorderid | - | Id of the order document which created this document. | integer | 0..1 | DocumentReference | extension.valueString | create-from-order-id | Top Level | ||
html | - | The contents of this document in html format. | string | 0..1 | DocumentReference | extension.valueString | html | Top Level | ||
letterid | - | The ID for this letter document. | integer | 0..1 | DocumentReference | id | Top Level | |||
lettertext | - | Text of this letter. May contain html. | string | 0..1 | DocumentReference | extension.valueString | letter-text | Top Level | ||
paperformname | - | Name of the paper form used to generate this document. | string | 0..1 | DocumentReference | extension.valueString | paper-form-name | Top Level | ||
xml | - | If there is XML with this letter, the raw XML. | string | 0..1 | DocumentReference | extension.valueString | xml | Top Level | ||
xmltitle | - | If there is XML with this letter, the title associated with the XML. | string | 0..1 | DocumentReference | extension.valueString | xml-title | Top Level | ||
xmltype | - | If there is XML with this letter, the type. For example, CCDAs are associated with patient care summaries. | string | 0..1 | DocumentReference | extension.valueString | xml-type | Top Level |