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 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 | |||
contraindicationreason.code | - | The code indicating why the order was contraindicated. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.code | contraindication-reason | Top Level | ||
contraindicationreason.codeset | - | The codeset that the code belongs to. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.system | Top Level | |||
contraindicationreason.description | - | The plaintext description of the contraindication reason. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.display | Top Level | |||
createddatetime | - | Date/Time (ISO 8601) the document was created. | string | 0..1 | DocumentReference | date | Top Level | |||
declinedreason.code | - | The code indicating why the order was contraindicated. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.code | declined-reason | Top Level | ||
declinedreason.codeset | - | The codeset that the code belongs to. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.system | Top Level | |||
declinedreason.description | - | The plaintext description of the contraindication reason. | string | 0..1 | DocumentReference | extension.valueCodeableConcept.display | Top Level | |||
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 | ||
documentclass | - | Class of document. | string | 0..1 | DocumentReference | category.coding.code | Top Level | |||
documentdescription | - | 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 | ||
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. | 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 | ||
appointmentrequestid | - | The primary key for appointmentrequest class of documents. | 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 | |||
receivernote | - | External note sent to the receiving facility. | string | 0..1 | DocumentReference | extension.valueString | receiver-note | 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 |