Letter
Letter
Source Object: Letter
The Letter source object represents letters in the context of healthcare. These letters can include various types of correspondence, such as patient communication, referrals, medical reports, and other written documents. This source object provides information about the creation, transmission, and details of these letters.
Overview
Letters are essential for communication in healthcare, allowing providers, patients, and other stakeholders to exchange information, medical records, and instructions. The Letter source object captures important metadata and content associated with these letters.
Usage
The Letter source object serves several key purposes:
- Attachments: It provides information about attachments associated with the letter. These attachments may include documents, reports, or other files relevant to the letter's content.
- Document Details: Details related to the document, such as document type, date, description, and unique identifiers, are included.
- Patient Information: The patient who is the subject of the letter is identified. This ensures that the letter is associated with the correct individual's medical records.
- Practice and Provider: Information about the healthcare practice and provider responsible for generating the letter is recorded.
- Delivery Information: Details about the letter's delivery method, recipient, and status, including whether it has been acknowledged or not.
- Letter Content: The body of the letter, including text, subject, and other related content, is captured.
- Resolution: The resolution section provides information about actions taken in response to the letter, such as acknowledgments, follow-ups, and any related documents.
Letters are a fundamental means of communication in healthcare. They facilitate the exchange of medical information, referrals, and instructions, and they help ensure that healthcare professionals and patients are on the same page regarding treatment and care.
| Data Field | Source Field Data Type | Resource Mapping Context | Source Data Field Cardinality | Source Data Field Description | Example Value | Source Data Field Validation Rule | Mapped FHIR Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapped FHIR Data Field Type | xCaliber Resource |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attachments | Object | Top Level | 0..* | - | - | - | DocumentReference | - | - | NA | TBD | ||
| attachments.document_type | String | Top Level | 0..1 | - | - | "Entity", "RefPanel", "PatientDemog", "ImmHistory", "MedsList", "WhoHeightChart", "WhoWeightChart", "WhoHcChart", "CdcHeightChart", "CdcWeightChart", "CdcBmiChart", "CompMedsList", "CdcHcChart" | DocumentReference | content[*].attachment.contentType | - | NA | TBD | ||
| attachments.entity_date | DateTime | Top Level | 0..1 | - | - | - | DocumentReference | content[].attachment.extension[].valueDateTime | - | NA | entity-date | TBD | |
| attachments.entity_description | String | Top Level | 0..1 | - | - | - | DocumentReference | content[].attachment.extension[].valueString | - | NA | entity-desc | TBD | |
| attachments.entity_id | Integer | Top Level | 0..1 | - | - | - | DocumentReference | content[].attachment.extension[].valueInteger | - | NA | entity-id | TBD | |
| attachments.entity_type | Integer | Top Level | 0..1 | - | - | - | DocumentReference | content[].attachment.extension[].valueInteger | - | NA | entity-type | TBD | |
| attachments.handout | String | Top Level | 0..1 | - | - | - | DocumentReference | content[].attachment.extension[].valueString | - | NA | handout | TBD | |
| attachments.id | Integer | Top Level | 0..1 | - | - | - | DocumentReference | content[*].attachment.id | - | NA | TBD | ||
| document_date | DateTime | Top Level | 0..1 | - | - | - | DocumentReference | date | - | NA | - | TBD | |
| id | Integer | Top Level | 0..1 | ID | - | - | DocumentReference | id | - | NA | TBD | ||
| patient | Integer | Top Level | 0..1 | - | - | - | DocumentReference | subject.reference | - | NA | TBD | ||
| practice | Integer | Top Level | 0..1 | - | - | - | DocumentReference | extension[*].valueReference.reference | - | NA | practice | TBD | |
| send_to_elation_user | Integer | Top Level | 0..1 | If a letter is sent to another elation user, this will be that user's id. | - | - | DocumentReference | extension[*].valueString | - | NA | send-to-elation-user | TBD | |
| sign_date | DateTime | Top Level | 0..1 | - | - | - | DocumentReference | extension[*].valueDateTime | - | NA | signed-date | TBD | |
| signed_by | String | Top Level | 0..1 | - | - | - | DocumentReference | extension[*].valueString | - | NA | signed-by | TBD | |
| tags | Object | Top Level | 0..* | - | - | - | DocumentReference | - | - | NA | TBD | ||
| send_to_contact | Object | Contained | 0..1 | - | - | - | Practitioner | - | resourceType == Pracitioner | NA | - | TBD | |
| send_to_contact.first_name | String | Contained | 0..1 | - | - | - | Practitioner | contained[*].name[1].given[1] | use=official | NA | - | TBD | |
| send_to_contact.id | Integer | Contained | 0..1 | - | - | - | Practitioner | contained[*].id | - | NA | - | TBD | |
| send_to_contact.last_name | String | Contained | 0..1 | - | - | - | Practitioner | contained[*].name[2].family | - | NA | - | TBD | |
| send_to_contact.npi | String | Contained | 0..1 | - | - | - | Practitioner | contained[].identifier[].value | - | NA | - | TBD | |
| send_to_contact.org_name | String | Contained | 0..1 | - | - | - | Practitioner | contained[*].extension.valueString | - | NA | org | TBD | |
| resolution | Object | Contained | 0..1 | - | - | - | Task | - | resourceType == Task | NA | - | TBD | |
| resolution.created_date | DateTime | Contained | 0..1 | The datetime when this resolution state was created. | - | - | Task | contained[].extension[].valueDateTime | - | NA | created-date | TBD | |
| resolution.deleted_date | DateTime | Contained | 0..1 | The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution. | - | - | Task | contained[].extension[].valueDateTime | - | NA | deleted-date | TBD | |
| resolution.document | Integer | Contained | 0..1 | Will be the same as the id of the lab order. | - | - | Task | contained[].extension[].valueInteger | - | NA | document | TBD | |
| resolution.id | Integer | Contained | 0..1 | Internal id to represent the resolution state. | - | - | Task | contained[*].id | - | NA | - | TBD | |
| resolution.note | String | Contained | 0..1 | Any note that was added to represent why an order was cancelled. | - | - | Task | contained[*}.note[1].text | - | NA | - | TBD | |
| resolution.resolving_document | Integer | Contained | 0..1 | If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report. | - | - | Task | contained[].extension[].valueInteger | - | NA | resolving-document | TBD | |
| resolution.state | String | Contained | 0..1 | The resolution state of the order. | - | outstanding, fulfilled, cancelled | Task | contained[].extension[].valueString | - | NA | state | TBD | |
| send_to_contact.specialties | Object | Contained | 0..* | - | - | - | PracitionerRole | - | resourceType == PracitionerRole | NA | - | TBD | |
| send_to_contact.specialties.id | Integer | Contained | 0..1 | - | - | - | PracitionerRole | contained[].contained[].id | - | NA | - | TBD | |
| send_to_contact.specialties.name | String | Contained | 0..1 | - | - | - | PracitionerRole | contained[].contained[].specialty[*].text | - | NA | - | TBD | |
| body | String | Contained | 0..1 | - | - | - | Communication | contained[].payload[].contentString | - | NA | - | TBD | |
| delivery_date | DateTime | Contained | 0..1 | - | - | - | Communication | contained[*].sent | - | NA | - | TBD | |
| delivery_method | String | Contained | 0..1 | - | - | "emr", "passport", "fax", "email", "printed", "direct" | Communication | contained[].medium[].coding[*].code | - | NA | - | TBD | |
| direct_message_to | String | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueString | - | NA | direct-message | TBD | |
| display_to | String | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueString | - | NA | display | TBD | |
| email_to | String | Contained | 0..1 | - | - | - | Communication | contained[].medium[].text | - | NA | - | TBD | |
| failure_unacknowledged | Boolean | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueBoolean | - | NA | failure-unacknoledged | TBD | |
| fax_attachments | Boolean | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueString | - | NA | fax-attachments | TBD | |
| fax_status | String | Contained | 0..1 | - | - | "pending","success","failed" | Communication | contained[].extension[].valueString | - | NA | fax-status | TBD | |
| fax_to | String | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueString | - | NA | fax | TBD | |
| is_processed | Boolean | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueBoolean | - | NA | processed | TBD | |
| letter_type | String | Contained | 0..1 | - | - | "patient_initiated","patient", "referral", "provider" | Communication | contained[].extension[].valueString | - | NA | letter-type | TBD | |
| send_to_name | String | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueString | - | NA | send-to-name | TBD | |
| subject | String | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueString | - | NA | subject | TBD | |
| to_number | String | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueInteger | - | NA | number | TBD | |
| viewed_at | DateTime | Contained | 0..1 | - | - | - | Communication | contained[*].received | - | NA | - | TBD | |
| with_archive | Boolean | Contained | 0..1 | - | - | - | Communication | contained[].extension[].valueBoolean | - | NA | archive | TBD |