EQUICARE CS and APP provide the ability to export patient data into a file which can be saved locally and opened with a word processor. The export can be done for one patient at a time, or for a patient population. Each patient is exported into a separate file. The below information details the formatting of the data in the file, the data types, and the categories and fields of data that can be exported.
JSON Format
Patient data in the export file adheres to the JavaScript Object Notation (JSON) Data Interchange Format (https://www.json.org/). JSON is a common structured data format used to migrate data from one programming language to another.
Data Types
Data adheres to the JSON standard, and data-labels have been made self-explanatory within the context of the data structure. All values are alpha-numeric, with the below exceptions:
- DateTime: Values that includes both date and time are formatted in Coordinated Universal Time (UTC).
- Consolidated Clinical Document Architecture (CCDA): Any CCDA data included in the file uses the CCDA XML-based markup standard.
- Files: Binary files added to the patient record within Equicare (such as PDFs, Microsoft Word documents, etc.) are converted to text in the export file using Base 64 Encoding (https://datatracker.ietf.org/doc/html/rfc4648#section-4).
Data Categories
The following categories and fields of patient data are exported to the file. If there is no data within a category, the category will still be included in the file, but with no values.
Category Name | Category Name | Description | Available Fields |
---|---|---|---|
Registration Details | PatientRegistrationDetails | Patient Registration information. | FirstName MiddleInitial LastName NickName Ethnicity Race Religion BirthCountry Ssn Mrn Empi Gender DateOfBirth PrimaryLanguage PatientCommunicationLanguage Citizenship MaritalStatus MothersMaidenName Occupation EducationLevel Deceased HomePhone MobilePhone WorkPhone Fax PrimaryEmail PreferredCommunication CommunicationComment Address1 Address2 City ZipCode State Country Insurance InsuranceNote AdvancedDirective AdvancedDirectiveNote ClinicalTrial ClinicalTrialID |
Contact Details | PatientContactsDetailsList | Patient Contact information. | FirstName LastName Relation PrimaryContact NextofKin ProvidestransportationToAppointments Address1 Address2 City ZipCode State Country HomePhone HomePhoneFormatted HomePhoneMessagesCanBeLeft MobilePhone MobilePhoneFormatted MobilePhoneMessagesCanBeLeft WorkPhone WorkPhoneFormatted WorkPhoneMessagesCanBeLeft Fax FaxFormatted PreferredContactMethod PrivateNote AuthorizeToAccessPatientRecord IsActive Archived |
Appointments | PatientAppointmentsDetailsList | Details of scheduled appointments. | AppointmentType AppointmentSubType Status StartDateTime EndDateTime Location Institution Address1 Address2 Address3 City State Zip Country Provider Notes |
Referrals | PatientReferralsDetailsList | Referrals to other providers recorded within the Navigation Summary. | ServiceType ReferralDate ReferredTo ReferredBy IsOutOfNetwork OutOfNetworkReason ReferralReason ServiceDate DelayOfService DelayOfServiceReason IsArchived NotePadDetails Attachments |
CCDAs | PatientCcdaDetailsList | CCDAs, formatted exactly as imported by Equicare. | CcdaFileContent |
Problems | PatientProblemDetailsList | Details of all Problems entered for the patient within the Navigation Summary. | Category Description IdentifiedDate IdentifiedBy IsResolved NotePadDetails Attachments |
Test Results | PatientTestResultsList | Patient Test Results. | TestResultName CollectedDate Orderedby Status Remarks LabName LabAddress TestGroupName: [TestName, Flag, TestResultValue, Units, ReferencesRange, Published] |
Care Management | PatientCareManagementInfo | General patient management information such as Facility and Stage of Care. | ActivationStatus ActiveDate Facility PortalLanguage StageofCare PrimarySite SecondarySite SecondarySiteMechanism CustomPatientFieldsList: [FieldName, FieldValue] |
Chart Notes | PatientChartNoteDetailsList | Patient Chart Notes. | TemplateName NoteAuthor NoteDate IsDraft Fields: [FieldName, FieldValue] Attachments: [FileName, FileContentType, FileContentBase64] |
Secure Messages | PatientSecureMessageDetailsList | The Secure Messages sent between the patient and care team. | Date/Time Sender Recipient Subject body |
Care Team | PatientCareTeamList | Names and contact information for the patient’s care team. | Name Title Identifier(NPI) Institution Address1 Address2 Address3 City State Country ZipCode PhoneNumber PhoneExtension Fax InternalCommunicationEmail InternalCommunicationPhone InternalCommunicationPhoneExtension CareCoordinator PrimaryCarePhysician |
Questionnaires | PatientQuestionnaireDetailsList | Assigned Questionnaires including questions and answers. | QuestionnaireTitle CompletedDate SubmittedUser PatientQuestionnaireQuestionAnswers: [Question, Answer] |
Educational Materials | PatientEducationDetailsList | List of educational materials assigned to the patient, not including the materials themselves. | ArticleTitle AssignedDate Archived |
Follow up Plan | PatientFollowUpPlanDetails | Follow up plan schedule and tasks. | StartDate PrintMemo AssignedTemplates: [TemplateName, EffectiveDate, Comment] FollowUpInstances: [ Name Status Provider TargetDate ScheduledDateTime NotepadDetails Tasks: [TaskName, TaskDescription, IsAddressed, ChartNoteRecordedDate, ChartNoteAuthor] ] |
Medical Notes | PatientMedicalNoteDetailsList | Medical Notes, not including any binary documents included with the notes. | DocumentType ServiceDate Status Published FilePathToMedicalNoteFile |
Encounter Notes | PatientEncounterNoteDetailsList | Patient Encounter Notes | EncounterType NoteAuthor DateTimeOfNote Details |
Treatment Summary | PatientTreatmentSummaryDetailsList | Details of patient treatments. | TreatmentCategoryType Archived Published RecordDetails: [FieldName, FieldValue] |
Export Example
All data is formatted like the example below:
"PatientTestResultsList": [
{
"TestResultName": "Basic Metabolic Panel,CBC w/ 3 Part Diff",
"TestGroupsList": [
{
"TestGroupName": "Basic Metabolic Panel",
"TestDetailsList": [
{
"TestName": "Sodium - Blood",
"TestResultValue": "144.0",
"Units": "mmol/L",
This example represents a patient’s Test Results. One of the Test Results is a Basic Metabolic Panel, CBC w/3 Part Diff. One of the test groups in these results is Basic Metabolic Panel, which includes a Sodium – Blood value of 144.0 mmol/L.
Working in reverse order using the data labels: TestResultValue is associated with TestName within TestDetailsList, which is a child of TestGroupName within TestGroupsList, which is a child of TestResultName within PatientTestResultsList.