CuraeAI Developers
API referenceSDK Immunizations

Search connection-scoped immunizations through the SDK gateway

Returns a FHIR Bundle containing Immunization resources authorized by the presented APP tenant API key with immunization:read scope and the request body's `connectionId`. The gateway enforces APP tenant residency, SpiceDB app-install projection, subject lifecycle capability, resource-type scope, and service-level CVX, sensitivity, and time-window scope before any PHI read is returned. When `statuses` is omitted the platform defaults to `['COMPLETED']`; consumers needing the refusal signal can opt in with `statuses: ['COMPLETED', 'NOT_DONE']`.

POST/api/sdk/v1/immunizations:search

Returns a FHIR Bundle containing Immunization resources authorized by the presented APP tenant API key with immunization:read scope and the request body's connectionId. The gateway enforces APP tenant residency, SpiceDB app-install projection, subject lifecycle capability, resource-type scope, and service-level CVX, sensitivity, and time-window scope before any PHI read is returned. When statuses is omitted the platform defaults to ['COMPLETED']; consumers needing the refusal signal can opt in with statuses: ['COMPLETED', 'NOT_DONE'].

Authorization

platformApiKey
AuthorizationBearer <token>

CuraeAI Platform API key using the format Bearer . Keys are opaque credentials such as cae_live_..., not JWTs.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

curl -X POST "https://example.com/api/sdk/v1/immunizations:search" \  -H "Content-Type: application/json" \  -d '{    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d"  }'
{  "resourceType": "Bundle",  "type": "searchset",  "total": 0,  "entry": [    {      "fullUrl": "string",      "resource": {        "resourceType": "Immunization",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "meta": {          "source": "string",          "tag": [            {              "system": "string",              "code": "string",              "display": "string"            }          ]        },        "status": "completed",        "vaccineCode": {          "coding": [            {              "system": "string",              "code": "string",              "display": "string"            }          ],          "text": "string"        },        "patient": {          "reference": "string"        },        "occurrenceDateTime": "2019-08-24T14:15:22Z",        "manufacturer": {          "display": "string"        },        "lotNumber": "string"      },      "search": {        "mode": "match"      }    }  ]}
{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "code": "string",  "details": {},  "retryable": true}