Payload Examples by Resource

Webhook notifications from Health Gorilla include the full FHIR resource that triggered the event. This page provides sample payloads by resource type so you can understand the structure and plan for parsing or processing events in your application.

All webhook payloads are delivered as application/fhir+json.

DocumentReference

{
  "resourceType": "DocumentReference",
  "id": "doc-123",
  "status": "current",
  "type": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "34133-9",
        "display": "Summarization of episode note"
      }
    ]
  },
  "subject": {
    "reference": "Patient/abc-123"
  },
  "date": "2024-11-01T18:27:00Z"
}

 

Encounter

{
  "resourceType": "Encounter",
  "id": "enc-456",
  "status": "finished",
  "class": {
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "code": "IMP",
    "display": "inpatient encounter"
  },
  "subject": {
    "reference": "Patient/abc-123"
  },
  "period": {
    "start": "2024-10-30T12:00:00Z",
    "end": "2024-11-01T16:00:00Z"
  }
} 

AllergyIntolerance

{
  "resourceType": "AllergyIntolerance",
  "id": "allergy-789",
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "active"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
        "code": "confirmed"
      }
    ]
  },
  "category": ["medication"],
  "code": {
    "text": "Penicillin"
  },
  "patient": {
    "reference": "Patient/abc-123"
  },
  "recordedDate": "2024-09-10"
}

Observation (Lab Result)

 {
  "resourceType": "Observation",
  "id": "obs-101",
  "status": "final",
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "4548-4",
        "display": "Hemoglobin [Mass/volume] in Blood"
      }
    ]
  },
  "subject": {
    "reference": "Patient/abc-123"
  },
  "effectiveDateTime": "2024-11-01T08:00:00Z",
  "valueQuantity": {
    "value": 13.5,
    "unit": "g/dL",
    "system": "http://unitsofmeasure.org",
    "code": "g/dL"
  }
}

Immunization

 {
  "resourceType": "Immunization",
  "id": "imm-303",
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "207",
        "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5 mL dose"
      }
    ]
  },
  "patient": {
    "reference": "Patient/abc-123"
  },
  "occurrenceDateTime": "2024-10-15"
}

Note: Actual webhook payloads may contain additional fields depending on the source and completeness of the clinical document. Your application should be resilient to extra fields and null values.