xCaliber healthCare Data Mesh

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 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 documentstring0..1DocumentReferenceextension.valueStringaction-noteTop Level
alarmdays-The number days until a document will go into followup after being sent to the portal.string0..1DocumentReferenceextension.valueStringalarm-daysTop Level
appointmentid-The appointment ID for this documentinteger0..1DocumentReferenceextension.valueStringappointment-idTop Level
approveddate-The date this document was approvedstring0..1DocumentReferenceextension.valueStringapproved-dateTop Level
assignedto-Person the document is assigned tostring0..1DocumentReferenceextension.valueStringassigned-toTop Level
attachments.documentclass-Class of the attached document.string0..1DocumentReferencecontained.category.coding.codeContained
attachments.documentdescription-A description of the attached documentstring0..1DocumentReferencecontained.descriptionContained
attachments.documentid-ID of the attached document.integer0..1DocumentReferencecontained.idContained
attachments.encounterid-ID of the attached encounter or order groupinteger0..1DocumentReferencecontained.context.encounter.referenceContained
attachments.flowsheetid-ID of the attached flowsheetinteger0..1DocumentReferencecontained.extension.valueStringflow-sheet-idContained
attachments.sectionname-Section name for the attached document.string0..1DocumentReferencecontained.extension.valueStringsection-nameContained
attachments.sectionnamekey-Key name of the section of the attached document.string0..1DocumentReferencecontained.extension.valueStringsection-name-keyContained
cclist.address-The address of this clinical provider.string0..1Locationcontained.address.line[0]Contained
cclist.city-The city of this clinical provider.string0..1Locationcontained.address.cityContained
cclist.fax-The fax number of this clinical provider.string0..1Locationcontained.addressContained
cclist.name-The name of this clinical provider.string0..1Locationcontained.nameContained
cclist.phone-The phone number of this clinical provider.string0..1Locationcontained.telecom.valuesystem=phoneContained
cclist.state-The state of this clinical provider.string0..1Locationcontained.address.stateContained
cclist.zip-The zipcode of this clinical provider.string0..1Locationcontained.address.postalCodeContained
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.integer0..1DocumentReferencecustodian.reference.codeTop 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.string0..1DocumentReferencecustodian.reference.displayTop Level
createddatetime-Date/Time (ISO 8601) the document was createdstring0..1DocumentReferencedateTop Level
createduser-The user who created this document.string0..1DocumentReferenceextension.valueStringcreated-userTop Level
dateofservice-Date of service for this order.string0..1DocumentReferenceextension.valueDatedate-of-serviceTop Level
declinedreason.code-The code indicating why the order was not given.string0..1DocumentReferenceextension.valueCodeableConcept.codedeclined-reasonTop Level
declinedreason.description-The codeset that the code belongs to.string0..1DocumentReferenceextension.valueCodeableConcept.display
declinedreason.codeset-The plaintext description of the reason the order was not given.string0..1DocumentReferenceextension.valueCodeableConcept.system
declinedreasontext-The user-facing description of the reason the order was not given.string0..1DocumentReferenceextension.valueStringdeclined-reason-textTop Level
deleteddatetime-Date/time (ISO 8601) the document was deletedstring0..1DocumentReferenceextension.valueDateTimedeleted-datetimeTop Level
departmentid-Department for the documentstring0..1DocumentReferenceextension.valueStringdepartment-idTop Level
diagnosislist.diagnosiscode.code-Diagnoses for this documentstring0..1serviceRequestreasonCode.coding.codeContained
diagnosislist.diagnosiscode.codeset-string0..1serviceRequestreasonCode.coding.displayContained
diagnosislist.diagnosiscode.description-string0..1serviceRequestreasonCode.coding.systemContained
diagnosislist.snomedicdcodes.code-Diagnoses for this documentstring0..1serviceRequestreasonCode.coding.codeContained
diagnosislist.snomedicdcodes.codeset-string0..1serviceRequestreasonCode.coding.displayContained
diagnosislist.snomedicdcodes.description-string0..1serviceRequestreasonCode.coding.systemContained
diagnosislist.snomedicdcodes.unstrippeddiagnosiscode-string0..1serviceRequestreasonCode.coding.extension.valueStringunstripped-diagnosis-codeContained
documentdescription-Description of the document typestring0..1DocumentReferencecategory.coding.displayTop Level
documentroute-Explains method by which the document was entered into the athenaNet (INTERFACE (digital), FAX, etc.)string0..1DocumentReferenceextension.valueStringdocument-routeTop Level
documentsource-Explains where this document originated.string0..1DocumentReferenceextension.valueStringdocument-sourceTop Level
documentsubclass-Specific type of documentstring0..1DocumentReferencecategory.extension.valueStringdocument-subclassTop Level
documenttype-The description for this documentstring0..1DocumentReferenceextension.valueStringdocument-typeTop Level
documenttypeid-The ID of the description for this documentinteger0..1DocumentReferenceextension.valueStringdocument-type-idTop Level
encounterid-Encounter IDstring0..1DocumentReferencecontext.encounter.referenceTop 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
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.integer0..1DocumentReferencecustodian.referenceTop Level
facilityordercode.code-The code in the facility specific vocabulary.string0..1DocumentReferenceextension.valueCodeableConcept.codefacility-orderTop Level
facilityordercode.description-When available, a description of the code from the facility specific vocabulary.string0..1DocumentReferenceextension.valueCodeableConcept.displayTop Level
hassummarycare-If true, document has a summary care record.string0..1DocumentReferenceextension.valueStringhas-summary-careTop Level
insurances.additionalinformation-Additional information note.string0..1Coverageextension.valueStringadditional-informationContained
insurances.authorizationnumber-Authorization number.string0..1Coverageidentifier.valueContained
insurances.authorizationstatus-The authorization status for this insurance.string0..1Coverageextension.valueStringauthorization-statusContained
insurances.effectiveenddate-Effective end date.string0..1CoverageperiodContained
insurances.effectivestartdate-Effective start date.string0..1CoverageperiodContained
insurances.insurancepackageid-Insurance package id.string0..1Coverageidentifier.valueContained
insurances.memberid-Member id.string0..1Coverageextension.valueStringmember-idContained
insurances.name-Name of the insurance.string0..1Coverageclass.nameContained
insurances.patientinsuranceid-Patient insurance id.string0..1Coveragecontaned.idContained
insurances.sequence-Number indicating insurance sequence: 1 - Primary, 2 - Secondary, 3 - Tertiary, 4 - Quaternary.integer0..1Coverageextension.valueIntegersequenceContained
insurances.visitsapproved-The number of visits approved.integer0..1Coverageextension.valueStringvisits-approvedContained
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 documentstring0..1DocumentReferenceextension.valueStringinternal-noteTop Level
lastmodifieddatetime-Date/time (ISO 8601) the document was last modifiedstring0..1DocumentReferenceextension.valueDateTimelast-modified-datetimeTop Level
lastmodifieduser-The user who last modified this document.string0..1DocumentReferenceextension.valueStringlast-modified-userTop Level
observationdatetime-Date/time (ISO 8601) the observation was takenstring0..1DocumentReferenceextension.valueDateTimeobservation-datetimeTop Level
orderid-Order document idinteger0..1DocumentReferenceidTop Level
ordertype-Order type group namestring0..1DocumentReferenceextension.valueStringorder-typeTop Level
outofnetworkreferralreasonid-ID of the out of network referral reason.integer0..1DocumentReferenceextension.valueStringout-of-network-referral-reason-idTop 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.valueStringTop Level
patientcaseid-The patient case idstring0..1DocumentReferenceextension.valueStringpatient-case-idTop Level
performdate-Date the order was performed.string0..1DocumentReferenceextension.valueDateperform-dateTop Level
placeofservice-CMS Place of Service name.string0..1DocumentReferencecontext.facilityType.coding.displayTop Level
placeofserviceid-CMS Place of Service code.string0..1DocumentReferencecontext.facilityType.coding.codeTop Level
preschedulingchecklist.notes-Checklist note.string0..1Tasknote.textContained
preschedulingchecklist.status-Checklist status: INCOMPLETE, COMPLETE, N/Astring0..1TaskstatusContained
preschedulingchecklist.task-Checklist task namestring0..1TaskdescriptionContained
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
procedurecodes-CPT codes associated with this order.string0..1serviceRequestcode.coding.codeTop Level
providerid-Provider ID for this documentinteger0..1DocumentReferenceauthor.referenceTop Level
questions.answer-BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice.string0..1QuestionnaireResponseitem.textContained
questions.question-BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice.string0..1QuestionnaireResponseitem.answer.valueStringContained
receivernote-The external note sent to the receiving facilitystring0..1DocumentReferenceextension.valueStringreceiver-noteTop Level
referralattachments.documentclass-Class of the attached document.string0..1DocumentReferencecontained.category.coding.codeTop Level
referralattachments.documentdescription-A description of the attached documentstring0..1DocumentReferencecontained.descriptionContained
referralattachments.documentid-ID of the attached document.integer0..1DocumentReferencecontained.idContained
referralattachments.encounterid-ID of the attached encounter or order groupinteger0..1DocumentReferencecontained.context.encounter.referenceContained
referralattachments.flowsheetid-ID of the attached flowsheetinteger0..1DocumentReferencecontained.extension.valueStringflow-sheet-idContained
referralattachments.sectionname-Section name for the attached document.string0..1DocumentReferencecontained.extension.valueStringsection-nameContained
referralattachments.sectionnamekey-Key name of the section of the attached document.string0..1DocumentReferencecontained.extension.valueStringsection-name-keyContained
requestedvisits-The number of requested visits.integer0..1DocumentReferenceextension.valueIntegerrequested-visitsTop Level
schedulewithin-Timerange in which to schedule a referral orderstring0..1DocumentReferenceextension.valueStringschedule-withinTop Level
specimencollectedby-The username of the individual who took the specimenstring0..1Specimencollection.extension.valueStringspecimen-collected-byContained
specimencollectiondatetime-Date/time (ISO 8601) of the specimen collectionstring0..1Specimencollection.collected.collectedDateTimeContained
specimencollectionsite-Options are ExternalLab, Office, Home, AddOnstring0..1Specimencollection.extension.valueStringspecimen-collection-siteContained
specimennotes-Note included with the specimenstring0..1Specimencollection.noteContained
specimensourceid-The internal ID of the site (on the patient) where the specimen was taken. Deprecated. Use SPECIMENSOURCENAMEinteger0..1Specimencollection.bodySite.coding.codeContained
specimensourcename-The site (on the patient) where the specimen was takenstring0..1Specimencollection.bodySite.coding.displayContained
standingorderdurationdays-Duration of the standing orderinteger0..1DocumentReferenceextension.valueStringstanding-order-duration-daysTop Level
standingorderfrequencydays-Frequency at which the order repeatsinteger0..1DocumentReferenceextension.valueStringstanding-order-frequency-daysTop Level
standingorderstartdate-Start date of the standing orderstring0..1DocumentReferenceextension.valueStringstanding-order-start-dateTop Level
status-Status of the documentstring0..1DocumentReferencestatusTop Level
subject-Subject of the documentstring0..1DocumentReferenceextension.valueStringsubjectTop Level
submitter-Submitter of a document.string0..1DocumentReferenceextension.valueStringsubmitterTop Level
summarycaredocumentid-ID of the summary care document.integer0..1DocumentReferenceextension.valueStringsummary-care-document-idTop Level
tiedtodocuments.documentclass-The document class.string0..1DocumentReferencecontext.related.displayTop Level
tiedtodocuments.documentid-The document id.integer0..1DocumentReferencecontext.related.referenceTop Level
tiedtodocuments.documentsubclass-The document subclass.string0..1DocumentReferencecontext.related.extensionTop Level
tietoorderid-Order ID of the order this document is tied to, if anyinteger0..1DocumentReferencecontext.related.referenceTop Level
documentclass-Class of documentstring0..1DocumentReferencecategory.coding.codeTop Level
documentdate-Date/time the observation was takenstring0..1DocumentReferenceextension.valueStringdocument-dateTop Level
patientid-The athenaNet patient ID.integer0..1DocumentReferencesubject.referenceTop Level
specimendrawlocation-Options are ExternalLab, Office, Home, AddOnstring0..1Specimenextension.valueStringContained