Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Update Guest EMR Data

This API adds or updates multiple EMR data sections for a guest in a single API call. Supports allergies, medications, medical histories, social history, and vitals — each section is optional and processed independently in parallel, with per-section error reporting.

put/v1/emr/guests/{guest_id}

Path parameters

guest_idstring required

Unique identifier of the guest whose EMR data is being upserted

Query parameters

related_idstring

Identifier of the related entity (e.g. appointment ID or form submission ID). Must be provided together with related_type and related_time

related_typestring

Type of the related entity. Values: 0 = None, 1 = Appointment, 2 = GuestForm, 3 = ePrescribe

related_timestring date

Timestamp associated with the related entity

form_idstring

Identifier of the form that triggered this EMR update

Response

200

OR

Example response

{
  "emr_data": {
    "allergies": [
      {
        "allergy_id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
        "category": 1,
        "allergy_name": "Peanuts",
        "severity": 2,
        "source": 1,
        "is_active": true,
        "status": 1,
        "created_by": {
          "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
          "name": "Dr. Jane Smith",
          "date": "2026-03-30T10:15:00Z"
        }
      }
    ],
    "medications": [
      {
        "medication_id": "c3d4e5f6-a7b8-9012-3456-789abcdef012",
        "medication_name": "Ibuprofen 200mg",
        "start_date": "2026-01-15T00:00:00Z",
        "status": 1,
        "created_by": {
          "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
          "name": "Dr. Jane Smith",
          "date": "2026-03-30T10:15:00Z"
        },
        "notes": "Take with food",
        "guest_medication_id": 42,
        "related_type": 1
      }
    ],
    "vitals": [
      {
        "id": 1,
        "name": "blood_pressure",
        "display_name": "Blood Pressure",
        "value": "120/80",
        "is_enabled": true,
        "data_type": "string",
        "index": 1,
        "session_datetime": "2026-03-30T10:00:00Z",
        "blood_pressure": "120/80",
        "created_by": {
          "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
          "name": "Dr. Jane Smith",
          "date": "2026-03-30T10:15:00Z"
        }
      }
    ]
  }
}