Ovok primitives
This reference lists core platform routes and FHIR operations exposed by Ovok. Paths use :type for a FHIR resource type and :id for a resource id.
Health and discovery
Use the Health and discovery reference for cURL examples, response examples, and explanations of the returned fields.
| Operation | Method | Path |
|---|---|---|
| Health check | GET | /healthcheck |
| OpenID Connect discovery | GET | /.well-known/openid-configuration |
| JSON Web Key Set | GET | /.well-known/jwks.json |
| SMART configuration | GET | /.well-known/smart-configuration |
| SMART configuration | GET | /fhir/R4/.well-known/smart-configuration |
| FHIR CapabilityStatement | GET | /fhir/R4/metadata |
Observation and questionnaire operations
Each operation has its own reference page with request parameters, cURL examples, response examples, and error handling:
| Operation | Method | Path |
|---|---|---|
| Get last observations | GET | /fhir/R4/Observation/$lastn |
| Populate a Questionnaire | POST | /fhir/R4/Questionnaire/:id/$populate |
| Extract Observations from a QuestionnaireResponse | POST | /fhir/R4/QuestionnaireResponse/:id/$extract |
FHIR resource operations
| Operation | Method | Path |
|---|---|---|
| Validate a resource | POST | /fhir/R4/:type/$validate |
| Expunge a resource | POST | /fhir/R4/:type/:id/$expunge |
| Export a resource type as CSV | GET | /fhir/R4/:type/$csv |
| Reindex a resource | POST | /fhir/R4/:type/:id/$reindex |
| Get a resource graph | GET | /fhir/R4/:type/:id/$graph |
| Get everything for a Patient | GET | /fhir/R4/Patient/:id/$everything |
| Set accounts for a Patient | POST | /fhir/R4/Patient/:id/$set-accounts |
| Set accounts for a resource | POST | /fhir/R4/:type/:id/$set-accounts |
| Resend a resource | POST | /fhir/R4/:type/:id/$resend |
| Merge resources by type | POST | /fhir/R4/:type/$merge |
| Merge a resource by id | POST | /fhir/R4/:type/:id/$merge |
| Execute a Bot by id | POST | /fhir/R4/Bot/:id/$execute |
| Deploy a Bot | POST | /fhir/R4/Bot/:id/$deploy |
| Execute a Bot by identifier | POST | /fhir/R4/Bot/$execute?identifier= |
| Clone a Project | POST | /fhir/R4/Project/:id/$clone |
| Apply a PlanDefinition | POST | /fhir/R4/PlanDefinition/:id/$apply |
| Apply an ActivityDefinition | POST | /fhir/R4/ActivityDefinition/:id/$apply |
Bulk Data operations
| Operation | Method | Path |
|---|---|---|
| Export system data | GET | /fhir/R4/$export |
| Export Patient data | GET | /fhir/R4/Patient/$export |
| Export Group data | GET | /fhir/R4/Group/:id/$export |
| Check bulk export status | GET | /fhir/R4/bulkdata/export/:id |
| Import data | POST | /fhir/R4/$import |
| Check asynchronous job status | GET | /fhir/R4/job/:id/status |
Terminology operations
| Operation | Method | Path |
|---|---|---|
| Expand a ValueSet | GET or POST | /fhir/R4/ValueSet/$expand |
| Validate a code against a ValueSet | GET or POST | /fhir/R4/ValueSet/$validate-code |
| Look up a CodeSystem concept | GET or POST | /fhir/R4/CodeSystem/$lookup |
| Validate a CodeSystem code | GET or POST | /fhir/R4/CodeSystem/$validate-code |
| Test CodeSystem subsumption | GET or POST | /fhir/R4/CodeSystem/$subsumes |
| Import a CodeSystem | POST | /fhir/R4/CodeSystem/$import |
| Translate a concept using a ConceptMap | GET or POST | /fhir/R4/ConceptMap/$translate |
CodeSystem/$import changes terminology data, so it is documented as a POST operation. To inspect the CodeSystem after importing, use the separate GET /fhir/R4/CodeSystem search shown on its page.