Hip data fetch

​

Request

• Eka-Webhook-Signature: <Eka Webhook Signature> Refer: Webhook Signature
• Content-Type: application/json

{
    "service": "abdm",
    "event": "abha.hip_data_fetch",
    "event_time": 1749822309,
    "transaction_id": "<webhook transaction id>",
    "timestamp": 1749825214,
    "business_id": "<partner business id>",
    "client_id": "<partner client id>",
    "data": {
        "abha_address": "shyam@abdm",
        "oid": "<eka user id>",
        "partner_patient_id": "<partner patient id>",
        "hip_id": "<partner hip id>",
        "transaction_id": "",
        "care_contexts": [
            "care_context_1",
            "care_context_2"
        ],
        "key_information": {
            "crypto_alg": "",
            "curve": "",
            "dh_public_key": {
                "expiry": "",
                "parameters": "",
                "key_value": ""
            },
            "nonce": ""
        },
        "hi_types": [
            "OPConsultation",
            "Prescription"
        ]
    }
}

​

Field Descriptions

• data: Contains additional details related to the event.
  • hi_types: Health information types requested by HIU
    • Available options: OPConsultation, Prescription, DischargeSummary, DiagnosticReport, ImmunizationRecord, HealthDocumentRecord, WellnessRecord
  • key_information : Contains the cryptographic key material and related parameters required for secure ECDH-based key exchange between HIU and HIP.
    • crypto_alg The cryptographic algorithm used for key exchange (e.g., “ECDH”).
    • curve The elliptic curve used in ECDH key generation (e.g., “Curve25519”, “P-256”).
    • dh_public_key Object containing the HIU’s public key and related metadata:
      • expiry The expiration timestamp (in ISO 8601 format) indicating how long the public key is valid.
      • parameters Additional parameters related to the ECDH key (optional or curve-specific).
      • key_value The base64-encoded public key value generated by the HIU.
    • nonce A 32-byte random nonce (Base64-encoded) generated by the HIU, used to ensure uniqueness in the session key derivation.