xCaliber healthCare Data Mesh

Medical Record

Source Object: Medical Record

Overview and Usage: The "Medical Record" source object in the athena EHR system is used for managing and storing a patient's medical records and documents. It is essential for maintaining a comprehensive patient history. Developers can utilize this object to access and update medical records. Key data fields include:

  • Appointment ID: Identifies the appointment associated with the medical record.
  • Assigned To: Specifies the entity or user assigned to the medical record.
  • Clinical Provider ID: Represents the ID of the clinical provider associated with the record.
  • Contraindication Reason (Code, Description, Code Set): Describes contraindication reasons related to the record.
  • Created Date and Time: Records the date and time when the medical record was created.
  • Declined Reason (Code, Description, Code Set): Indicates reasons for declining the record.
  • Declined Reason Text: Provides additional text information for declined records.
  • Deleted Date and Time: Specifies when the record was deleted, if applicable.
  • Department ID: Identifies the department associated with the record.
  • Document Class and Description: Classifies the type and description of the medical document.
  • Document Route, Source, Subclass, Type, and Type ID: Details of the document's routing, source, subclass, type, and type ID.
  • Encounter ID: Links the medical record to a specific patient encounter.
  • External Accession ID and Note: External identifiers and notes for the record.
  • Internal Accession ID and Note: Internal identifiers and notes for the record.
  • Last Modified Date and Time: Records the date and time of the last modification to the record.
  • Medical Record ID: A unique identifier for the medical record.
  • Observation Date and Time: Indicates the date and time of the observation recorded.
  • Patient ID: Identifies the patient associated with the record.
  • Priority: Specifies the priority level of the medical record.
  • Provider ID: Identifies the provider associated with the record.
  • Receive Note: Contains additional notes related to record receipt.
  • Status: Represents the status of the medical record.
  • Subject: Describes the subject of the medical record.
  • Tieto Order ID: Identifies the order associated with the record.
  • Document Data: Stores data related to the document.
  • Facility ID: Identifies the facility associated with the record.
  • Original Document (Content Type, HREF): Information about the original document, including content type and HREF.
  • Pages (Content Type, HREF, Page ID, Page Ordering): Details of individual pages within the document.

Developers can use the "Medical Record" source object to create applications for efficient management and retrieval of patient medical records, ensuring that healthcare providers have quick access to essential patient information.

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.referenceTop 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-List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.array0..1DocumentReferenceextension.valueCodeableConcept.codecontraindication-reasonTop Level
contraindicationreason.description-List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.array0..1DocumentReferenceextension.valueCodeableConcept.displayTop Level
contraindicationreason.codeset-List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.array0..1DocumentReferenceextension.valueCodeableConcept.systemTop Level
createddatetime-Date/Time (ISO 8601) the document was created.string0..1DocumentReferencedateTop Level
declinedreason.code-List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.array0..1DocumentReferenceextension.valueCodeableConcept.codedeclined-reasonTop Level
declinedreason.description-List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.array0..1DocumentReferenceextension.valueCodeableConcept.displaydeclined-reasonTop Level
declinedreason.codeset-List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.array0..1DocumentReferenceextension.valueCodeableConcept.systemdeclined-reasonTop 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
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
medicalrecordid-The primary key for medicalrecord class of documents.number0..1DocumentReferenceidTop 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
deleteddatetime-Date/time (ISO 8601) the document was deleted.string0..1DocumentReferenceextension.valueDateTimedeleted-datetimeTop Level
documentdata-Text data associated with this document.string0..1DocumentReferenceextension.valueStringdocument-dataTop 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
originaldocument.contenttype-The content-type of the original document.string0..1DocumentReferencecontent.attachment.contentTypeTop Level
originaldocument.href-The URL to get the original document.string0..1DocumentReferencecontent.attachment.urlTop 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.valueStringpage-orderingTop Level