Skip to main content
Migration and clean-up are requested from OpenLoop, not done by you. If you are migrating an existing patient population onto the platform, or need a wrongly created patient removed, raise it with your OLH implementation contact before you plan around anything on this page. Nothing here is a committed migration path.

What exists today

Patients are created one at a time with POST /v0.1/patients (verified on staging). That is the only published way to get a patient into the platform. No bulk import endpoint is published. There is no CSV upload, no batch create, and no migration API in the published reference. A migration built only from published endpoints is a loop over POST /v0.1/patients, at your own rate — which is why a population migration is planned with OpenLoop rather than run from your side alone. You cannot delete. Partners do not delete records — not patients, questionnaire responses, consents or document references. A patient you create stays created. Removing one — a duplicate, a test record on production, a half-finished migration — is something OpenLoop does on request. The records hanging off a patient are not yours to replay either. A completed intake creates the encounter as a side effect of POST /v0.1/questionnaire-responses, and the prescription that may follow is created by a clinician; you can store the encounter_id the submit returns, but encounters are not partner-readable. So historical clinical records cannot simply be replayed through the partner surface.

What you can still do yourself

Neither PUT is exercised by a conformance check. Whether a PUT clears fields you omit is not stated in the spec, so rehearse it on a scratch patient on staging and send the full record you want stored.

Questions to settle before you start

Ask these of your OLH implementation contact; the answers change the shape of the work substantially.

What we can tell you now

  • Creating a patient is idempotent only in the sense that repeated calls create separate records (verified on staging). There is no documented upsert, and no partner delete to undo a duplicate, so you must track which of your patients you have already created.
  • GET /v0.1/patients?email=<email> filters by email and validates its input, so email is usable as a de-duplication check before creating (verified on staging).
  • For OpenLoop-side clean-up: deleting a patient does not cascade to their encounters (verified on staging 2026-10-02). When you ask OpenLoop to remove a patient who has already submitted an intake, say so, so the encounter is handled too.

Status

This page will be replaced once a migration path is agreed. Until then, treat any migration plan built from this cookbook alone as unvalidated.