Passer au contenu
API referenceHl7 v2

Ingest HL7 v2

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.

Cette page n'est pas encore offerte en français; elle est affichée en anglais.
POST
/v1/hl7v2

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.

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: hl7v2:write

Query Parameters

site?string
Lengthlength <= 64

Header Parameters

Api-Version?enum

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

Idempotency-Key?string

1–255 characters of [A-Za-z0-9._:-] (a UUID v4 is recommended); never PHI. Stored 24 hours per app.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

body*string
Lengthlength <= 262144

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/hl7v2" \  -H "Content-Type: application/json" \  -d '{    "messages": [      {        "er7": "string"      }    ]  }'
{  "deliveryId": "string",  "messages": [    {      "ack": "string",      "controlId": "string",      "events": [        {          "edflowEncounterId": "string",          "error": {            "code": "string",            "message": "string",            "path": "string",            "retryable": true          },          "id": "string",          "note": "string",          "status": "accepted",          "warnings": [            {              "code": "string",              "path": "string"            }          ]        }      ],      "problems": [        {          "code": "string",          "location": "string",          "severity": "string"        }      ]    }  ]}

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

Process a FHIR message POST

`$process-message`: a `message` Bundle whose first entry is a `MessageHeader`. Synchronous; duplicates (`Bundle.id` + `MessageHeader.id`, 30 days) replay the stored response. Data rejections answer 200 with `fatal-error`; transient failures answer 503 with `Retry-After`.

Get an ingest event GET

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