Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.verial.ai/llms.txt

Use this file to discover all available pages before exploring further.

Manage datasets containing patient records, FHIR bundles, or file sets that populate simulators.

Actions

ActionDescription
listList all datasets in the organization
createCreate a new dataset
getGet a dataset by ID
updateUpdate a dataset
deleteDelete a dataset

Parameters

list

No parameters.

create

ParameterTypeRequiredDescription
namestringyesName of the dataset
descriptionstringnoDescription of the dataset
typestringnoDataset type: FHIR or Files
dataunknownnoDataset contents (FHIR bundle, file references, etc.)
configobjectnoDataset configuration

get

ParameterTypeRequiredDescription
idstringyesDataset ID

update

ParameterTypeRequiredDescription
idstringyesDataset ID
namestringnoUpdated name
descriptionstring | nullnoUpdated description, or null to clear
dataunknownnoUpdated dataset contents
configobject | nullnoUpdated config, or null to clear

delete

ParameterTypeRequiredDescription
idstringyesDataset ID

Examples

Create a FHIR patient dataset

{
  "action": "create",
  "name": "Prior Auth Patients",
  "description": "Patients requiring prior authorization for imaging",
  "type": "FHIR",
  "data": {
    "resourceType": "Bundle",
    "type": "collection",
    "entry": [
      {
        "resource": {
          "resourceType": "Patient",
          "name": [{ "family": "Chen", "given": ["Maria"] }],
          "birthDate": "1985-03-14"
        }
      }
    ]
  }
}

List all datasets

{
  "action": "list"
}

Get a dataset by ID

{
  "action": "get",
  "id": "ds_abc123"
}