Order Document
Source Object: Order Document
Overview and Usage: The "Order Document" source object within the athena EHR system is used to manage and record various medical orders and related documentation. Developers can interact with this object to retrieve, modify, or track patient orders and their associated data. Key data fields include:
- Action Note: Contains notes related to the order.
- Alarm Days: Specifies the number of days for an alarm or reminder associated with the order.
- Appointment ID: Identifies the related patient appointment.
- Approved Date: Indicates the date the order was approved.
- Assigned To: Represents the user or entity assigned to handle the order.
- Attachments (Document Class, Description, Document ID): Provides information about attached documents related to the order.
- CC List (Address, City, Fax, Name, Phone, State, Zip): Lists addresses of individuals or entities who received a copy of the order.
- Clinical Provider (ID, Name): Identifies the clinical provider responsible for the order.
- Created Date and User: Records the date and user who created the order document.
- Date of Service: Specifies the date of service or the date the order is associated with.
- Declined Reason (Code, Description, Code Set): Contains details regarding why an order was declined.
- Department ID: Identifies the department associated with the order.
- Diagnosis List (Diagnosis Code, Code Set, Description): Provides information about the diagnosis associated with the order.
- Document Description, Route, Source, Subclass, Type, Type ID: Describe attributes of the order document.
- Encounter ID: Identifies the patient encounter linked to the order.
- External Accession ID: Records an external identifier for the order document.
- Facility ID: Identifies the facility where the order was created.
- Facility Order Code (Code, Description): Represents a facility-specific code for the order.
- Insurances (Additional Information, Authorization, Effective Dates, Insurance Package ID, Member ID, Name, Patient Insurance ID, Sequence, Visits Approved): Contains insurance-related details.
- Internal Accession ID: Records an internal identifier for the order document.
- Last Modified Date and User: Records the date and user who last modified the order.
- Observation Date and Time: Specifies the date and time of observation related to the order.
- Order ID: Uniquely identifies the order.
- Order Type: Indicates the type or category of the order.
- Out-of-Network Referral Reason ID: Specifies the reason for an out-of-network referral.
- Pages (Content Type, HREF, Page ID, Page Ordering): Contains details about attached pages related to the order.
- Patient Case ID: Identifies the case or patient associated with the order.
- Perform Date: Indicates the date when the order is to be performed.
- Place of Service (ID): Specifies the place or location where the order is to be carried out.
- Pre-scheduling Checklist (Notes, Status, Task): Records checklist items related to the order.
- Priority: Specifies the priority level or urgency of the order.
- Procedure Codes: Contains details about procedures associated with the order.
- Provider ID: Identifies the healthcare provider who issued the order.
- Questions (Answer, Question): Provides answers to specific questions or queries related to the order.
- Receive Note: Contains notes or information related to receiving the order.
- Referral Attachments (Document Class, Description, Document ID, Encounter ID, Flowsheet ID, Section Name, Section Name Key): Contains attached referral documents.
- Requested Visits: Specifies the requested visits or appointments associated with the order.
- Schedule Within: Indicates the timeframe within which the order should be scheduled.
- Specimen Collected By: Specifies the entity responsible for specimen collection.
- Specimen Collection Date and Time: Records the date and time of specimen collection.
- Specimen Notes: Contains notes or details related to specimen collection.
- Specimen Source ID and Name: Identifies the source or origin of the specimen.
- Standing Order (Duration Days, Frequency Days, Start Date): Specifies the details of standing orders.
- Status: Represents the current status of the order.
- Subject: Provides a subject or description of the order.
- Submitter: Specifies the entity or user who submitted the order.
- Summary Care Document ID: Identifies a related summary care document.
- Tied to Documents (Document Class, Document ID, Subclass): Links to other documents or records.
- Tieto Order ID: Represents the order's identifier in the Tieto system.
- Document Class, Date, Patient ID: Additional details related to the order document.
- Specimen Draw Location: Specifies the location where specimens were drawn for the order.
Developers can utilize the "Order Document" source object to manage and access various order-related information, ensuring accurate and efficient healthcare order management.
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 | ||
alarmdays | - | The number days until a document will go into followup after being sent to the portal. | string | 0..1 | DocumentReference | extension.valueString | alarm-days | Top Level | ||
appointmentid | - | The appointment ID for this document | integer | 0..1 | DocumentReference | extension.valueString | appointment-id | Top Level | ||
approveddate | - | The date this document was approved | string | 0..1 | DocumentReference | extension.valueString | approved-date | Top Level | ||
assignedto | - | Person the document is assigned to | string | 0..1 | DocumentReference | extension.valueString | assigned-to | Top Level | ||
attachments.documentclass | - | Class of the attached document. | string | 0..1 | DocumentReference | contained.category.coding.code | Contained | |||
attachments.documentdescription | - | A description of the attached document | string | 0..1 | DocumentReference | contained.description | Contained | |||
attachments.documentid | - | ID of the attached document. | integer | 0..1 | DocumentReference | contained.id | Contained | |||
attachments.encounterid | - | ID of the attached encounter or order group | integer | 0..1 | DocumentReference | contained.context.encounter.reference | Contained | |||
attachments.flowsheetid | - | ID of the attached flowsheet | integer | 0..1 | DocumentReference | contained.extension.valueString | flow-sheet-id | Contained | ||
attachments.sectionname | - | Section name for the attached document. | string | 0..1 | DocumentReference | contained.extension.valueString | section-name | Contained | ||
attachments.sectionnamekey | - | Key name of the section of the attached document. | string | 0..1 | DocumentReference | contained.extension.valueString | section-name-key | Contained | ||
cclist.address | - | The address of this clinical provider. | string | 0..1 | Location | contained.address.line[0] | Contained | |||
cclist.city | - | The city of this clinical provider. | string | 0..1 | Location | contained.address.city | Contained | |||
cclist.fax | - | The fax number of this clinical provider. | string | 0..1 | Location | contained.address | Contained | |||
cclist.name | - | The name of this clinical provider. | string | 0..1 | Location | contained.name | Contained | |||
cclist.phone | - | The phone number of this clinical provider. | string | 0..1 | Location | contained.telecom.value | system=phone | Contained | ||
cclist.state | - | The state of this clinical provider. | string | 0..1 | Location | contained.address.state | Contained | |||
cclist.zip | - | The zipcode of this clinical provider. | string | 0..1 | Location | contained.address.postalCode | Contained | |||
clinicalproviderid | - | 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. | integer | 0..1 | DocumentReference | custodian.reference.code | Top Level | |||
clinicalprovidername | - | The Name 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. | string | 0..1 | DocumentReference | custodian.reference.display | Top Level | |||
createddatetime | - | Date/Time (ISO 8601) the document was created | string | 0..1 | DocumentReference | date | Top Level | |||
createduser | - | The user who created this document. | string | 0..1 | DocumentReference | extension.valueString | created-user | Top Level | ||
dateofservice | - | Date of service for this order. | string | 0..1 | DocumentReference | extension.valueDate | date-of-service | Top Level | ||
declinedreason.code | - | The code indicating why the order was not given. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.code | declined-reason | Top Level | ||
declinedreason.description | - | The codeset that the code belongs to. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.display | ||||
declinedreason.codeset | - | The plaintext description of the reason the order was not given. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.system | ||||
declinedreasontext | - | The user-facing description of the reason the order was not given. | string | 0..1 | DocumentReference | extension.valueString | declined-reason-text | 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 | ||
diagnosislist.diagnosiscode.code | - | Diagnoses for this document | string | 0..1 | serviceRequest | reasonCode.coding.code | Contained | |||
diagnosislist.diagnosiscode.codeset | - | string | 0..1 | serviceRequest | reasonCode.coding.display | Contained | ||||
diagnosislist.diagnosiscode.description | - | string | 0..1 | serviceRequest | reasonCode.coding.system | Contained | ||||
diagnosislist.snomedicdcodes.code | - | Diagnoses for this document | string | 0..1 | serviceRequest | reasonCode.coding.code | Contained | |||
diagnosislist.snomedicdcodes.codeset | - | string | 0..1 | serviceRequest | reasonCode.coding.display | Contained | ||||
diagnosislist.snomedicdcodes.description | - | string | 0..1 | serviceRequest | reasonCode.coding.system | Contained | ||||
diagnosislist.snomedicdcodes.unstrippeddiagnosiscode | - | string | 0..1 | serviceRequest | reasonCode.coding.extension.valueString | unstripped-diagnosis-code | Contained | |||
documentdescription | - | Description of the document type | string | 0..1 | DocumentReference | category.coding.display | 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. | 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 | ||
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 | integer | 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 | ||
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. | integer | 0..1 | DocumentReference | custodian.reference | Top Level | |||
facilityordercode.code | - | The code in the facility specific vocabulary. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.code | facility-order | Top Level | ||
facilityordercode.description | - | When available, a description of the code from the facility specific vocabulary. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.display | Top Level | |||
hassummarycare | - | If true, document has a summary care record. | string | 0..1 | DocumentReference | extension.valueString | has-summary-care | Top Level | ||
insurances.additionalinformation | - | Additional information note. | string | 0..1 | Coverage | extension.valueString | additional-information | Contained | ||
insurances.authorizationnumber | - | Authorization number. | string | 0..1 | Coverage | identifier.value | Contained | |||
insurances.authorizationstatus | - | The authorization status for this insurance. | string | 0..1 | Coverage | extension.valueString | authorization-status | Contained | ||
insurances.effectiveenddate | - | Effective end date. | string | 0..1 | Coverage | period | Contained | |||
insurances.effectivestartdate | - | Effective start date. | string | 0..1 | Coverage | period | Contained | |||
insurances.insurancepackageid | - | Insurance package id. | string | 0..1 | Coverage | identifier.value | Contained | |||
insurances.memberid | - | Member id. | string | 0..1 | Coverage | extension.valueString | member-id | Contained | ||
insurances.name | - | Name of the insurance. | string | 0..1 | Coverage | class.name | Contained | |||
insurances.patientinsuranceid | - | Patient insurance id. | string | 0..1 | Coverage | contaned.id | Contained | |||
insurances.sequence | - | Number indicating insurance sequence: 1 - Primary, 2 - Secondary, 3 - Tertiary, 4 - Quaternary. | integer | 0..1 | Coverage | extension.valueInteger | sequence | Contained | ||
insurances.visitsapproved | - | The number of visits approved. | integer | 0..1 | Coverage | extension.valueString | visits-approved | Contained | ||
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 | ||
lastmodifieduser | - | The user who last modified this document. | string | 0..1 | DocumentReference | extension.valueString | last-modified-user | Top Level | ||
observationdatetime | - | Date/time (ISO 8601) the observation was taken | string | 0..1 | DocumentReference | extension.valueDateTime | observation-datetime | Top Level | ||
orderid | - | Order document id | integer | 0..1 | DocumentReference | id | Top Level | |||
ordertype | - | Order type group name | string | 0..1 | DocumentReference | extension.valueString | order-type | Top Level | ||
outofnetworkreferralreasonid | - | ID of the out of network referral reason. | integer | 0..1 | DocumentReference | extension.valueString | out-of-network-referral-reason-id | 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 | Top Level | |||
patientcaseid | - | The patient case id | string | 0..1 | DocumentReference | extension.valueString | patient-case-id | Top Level | ||
performdate | - | Date the order was performed. | string | 0..1 | DocumentReference | extension.valueDate | perform-date | Top Level | ||
placeofservice | - | CMS Place of Service name. | string | 0..1 | DocumentReference | context.facilityType.coding.display | Top Level | |||
placeofserviceid | - | CMS Place of Service code. | string | 0..1 | DocumentReference | context.facilityType.coding.code | Top Level | |||
preschedulingchecklist.notes | - | Checklist note. | string | 0..1 | Task | note.text | Contained | |||
preschedulingchecklist.status | - | Checklist status: INCOMPLETE, COMPLETE, N/A | string | 0..1 | Task | status | Contained | |||
preschedulingchecklist.task | - | Checklist task name | string | 0..1 | Task | description | Contained | |||
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 | ||
procedurecodes | - | CPT codes associated with this order. | string | 0..1 | serviceRequest | code.coding.code | Top Level | |||
providerid | - | Provider ID for this document | integer | 0..1 | DocumentReference | author.reference | Top Level | |||
questions.answer | - | BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice. | string | 0..1 | QuestionnaireResponse | item.text | Contained | |||
questions.question | - | BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice. | string | 0..1 | QuestionnaireResponse | item.answer.valueString | Contained | |||
receivernote | - | The external note sent to the receiving facility | string | 0..1 | DocumentReference | extension.valueString | receiver-note | Top Level | ||
referralattachments.documentclass | - | Class of the attached document. | string | 0..1 | DocumentReference | contained.category.coding.code | Top Level | |||
referralattachments.documentdescription | - | A description of the attached document | string | 0..1 | DocumentReference | contained.description | Contained | |||
referralattachments.documentid | - | ID of the attached document. | integer | 0..1 | DocumentReference | contained.id | Contained | |||
referralattachments.encounterid | - | ID of the attached encounter or order group | integer | 0..1 | DocumentReference | contained.context.encounter.reference | Contained | |||
referralattachments.flowsheetid | - | ID of the attached flowsheet | integer | 0..1 | DocumentReference | contained.extension.valueString | flow-sheet-id | Contained | ||
referralattachments.sectionname | - | Section name for the attached document. | string | 0..1 | DocumentReference | contained.extension.valueString | section-name | Contained | ||
referralattachments.sectionnamekey | - | Key name of the section of the attached document. | string | 0..1 | DocumentReference | contained.extension.valueString | section-name-key | Contained | ||
requestedvisits | - | The number of requested visits. | integer | 0..1 | DocumentReference | extension.valueInteger | requested-visits | Top Level | ||
schedulewithin | - | Timerange in which to schedule a referral order | string | 0..1 | DocumentReference | extension.valueString | schedule-within | Top Level | ||
specimencollectedby | - | The username of the individual who took the specimen | string | 0..1 | Specimen | collection.extension.valueString | specimen-collected-by | Contained | ||
specimencollectiondatetime | - | Date/time (ISO 8601) of the specimen collection | string | 0..1 | Specimen | collection.collected.collectedDateTime | Contained | |||
specimencollectionsite | - | Options are ExternalLab, Office, Home, AddOn | string | 0..1 | Specimen | collection.extension.valueString | specimen-collection-site | Contained | ||
specimennotes | - | Note included with the specimen | string | 0..1 | Specimen | collection.note | Contained | |||
specimensourceid | - | The internal ID of the site (on the patient) where the specimen was taken. Deprecated. Use SPECIMENSOURCENAME | integer | 0..1 | Specimen | collection.bodySite.coding.code | Contained | |||
specimensourcename | - | The site (on the patient) where the specimen was taken | string | 0..1 | Specimen | collection.bodySite.coding.display | Contained | |||
standingorderdurationdays | - | Duration of the standing order | integer | 0..1 | DocumentReference | extension.valueString | standing-order-duration-days | Top Level | ||
standingorderfrequencydays | - | Frequency at which the order repeats | integer | 0..1 | DocumentReference | extension.valueString | standing-order-frequency-days | Top Level | ||
standingorderstartdate | - | Start date of the standing order | string | 0..1 | DocumentReference | extension.valueString | standing-order-start-date | 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 | ||
submitter | - | Submitter of a document. | string | 0..1 | DocumentReference | extension.valueString | submitter | Top Level | ||
summarycaredocumentid | - | ID of the summary care document. | integer | 0..1 | DocumentReference | extension.valueString | summary-care-document-id | Top Level | ||
tiedtodocuments.documentclass | - | The document class. | string | 0..1 | DocumentReference | context.related.display | Top Level | |||
tiedtodocuments.documentid | - | The document id. | integer | 0..1 | DocumentReference | context.related.reference | Top Level | |||
tiedtodocuments.documentsubclass | - | The document subclass. | string | 0..1 | DocumentReference | context.related.extension | Top Level | |||
tietoorderid | - | Order ID of the order this document is tied to, if any | integer | 0..1 | DocumentReference | context.related.reference | Top Level | |||
documentclass | - | Class of document | string | 0..1 | DocumentReference | category.coding.code | Top Level | |||
documentdate | - | Date/time the observation was taken | string | 0..1 | DocumentReference | extension.valueString | document-date | Top Level | ||
patientid | - | The athenaNet patient ID. | integer | 0..1 | DocumentReference | subject.reference | Top Level | |||
specimendrawlocation | - | Options are ExternalLab, Office, Home, AddOn | string | 0..1 | Specimen | extension.valueString | Contained |