EHI Export

EHI Health Maintenance Reminders Format

The Health Maintenance Reminders output format.

Table of contents

1. The Health Maintenance Reminders file naming scheme

2. The detailed file format definition

File Naming Scheme:

The Health Maintenance Reminders files are named following the naming convention as follows:

 HealthMaintenance_SPID_PROFILE_VISIT_Reminders_CREATIONDATE_CREATIONTIME_id-spid.arid.profile

An example of this naming convention:

HealthMaintenance_1_12345678_123456_Reminders_0230101_12000000_id-1.1.12345678

Detailed File Format:

The file output consists of JSON data files.

[
  {
    "id": "cd3e41b3-48d8-48a8-86a4-4041f95eb62d",
    "patient": {
      "xRef": "urn:Thrive:l2104:fhir:Patient/id-1.1.3249",
      "mrn": "id-1.970495",
      "firstName": "WINNIE",
      "middleName": "THE",
      "lastName": "POOH",
      "displayName": "POOH WINNIE THE",
      "managingOrganization": {
        "displayName": "EVIDENT COMMUNITY HOSPITAL",
        "osFacId": "Organization/id-osfac.d4f07008-0ccb-46ad-9d2f-32b035a5f78c"
      },
      "provider": null,
      "birthDate": "1985-03-18T00:00:00Z",
      "gender": "M",
      "consent": {
        "isEmailOptIn": false,
        "isTextOptIn": false
      }
    },
    "reminderDefinitionId": "6dfe8735-0a38-4d50-96e0-d2bbcb0973a9",
    "reminderDefinition": {
      "id": "6dfe8735-0a38-4d50-96e0-d2bbcb0973a9",
      "description": "Early Childhood Wellness Visit (1 year to 4 yrs)",
      "ageBegin": 1,
      "ageBeginUnit": "Years",
      "ageEnd": 4,
      "ageEndUnit": "Years",
      "gender": null,
      "interval": {
        "interval": 1,
        "unit": "Years"
      }
    },
    "interval": {
      "interval": 1,
      "unit": "Years"
    },
    "comments": "",
    "dateDue": "2023-04-27T21:48:54.7Z",
    "nextDateDue": null,
    "provider": null,
    "providerDisplayName": null,
    "status": "Communication Needed",
    "statusDate": "2023-04-26T21:48:55.443Z"
  },
  {
    "id": "d3be0982-0c79-4ca4-9fea-dcdacbc4270e",
    "patient": {
      "xRef": "urn:Thrive:l2104:fhir:Patient/id-1.1.3249",
      "mrn": "id-1.970495",
      "firstName": "WINNIE",
      "middleName": "THE",
      "lastName": "POOH",
      "displayName": "POOH WINNIE THE",
      "managingOrganization": {
        "displayName": "EVIDENT COMMUNITY HOSPITAL",
        "osFacId": "Organization/id-osfac.d4f07008-0ccb-46ad-9d2f-32b035a5f78c"
      },
      "provider": null,
      "birthDate": "1985-03-18T00:00:00Z",
      "gender": "M",
      "consent": {
        "isEmailOptIn": false,
        "isTextOptIn": false
      }
    },
    "reminderDefinitionId": "68e2c1d7-6671-434b-92b0-f8ffa26f1fce",
    "reminderDefinition": {
      "id": "68e2c1d7-6671-434b-92b0-f8ffa26f1fce",
      "description": "Adult Influenza Vaccine",
      "ageBegin": 18,
      "ageBeginUnit": "Years",
      "ageEnd": 0,
      "ageEndUnit": null,
      "gender": null,
      "interval": {
        "interval": 1,
        "unit": "Years"
      }
    },
    "interval": {
      "interval": 1,
      "unit": "Years"
    },
    "comments": "",
    "dateDue": "2023-04-29T21:20:59.793Z",
    "nextDateDue": null,
    "provider": null,
    "providerDisplayName": null,
    "status": "Communication Needed",
    "statusDate": "2023-04-26T21:21:00.53Z"
  }
]