More Info
Webhooks
More Info
Webhooks
Receive patient document data as soon as it becomes available after initiating a document query.
Overview
When using the Medical API, Metriport will send Webhook messages containing patient document data to your app, as soon as the data becomes available after initiating a document query.
To enable this integration approach with Metriport, and for some prerequesite reading to understand how the Webhook flow works, see our Webhooks guide.
Patient data message
The format follows:
{
"meta": {
"messageId": "<message-id>",
"when": "<date-time-in-utc>"
},
"patients": [
{
"patientId": "<patient-id-1>",
"documents": [
{
"id": "1.2.543.1.34.1.34.134",
"fileName": "CCDA_Diag.xml",
"location": "https://fhir.metriport.com/oauth/fhir/Binary/2.16.840.1.113883.3.777.666.5.700009.969696",
"description": "Patient Diagnoses",
"status": "current",
"indexed": "2019-09-07T15:50:00.000Z",
"mimeType": "application/xml",
"size": "17344007",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "62479008",
"display": "Diagnoses"
}
],
"text": "Diagnoses"
}
},
{
"id": "1.2.543.1.224.54.22.540",
"fileName": "Progress_Notes.xml",
"location": "https://fhir.metriport.com/oauth/fhir/Binary/2.16.840.1.113883.3.777.666.5.700009.69696969",
"description": "Patient Encounter Progress Notes 2023-03-22",
"status": "current",
"indexed": "2023-03-22T08:34:00.000Z",
"mimeType": "application/xml",
"size": "8675545",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371532007",
"display": "Progress Report"
}
],
"text": "Progress Notes"
}
},
]
},
{
"patientId": "<patient-id-2>",
...
}
]
}
Details