Bulk Data Kick-off
Description
The Bulk Data Kick-off Request service initiates the FHIR bulk data workflow, which allows a client to request bulk clinical data for a "group" that consists of a set of patients.
Request Elements
Parameters
Name : _type
Description : Filter results by comma delimited list of FHIR resource types. ( includeAssociatedData )
Return the most recent provenance data for all resource types included in the bulk data kick-off request. The only supported value is “LastestProvenanceResources.” There is no way to selectively specify returning provenance for a subset of requested resources.
Request:
https://hostname/instance/api/FHIR/R4/Group/eIscQb2HmqkT.aPxBKDR1mIj3721CpVk1suC7rlu3yX83/$export
Accept : application/fhir+json
Prefer : respond-async
Response:
HTTP/1.1 202 Accepted
Cache-Control: no-cache,no-store
Pragma: no-cache
Content-Type: text/plain; charset=utf-8
Content-Location: https://hostname/instance/api/FHIR/
BulkRequest/ 0000000000176E6DC7DB51C0082DA988
Bulk Data Status Request
Description
The Bulk Data Status Request service allows the FHIR bulk data client to check the status of an existing bulk FHIR request that was previously initiated using the Bulk Data Kickoff Request service through the status URL provided in the Content-Location header.
Request Elements
Parameters
Name : BulkRequestID
Description : The FHIR ID for the bulk request.
Response Elements
Parameters
Name : transactionTime
Description : The server's time when the query is run.
Name : Request
Description : The full URL of the original bulk data kick-off request.
Name : requiresAccessToken
Description : Indicates whether downloading the generated files requires a bearer access token.
Name : Output
Description : An array of file items with one entry for each generated file. If no resources are returned from the kick-off request, the server returns an empty array.
Name : output.type
Description : The FHIR resource type that is contained in the file.
Name : output.url
Description : The path to the file.
Name : Error
Description : Array of error file items following the same structure as the output array.
Request:
https://hostname/instance/api/FHIR/BulkRequest/00000000001755C1C7DB51C0082DA988
Response:
X-Progress:Searched 0 of 2 patients
{
"transactionTime": "2021-06-18T17:46:48Z",
"request": "https://hostname/instance/api/FHIR/r4/group/eK33625FpEX2HcV6nEGdHqdTeCkY1QCJ.81zzQqHDLmE3/$export",
"requiresAccessToken": "true",
"output": [
{
"type": "ImagingStudy",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/e1pvyleJ0NztMM4PA1YDVdg3"
},
{
"type": "List",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/e5jN74CQQ1fGusGOFwJVezA3"
},
{
"type": "Location",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/e79-6-iPihDniYzmry.zPpg3"
},
{
"type": "RequestGroup",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eAdwSFa8TR.bXUZrG.nD9fA3"
},
{
"type": "Practitioner",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eC0CVmiyf.k0-TNjcGHNTwg3"
},
{
"type": "DiagnosticReport",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eF5hWLcmU-WSBvOTMBaRvYQ3"
},
{
"type": "AllergyIntolerance",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eFbW3bq2TXRjuDm4.WkMbvQ3"
},
{
"type": "ServiceRequest",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eGRht0LE5A34bk8kSqpRhJg3"
},
{
"type": "Device",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eGepFATqcLlWwdx4DxmZxnA3"
},
{
"type": "DocumentReference",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eICboFx8dNhKANtvx7UBa9A3"
},
{
"type": "Coverage",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eJ4FoyrJAbCZupmuYl5rRUA3"
},
{
"type": "Observation",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eOghaxFx49w2E8YmbUIBD5Q3"
},
{
"type": "Medication",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eRnS3FHQSwnLeokq3Z4g7rQ3"
},
{
"type": "Condition",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eUxJlEInckpalXFg5-9jvsg3"
},
{
"type": "Encounter",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eXnUByVf6AlRoEE.LbaDarQ3"
},
{
"type": "Immunization",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eabiPckPn7UBVwzcneGevJg3"
},
{
"type": "Patient",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/echvPfT5KlPJXLpeScmPW0w3"
},
{
"type": "Organization",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/ehCgaoyDZePF93zTHL6Hq2Q3"
},
{
"type": "CarePlan",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/elR3VhkbmFuKWvq6rute3Nw3"
},
{
"type": "CareTeam",
br/> },
{
"type": "Procedure",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eoOLSy2lNRRPwV6v4vMhzUQ3"
},
{
"type": "MedicationRequest",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/eoR.pXFHgJN4BU9Rl7RL2SQ3"
},
{
"type": "Goal",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/esbPYn8MPrjxOuVRDphn4fQ3"
},
{
"type": "Specimen",
"url": "https://hostname/instance/api/FHIR/BulkRequest/10777542D05D11EB89CD6D045785C67F/etMnbdLTa1e1XWP.STt08dQ3"
}
],
"error": []
}
Bulk Data File Request
Description
The Bulk Data File Request service is one API used as part of the larger FHIR bulk data download workflow, which allows a client to request bulk clinical data for a "group" consisting of a set of patients.
Request Elements
Parameters
Name : BulkRequestID
Description : The FHIR ID for the bulk request.
Name : outputID
Description : The ID associated with a generated file.
Request:
https://hostname/instance/api/FHIR/BulkRequest/00000000001755C1C7DB51C0082DA988/e1rS.x2sBAZmy8Mn8WyKk7Q3
Response:
{
"resourceType": "ImagingStudy",
"id": "eppu5-mCs4aXfc5tk4rD5mBYbSdFnfo3-ejVwsZKgOlk3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "eQDEQmVPdohHGIpWaApJjO-waXaKP7CdGxzjErpVoRHQ3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "e0zOzaQHTzvI10K.593VLwwbeHZ2PeRhaN-U1l9ID1BY3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "e0zOzaQHTzvI10K.593VLw8p9PyLeu91r8bc5QqOGHpI3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "e0zOzaQHTzvI10K.593VLwzSr-BGALBgosvFPq8CfkQU3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "e0zOzaQHTzvI10K.593VLwyC2aB6MsCD3tlSmAimUQ5g3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "e0zOzaQHTzvI10K.593VLw.QX4tLXhbnNiMKOUbpUbgk3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "e0zOzaQHTzvI10K.593VLw7napwHF5NGS7cAdKqbTnPY3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "efcdbTLLKNO6lvmBhMFQ.HQniBKF4ded7Yv-.dUwWaWk3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
{
"resourceType": "ImagingStudy",
"id": "eXGjS9OON2z2b0E79jz-9Tc3Y8ids3Z5JrP9QJpmP2Ls3",
"status": "available",
"subject":
{
"reference": "Patient/eJ3eyRAcJAipK43HdmMeOnQ3",
"displays": "Knees, Beese”
},
}
Bulk Data Delete Request
Description
The Bulk Data Delete Request service is used to cancel requests or remove files as part of the FHIR bulk data workflow. This workflow allows a client to request bulk clinical data for a "group" that consists of a set of patients.
Request Elements
Parameters
Name : BulkRequestID
Description : The FHIR ID for the bulk request.
Request:
https://hostname/instance/api/FHIR/BulkRequest/0000000000176E6DC7DB51C0082DA988
Response:
HTTP/1.1 202 Accepted
Cache-Control: no-cache,no-store
Expires: -1
Date: Fri, 16 Dec 2022 19:08:31 GMT
Content-Length: 0