Passer au contenu
API referenceIngest

Get an ingest event

One ledger row of the app's source by the source event id (URL-encoded). Metadata only.

Cette page n'est pas encore offerte en français; elle est affichée en anglais.
GET
/v1/events/{eventId}

One ledger row of the app's source by the source event id (URL-encoded). Metadata only.

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: events:read

Path Parameters

eventId*string
Length1 <= length <= 200

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/events/string"
{  "authKind": "signature",  "duplicateCount": -9007199254740991,  "edflowEncounterId": "enc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "errorCode": "string",  "errorPath": "string",  "id": "string",  "ledgerId": "led_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "mappingProfile": "string",  "note": "string",  "object": "ingest_event",  "occurredAt": "2026-09-14T15:00:11.402Z",  "receivedAt": "2026-09-14T15:00:11.402Z",  "site": "kb-main-ed",  "status": "accepted",  "type": "string",  "updatedAt": "2026-09-14T15:00:11.402Z",  "version": -9007199254740991}

Cette page vous a-t-elle été utile?

Ingest HL7 v2 POST

Raw mode (`application/hl7-v2`, `x-application/hl7-v2+er7` or `text/plain`, optional `charset` that must agree with MSH-18): one ER7 message, answered with an ACK per the ACK table. JSON mode (`application/json`): `{ messages }` (≤ 50). Transient failures are `503`/`429` with `Retry-After` and no ACK. Site: `?site=`, else resolved from MSH-4 through the mapping profile. Engines must never hold their queue on a EDFlow ACK.

Ingest one event POST

One normalized event (≤ 32 KiB). `accepted`, `duplicate`, `ignored` and `superseded` answer 200; `buffered` and `quarantined` answer 202; a data rejection is `422 event_rejected`; a reused id with another payload is `409 idempotency_conflict`; a processing error is `503` (retry the same event).