Skip to main content

​
Data browser

​
What this is for

When you send data to ClinikAPI (a patient, an appointment, a lab result) it is stored as a record, and each kind of record is called a resource type. This is a standard healthcare term from a format called FHIR: a Patient is one resource type, an Observation (such as a blood-pressure reading) is another. The Data browser lets you see those records in a table without writing any code, and, using a test key, add, change or delete practice records so you can see how the API behaves.
The sandbox is for synthetic data only: invented people and values. Never enter real patient information. See Sandbox rules.

​
Before you start

  • You need a test key (it starts with clk_test_). Create one on Access. To browse you need the Read scope; to add, edit or delete you need Write as well.
  • Any member of the organization can use this page. Only test keys are accepted: live data cannot be changed from the dashboard.
  • The practice environment (the sandbox) must be up. If it is not, the page says Sandbox coming soon (see below).
  • Have your full test key to hand. The dashboard cannot fill it in for you, because it never stores your secret.

​
Look at records

1

Open the Data browser

Choose Data browser in the sidebar. The page is titled Data browser: “Browse the records your test keys create, by resource type. Test data can be added, changed and deleted; live data is read-only.”
2

Pick a resource type

A list of resource types (Patients, Encounters, Observations, Appointments and many more) sits on the left. Type in Filter resource types to narrow it; it says No match. if nothing fits. Select one, for example Patients.
3

Paste your test key

In Test key, paste your clk_test_… key. The box hides what you type. The Load records button stays disabled until the text looks like a test key. Beneath it: “The key is used for this request only and is not stored.”
4

Load the records

Select Load records (it reads Loading… briefly). After you have entered a valid key once, picking a different resource type loads it straight away.

​
Open one record

Select a row, or the first value in it (usually the id). A panel titled “(type) record” opens showing the record’s simple fields as a list, followed by the full JSON (the raw form of the record). If you have entered a test key it also offers Edit and Delete.

​
Add a record

1

Load the type first

Pick the resource type and load it with your test key as above. The New record button appears once a valid key is entered.
2

Start a new record

Select New record. A panel titled “New (type)” opens with a box labelled Record (JSON), starting from an empty { }.
3

Write the record

Type the record as a JSON object using the same field names the API accepts. For a patient, for example: { "firstName": "Jane", "lastName": "Doe" } (fictional!). The guide for each resource lists its fields.
4

Validate and save

Select Validate and save (Saving… briefly). The API checks the record before anything is stored. On success a message says Record created and the list refreshes.

​
Edit or delete a record

Open the record and select Edit. The editor starts from the record’s own fields without its ID and timestamps, which the system manages. Validate and save confirms with Record updated. Delete asks you to confirm in a box titled “Delete (type)/(id)”: “This test record is removed from the sandbox and cannot be restored.” Select Delete record. A message confirms it.

​
What you’ll see

  • Table. Up to six columns, id first, 25 records at a time. Beneath it: “Showing 25 of 140 records (first page).” Nested values are not shown in cells; open the record to see everything.
  • No records yet. “Records created with your test keys appear here.” This is normal on a new project.
  • Sandbox coming soon. “The sandbox data browser is not available yet. Your test keys already work with the API; this view will list the records they create as soon as the sandbox opens.” The page shows this whenever the practice environment does not answer a health check, or answers with a server error. It does not mean your account lacks access; your test keys still work for API calls whenever the sandbox is running.

​
Common questions

A kind of healthcare record. FHIR, the standard ClinikAPI is built on, defines types such as Patient, Encounter (a visit), Observation (a measurement) and Medication. Each has its own set of fields.
The page first checks that the practice environment is answering. If it is not (or has not opened yet for your project), it shows this message instead of an empty or broken table. Nothing is wrong with your keys. Try again later and check System status in the help menu.
Your key is a secret and the dashboard never stores it, only a fingerprint. So it cannot reuse it for you. The key is sent for that one request and then forgotten.
Live keys are not accepted here. The browser is limited to the sandbox so that real patient records can never be changed by accident from this screen.
Sandbox records not updated for 90 days are cleaned up automatically. See Sandbox rules.
Not in the Data browser. Use the API’s bulk operations; see Bulk operations.

​
Troubleshooting