xCaliber healthCare Data Mesh

Appointment Request Document

Source Object: Appointment Request Document

Overview and Usage: The "Appointment Request Document" source object in athena EHR plays a crucial role in managing and documenting appointment requests. It provides a structured approach to handle appointment-related information, ensuring efficient communication and coordination of healthcare appointments.

  • Appointment Management: The "Appointment Request Document" serves as a repository for managing appointment requests. It captures essential details related to appointments, including appointment ID, provider information, and request status.
  • Provider Assignment: The "assignedto" and "clinicalproviderid" fields specify the provider to whom the appointment request is assigned, streamlining provider-patient communication.
  • Contraindication Reason: "contraindicationreason.code," "contraindicationreason.codeset," and "contraindicationreason.description" record reasons for contraindications to the appointment request, helping providers make informed decisions.
  • Creation and Modification: "createddatetime" and "lastmodifieddatetime" track the creation and last modification of the appointment request document, aiding in version control.
  • Declined Appointments: "declinedreason.code," "declinedreason.codeset," "declinedreason.description," and "declinedreasontext" record reasons for appointment declines, improving appointment management.
  • Document Categorization: Fields such as "documentclass," "documentroute," "documentsubclass," and "documenttype" allow for categorizing appointment request documents, enabling systematic organization.
  • Encounter Information: "encounterid" associates the appointment request with a specific encounter or healthcare event, enhancing context and coordination.
  • External and Internal Accession IDs: "externalaccessionid" and "internalaccessionid" enable document access from external systems and within athena EHR, ensuring secure retrieval.
  • Observation Date and Time: "observationdatetime" captures the date and time of observations related to the appointment request, providing valuable context.
  • Patient ID: "patientid" links the appointment request to a specific patient's record, making patient-centered care easier.
  • Priority Management: The "priority" field specifies the priority level of the appointment request, helping healthcare providers prioritize and schedule appointments effectively.
  • Provider ID: "providerid" identifies the healthcare provider involved in the appointment request.
  • Receive Note: "receivernote" allows for adding notes related to the receipt of the appointment request, enhancing communication and coordination.
  • Request Status: "status" specifies the current status of the appointment request (e.g., pending, accepted, declined), aiding in appointment management.
  • Subject and Document Description: "subject" and "documentdescription" provide brief descriptions of the appointment request content, aiding in document identification and organization.
  • Tieto Order ID: "tietoorderid" links the document to specific orders or processes within the system, enhancing order-document coordination.

The "Appointment Request Document" source object ensures efficient communication, coordination, and documentation of healthcare appointments. It facilitates the systematic recording of appointment-related data, aiding in the scheduling and management of patient appointments within athena EHR. Developers can leverage this source object to build features and applications that support the management of appointment requests and streamline the appointment scheduling process.

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
appointmentid-The appointment ID for this document.number0..1DocumentReferencecontext.related.reference-Top Level
assignedto-Person the document is assigned to.string0..1DocumentReferenceextension.valueStringassigned-toTop Level
clinicalproviderid-The clinical provider ID of the performing provider.number0..1DocumentReferencecustodian.referenceTop Level
contraindicationreason.code-The code indicating why the order was contraindicated.string0..1DocumentReferenceextension.valueCodeableConcept.codecontraindication-reasonTop Level
contraindicationreason.codeset-The codeset that the code belongs to.string0..1DocumentReferenceextension.valueCodeableConcept.systemTop Level
contraindicationreason.description-The plaintext description of the contraindication reason.string0..1DocumentReferenceextension.valueCodeableConcept.displayTop Level
createddatetime-Date/Time (ISO 8601) the document was created.string0..1DocumentReferencedateTop Level
declinedreason.code-The code indicating why the order was contraindicated.string0..1DocumentReferenceextension.valueCodeableConcept.codedeclined-reasonTop Level
declinedreason.codeset-The codeset that the code belongs to.string0..1DocumentReferenceextension.valueCodeableConcept.systemTop Level
declinedreason.description-The plaintext description of the contraindication reason.string0..1DocumentReferenceextension.valueCodeableConcept.displayTop Level
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 deleted.string0..1DocumentReferenceextension.valueDateTimedeleted-datetimeTop Level
departmentid-Department for the document.string0..1DocumentReferenceextension.valueStringdepartment-idTop Level
documentclass-Class of document.string0..1DocumentReferencecategory.coding.codeTop Level
documentdescription-Description of the document type.string0..1DocumentReferencedescriptionTop 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 (e.g. ENCOUNTER, PORTAL, etc.).string0..1DocumentReferenceextension.valueStringdocument-sourceTop Level
documentsubclass-Specific type of document.string0..1DocumentReferencecategory.extension.valueStringdocument-subclassTop Level
documenttype-The description for this document.string0..1DocumentReferenceextension.valueStringdocument-typeTop Level
documenttypeid-The ID of the description for this document.number0..1DocumentReferenceextension.valueStringdocument-type-idTop Level
encounterid-Encounter ID.string0..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
appointmentrequestid-The primary key for appointmentrequest class of documents.number0..1DocumentReferenceidTop Level
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 document.string0..1DocumentReferenceextension.valueStringinternal-noteTop Level
lastmodifieddatetime-Date/time (ISO 8601) the document was last modified.string0..1DocumentReferenceextension.valueDateTimelast-modified-datetimeTop Level
observationdatetime-Date/time (ISO 8601) the observation was taken.string0..1DocumentReferenceextension.valueDateTimeobservation-datetimeTop Level
patientid-The athenaNet patient ID.number0..1DocumentReferencesubject.referenceTop Level
priority-Document priority, when available.number0..1DocumentReferenceextension.valueStringpriorityTop Level
providerid-Provider ID for this document.number0..1DocumentReferenceauthor.referenceTop Level
receivernote-External note sent to the receiving facility.string0..1DocumentReferenceextension.valueStringreceiver-noteTop Level
status-Status of the document.string0..1DocumentReferencestatusTop Level
subject-Subject of the document.string0..1DocumentReferenceextension.valueStringsubjectTop Level
tietoorderid-Order ID of the order this document is tied to, if any.number0..1DocumentReferencecontext.related.referenceTop Level