Skip to main content
Written for teams validating their design before building. Each row states an assumption we have seen partners make, and the verdict after testing it against the live API.

Intake and encounters

Patient records

Post-payment

Enumerations and their authority

A fair concern when migrating from a system with overlapping, non-hierarchical enumerations: which value sets can you depend on? Most status enumerations here are fixed value sets, and the platform does not extend them. Across the enumerated fields in the published contract, the clinical resources use these values exactly: Order status is the platform’s own value set, carried on the prescription webhook events (by arrangement), not on an API resource. These values are published in the prescription webhook contract — see Events and Prescription events: These values are not in the OpenAPI document, so the type-generation advice below does not cover them; take them from the prescription webhook contract (Events, Prescription events) and treat an unknown value as a signal to check with your implementation contact.
For any enumerated field, the published OpenAPI document is authoritative and machine-readable. Generate your types from it rather than transcribing values; that way a value added upstream surfaces as a type error rather than a runtime surprise.One field to keep treating as optional: concept_id. Until 2026-09-19 the published QuestionnaireItem and QuestionnaireAnswerOption schemas did not declare concept_id, although live staging returned it on items and answer options; the schemas now declare it, together with enable_when and enable_behavior on items. Types generated from an older copy of the document will not carry them, so regenerate. concept_id stays optional wherever it appears — some items and some options never carry one — and Questionnaire workflow tells you how to read it.