Availability and release status
Current contract: 0.1.0-draft.3. This portal is a design reference. No partner endpoint or SDK release has been verified against a live sandbox during its creation.
| Label | Meaning |
|---|---|
| Draft / Proposed | Designed, with implementation or authorization work still required. |
| Sandbox | Verified and enabled for this client's synthetic-data environment. |
| Beta | Available under explicitly communicated compatibility and support expectations. |
| Production | Verified production release with onboarding, support and documented behavior. |
Every operation is currently documented as draft or proposed. Existing repository code establishes a foundation, not partner deployment coverage. Production and sandbox URLs in the spec identify intended destinations, not verified availability.
Launch candidates
Processing status, immutable snapshots, document batches, applicable access grants, integration capabilities and asynchronous operation receipts are the first additional endpoint candidates. They have no committed delivery dates.
Open decisions before release
- Verify integration-to-Organisation identity binding and existing-patient linking.
- Confirm patient delegation, symptom-assessment access and practitioner audit identity.
- Define source filtering for aggregate responses and evaluation access.
- Confirm enabled formats, extraction paths, providers and interview types.
- Implement stored-only processing admission, one-way scrubbing enablement with safe retained-input routing, retained-input eligibility, document-specific processing authority, attempt concurrency and atomic receipt/dispatch recording. Existing operator redo is only a foundation.
- Establish operation receipts, result retrieval, erasure status and retained-copy semantics.
- Complete webhook rotation/replay management and idempotency/concurrency coverage.
- Confirm vocabulary redistribution rights and intended purpose of clinical derived outputs.
- Validate SDK packages, sample apps and platform requirements.
Once implemented, GET /integration/capabilities should distinguish this client's enabled operations from scopes granted in a token. It must not advertise a capability merely because its endpoint is described in this portal.
Compatibility
The draft plans additive changes within /v1 and a separate path version for breaking changes. Contract version 0.1.0-draft.3, URL version /v1 and OpenAPI format version 3.1.0 describe different things. Pre-release compatibility and overlap commitments must be confirmed before production onboarding.