Patient Case Document
Source Object: Patient Case Document
Overview and Usage: The "Patient Case Document" source object in the athena EHR system is designed to manage and maintain documents associated with specific patient cases. Developers can utilize this object to access and manipulate patient case documents. Key data fields include:
- Appointment ID: Identifies the appointment linked to the document, if applicable.
- Assigned To: Specifies the user or entity to whom the document is assigned.
- Clinical Provider ID: Identifies the clinical provider associated with the document.
- Created Date and Time: Records when the document was created.
- Deleted Date and Time: Tracks the date and time of document deletion, if applicable.
- Document Class: Categorizes the type or class of the document.
- Document Description: Provides a brief description of the document's content.
- Document Route: Specifies the document's routing information.
- Document Source: Indicates the source or origin of the document.
- Document Subclass: Further categorizes the document within its class.
- Document Type ID: Identifies the specific type or category of the document.
- Encounter ID: Links the document to a specific patient encounter.
- External Accession ID: Records an external identification for the document.
- External Note: Contains additional notes related to the external accession.
- Patient Case ID: Associates the document with a specific patient case.
- Internal Accession ID: Stores an internal identification for the document.
- Internal Note: Contains internal notes or comments related to the document.
- Last Modified Date and Time: Captures the date and time of the last modification.
- Observation Date and Time: Indicates when the document's observations or data were recorded.
- Patient ID: Links the document to a specific patient.
- Priority: Specifies the document's priority level.
- Provider ID: Identifies the healthcare provider associated with the document.
- Status: Indicates the current status of the document (e.g., draft, finalized).
- Subject: Provides a subject or title for the document.
- Tieto Order ID: Associates the document with a Tieto order.
- Created Documents: Records documents created within the context of the main document.
- Created User: Specifies the user who created the document.
- Facility ID: Identifies the healthcare facility where the document was created.
- Last Modified User: Specifies the user who last modified the document.
- Phone Message ID: Links the document to a specific phone message, if applicable.
- Auto Close: Indicates if the document is set to close automatically.
- Callback Name and Number: Records callback information associated with the document.
- Callback Number Type: Specifies the type of phone number for callbacks.
- Call Type: Indicates the type of call associated with the document.
- Action Note: Contains additional notes or comments related to actions taken on the document.
- Outbound Only: Specifies if the document is for outbound use only.
- Provider Username: Identifies the username of the provider related to the document.
- Tied to Procedure or Surgery: Indicates if the document is tied to a specific medical procedure or surgery.
- Username: Specifies the username associated with the document.
- Action Reason ID: Identifies the reason for specific actions taken on the document.
Developers can leverage the "Patient Case Document" source object to create applications that efficiently manage, retrieve, and organize patient case-related documents within the athena EHR system.
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 |
---|---|---|---|---|---|---|---|---|---|---|
appointmentid | - | The appointment ID for this document. | number | 0..1 | DocumentReference | context.related.reference | - | Top Level | ||
assignedto | - | Person the document is assigned to | string | 0..1 | DocumentReference | extension.valueString | assigned-to | Top Level | ||
clinicalproviderid | - | The clinical provider ID of the performing provider | number | 0..1 | DocumentReference | custodian.reference | Top Level | |||
createddatetime | - | Date/Time (ISO 8601) the document was created | string | 0..1 | DocumentReference | date | 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 | ||
documentclass | - | Class of document | string | 0..1 | DocumentReference | category.coding.code | Top Level | |||
description | - | 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 | ||
documentsource | - | Explains where this document originated (e.g. ENCOUNTER, PORTAL, etc.) | 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 | ||
documenttypeid | - | The ID of the description for this document | number | 0..1 | DocumentReference | extension.valueString | document-type-id | Top Level | ||
encounterid | - | Encounter ID | string | 0..1 | DocumentReference | context.encounter.reference | 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 | ||
patientcaseid | - | The patient case id | number | 0..1 | DocumentReference | id | 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 | ||
patientid | - | The athenaNet patient ID | number | 0..1 | DocumentReference | subject.reference | Top Level | |||
priority | - | Document priority, when available. | number | 0..1 | DocumentReference | extension.valueString | priority | Top Level | ||
providerid | - | Provider ID for this document | number | 0..1 | DocumentReference | author.reference | 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 | ||
tietoorderid | - | Order ID of the order this document is tied to, if any | number | 0..1 | DocumentReference | context.related.reference | Top Level | |||
createddocuments.documentclass | - | The document class. | string | 0..1 | DocumentReference | extension.valueCoding.display | Top Level | |||
createddocuments.documentid | - | The document id. | string | 0..1 | DocumentReference | extension.valueC | Top Level | |||
createduser | - | The user who created this document. | string | 0..1 | DocumentReference | extension.valueString | created-user | Top Level | ||
facilityid | - | The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies. | number | 0..1 | DocumentReference | custodian.reference | Top Level | |||
lastmodifieduser | - | The user who last modified this document. | string | 0..1 | DocumentReference | extension.valueString | last-modified-user | Top Level | ||
phonemessageid | - | The primary key for phone message documents | Integer | 0..1 | DocumentReference | extension.valueString | phone-message-id | Top Level | ||
autoclose | - | Documents will, normally, automatically appear in the clinical inbox for providers to review. In some cases, you might want to force the document to skip the clinical inbox, and go directly to the patient chart with a "closed" status. For that case, set this to true. | Boolean | 0..1 | DocumentReference | extension.valueBoolean | auto-close | Top Level | ||
callbackname | - | The person to call (if other than patient). | string | 0..1 | DocumentReference | extension.valueContactPoint.extension.valueString | call-back,call-back-name | Top Level | ||
callbacknumber | - | The phone number to use to call back the patient. | string | 0..1 | DocumentReference | extension.valueContactPoint.value | call-back | Top Level | ||
callbacknumbertype | - | The type of callback number (e.g. home, office, work, guarantor). | string | 0..1 | DocumentReference | extension.valueContactPoint.use | call-back | Top Level | ||
calltype | - | Type of call. (Options include: Tickler, Cancellation, ReminderCall etc...) | string | 0..1 | DocumentReference | extension.valueContactPoint.extension.valueString | call-back,call-type | Top Level | ||
actionnote | - | The most recent action note for a document | string | 0..1 | DocumentReference | extension.valueString | action-note | Top Level | ||
outboundonly | - | If the call made in the patient case is outbound | string | 0..1 | DocumentReference | extension.valueString | out-bound-only | Top Level | ||
providerusername | - | The username of the provider associated with this lab result document. | string | 0..1 | DocumentReference | author.display | Top Level | |||
tiedtoprocedureorsurgery | - | Link to retrieve the tied to surgery/procedure document. | string | 0..1 | DocumentReference | extension.valueString | tied-to-procedure-or-surgery | Top Level | ||
username | - | athenNet user to whom the case is being reassigned to.This parameter is case-sensitive. | string | 0..1 | DocumentReference | extension.valueString | user-name | Top Level | ||
actionreasonid | - | Valid Document Action Reason ID for closure of Patient Case. | Integer | 0..1 | DocumentReference | extension.valueString | action-reason-id | Top Level |