0.1.0-draft.3
OpenAPI 3.1.0
ENO Health Partner API
ENO Health API team
Draft design, 12 October 2026 (draft 3: codebase-informed partner endpoint additions). New endpoint families are proposals, with x-eno-foundation and x-eno-priority metadata; no launch date is implied. Patient data requires both the endpoint scope and an Access Decision for every contributing source. Processing consent is distinct from Patient Access Grants. Partner identity must bind to a verified organisation. Evidence-preserving snapshots and bundles use EvidenceObservation, separate from the simplified Observation model.
Naming conventions
- JSON keys and query parameters are lowerCamelCase. URL path segments are lowercase kebab-case plural nouns.
- Every resource has its own key
id. A reference to another resource is<resource>Id(userId,documentId). - The user identifier (
userId) is the common key across all modules. - Instants end in
At(createdAt) and are ISO 8601 UTC. Calendar dates end inDate(birthDate) asYYYY-MM-DD. - Booleans read as a statement (
hasMore,requiresReview). - Physical quantities are
{ "value": 178, "unit": "cm" }, units in UCUM. - Coded concepts carry
codings: [{ system, code, display }](LOINC, SNOMED CT, ICD-10, ATC) rather than one key per code system. - External identifiers are
externalId, oridentifiers: [{ system, value }]when there can be several. - Enum values are lowercase snake_case strings (
in_progress). Event types areresource.action(document.processed). - Exceptions kept for standards compliance: OAuth 2.0 token fields (
access_token,expires_in, RFC 6749) and RFC 9457 problem fields.
Protocol conventions
- JSON over HTTPS (TLS 1.2+). Clients must ignore unknown fields; additive changes ship inside
/v1, breaking changes in/v2. - IDs are prefixed ULIDs (
usr_,doc_,itv_,obs_,rcm_,goal_,con_,emb_,evt_). - Creates accept an
Idempotency-Keyheader (24 h window). - Lists use cursor pagination (
limit,cursor->nextCursor,hasMore). - Errors use RFC 9457
application/problem+jsonwith a stablecode. - Updates use JSON Merge Patch (RFC 7396) with optional
If-Matchon theETag. - Webhooks follow the Standard Webhooks spec (
webhook-id,webhook-timestamp,webhook-signature).
Client Libraries