Create a Group Resource

Before you can start the Group Bulk Data Export function, you must create a group for the member population of FHIR resources that you want to export.

This process is only for group exports. If you want to export bulk data for a user ID or a client ID, you don’t have to create a group resource. You can proceed to the instructions in Export Bulk Data.

Before you create your member group, it’s important to consider how many resources you want to export and the size limitations of each group. Each member group can contain a maximum of 10,000 members and can have a maximum size of 400 KB, only when a member entry is limited to the patient entity reference. If the member entry includes additional properties, the size of the member entry increases, which can reduce the number of members you can include in the group.

Before you create your member group, it’s important to consider how many members you want to export and the size limitations of each group. The maximum size for each member group is 400 KB. The number of members you can add to a group depends on the number of properties included in the member entry for the members you add to the group. If a member entry is limited to the patient entity and reference properties, you can add up to 10,000 members. If the member entry includes additional properties, the number of members you can include in the group is reduced.

The Export operation ignores any properties that are not included in the member array (such as period and inactive).

Before you begin the process to create a group, we recommend that you review the HL7 FHIR R4 information about Resource Groups and how to format a member array in the group.

Create a group:

1. Create a group list that follows the JSON format specified in the FHIR R4 Resource Group example.

   Example group in JSON format

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   {
     "resourceType": "Group",
     "id": "102",
     "text": {
       "status": "additional",
       "div": 
           "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      
               <p>Selected Patients</p>\n      
               <ul>\n        
                   <li>Patient John Doe @ Example Healthcare, Inc. MR = 654321</li>\n        
                   <li>Patient Jane Doe @ Example Healthcare, Inc. MR = 123456</li>\n        
                   <li>Patient Liam Leigh @ Example Healthcare, Inc. MR = 123457, DECEASED</li>\n        
                   <li>Patient Liam Leigh @ Example Healthcare, Inc. MR = 123458, DECEASED</li>\n      
               </ul>\n    
           </div>"
     },
     "type": "person",
     "actual": true,
     "member": [
       {
         "entity": {
           "reference": "Patient/pat1"
         },
         "period": {
           "start": "2014-10-08"
         }
       },
       {
         "entity": {
           "reference": "Patient/pat2"
         },
         "period": {
           "start": "2015-04-02"
         },
         "inactive": true
       },
       {
         "entity": {
           "reference": "Patient/pat3"
         },
         "period": {
           "start": "2015-08-06"
         }
       },
       {
         "entity": {
           "reference": "Patient/pat4"
         },
         "period": {
           "start": "2015-08-06"
         }
       }
     ]
   }

2. Add a member array to the group and add members (patients) to the array.

   You can add a maximum of 10,000 members to the array.

   Example member group array

   1
   2
   3
   4
   5
   6
   7
   8
   "member": [
       {
         "entity": {
           "reference": "Patient/memberID123" }
   },
   { "entity": { 
      "reference": "Patient/memberID456" }
   },

3. Give the completed group JSON array to 1upHealth to create your group of patients on the 1up Platform.