Dental PMS

Definitions & Settings

57 endpoints

Codes

12 endpoints

get/api/v1/{org_id}/codes/explosion-codes

List Explosion Codes

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

searchstring
statusstring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/codes/explosion-codes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/codes/explosion-codes/{explosion_code_uuid}

Get Explosion Code

Parameters

Path Parameters
explosion_code_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
conditionsobject[]
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstring
entriesobject[]
idstring (uuid)required
namestringrequired
statusstringrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/codes/explosion-codes/{explosion_code_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/codes/icd-codes

List Icd Codes

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

searchstring
categorystring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/codes/icd-codes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/codes/icd-codes/{icd_code_uuid}

Get Icd Code

Parameters

Path Parameters
icd_code_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
categorystringrequired
codestringrequired
created_atstring (date-time)required
descriptionstringrequired
idstring (uuid)required
updated_atstring (date-time)required
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/codes/icd-codes/{icd_code_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/codes/procedure-codes

List procedure codes

List procedure codes (CDT/ADA + practice-custom) with optional filters. Staff callers receive the full ``ProcedureCodeListOut`` shape.

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

statusstring
searchstring
categorystring
code_typestring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/codes/procedure-codes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/codes/procedure-codes/{procedure_code_uuid}

Get procedure code

Retrieve a single procedure code by UUID. Staff callers receive the full ``ProcedureCodeOut`` shape.

Parameters

Path Parameters
procedure_code_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
apply_sales_taxbooleanrequired
categorystringrequired
codestringrequired
code_in_claimsstring
code_typestringrequired
created_atstring (date-time)required
default_billing_orderstringrequired
default_feestringrequired
deleted_atstring (date-time)
descriptionstringrequired
effective_datestring (date)
icd_code_mandatorybooleanrequired
idstring (uuid)required
is_orthobooleanrequired
labelstring
provider_mandatorybooleanrequired
provider_typestring
service_typestringrequired
short_namestringrequired
smart_code_logicbooleanrequired
statusstringrequired
termination_datestring (date)
under_eighteen_onlybooleanrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/codes/procedure-codes/{procedure_code_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/codes/explosion-codes

Create Explosion Code

Parameters

Path Parameters
org_idstringrequired

Request Body

conditionsobject[]
descriptionstring
entriesobject[]
namestringrequired

Responses

201Successful Response
conditionsobject[]
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstring
entriesobject[]
idstring (uuid)required
namestringrequired
statusstringrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/codes/explosion-codes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "conditions": null,
    "description": "string",
    "entries": null,
    "name": "string"
  }'
post/api/v1/{org_id}/codes/explosion-codes/{explosion_code_uuid}/archive

Archive Explosion Code

Parameters

Path Parameters
explosion_code_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
conditionsobject[]
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstring
entriesobject[]
idstring (uuid)required
namestringrequired
statusstringrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/codes/explosion-codes/{explosion_code_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/codes/procedure-codes

Create Procedure Code

Parameters

Path Parameters
org_idstringrequired

Request Body

apply_sales_taxboolean
categorystring
codestringrequired
code_in_claimsstring
code_typestring
default_billing_orderstring
default_feenumber
descriptionstring
effective_datestring (date)
icd_code_mandatoryboolean
is_orthoboolean
labelstring
provider_mandatoryboolean
provider_typestring
service_typestring
short_namestringrequired
smart_code_logicboolean
statusstring
termination_datestring (date)
under_eighteen_onlyboolean

Responses

201Successful Response
apply_sales_taxbooleanrequired
categorystringrequired
codestringrequired
code_in_claimsstring
code_typestringrequired
created_atstring (date-time)required
default_billing_orderstringrequired
default_feestringrequired
deleted_atstring (date-time)
descriptionstringrequired
effective_datestring (date)
icd_code_mandatorybooleanrequired
idstring (uuid)required
is_orthobooleanrequired
labelstring
provider_mandatorybooleanrequired
provider_typestring
service_typestringrequired
short_namestringrequired
smart_code_logicbooleanrequired
statusstringrequired
termination_datestring (date)
under_eighteen_onlybooleanrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/codes/procedure-codes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "apply_sales_tax": null,
    "category": "string",
    "code": "string",
    "code_in_claims": "string",
    "code_type": "string",
    "short_name": "string"
  }'
post/api/v1/{org_id}/codes/procedure-codes/{procedure_code_uuid}/archive

Archive Procedure Code

Parameters

Path Parameters
procedure_code_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
apply_sales_taxbooleanrequired
categorystringrequired
codestringrequired
code_in_claimsstring
code_typestringrequired
created_atstring (date-time)required
default_billing_orderstringrequired
default_feestringrequired
deleted_atstring (date-time)
descriptionstringrequired
effective_datestring (date)
icd_code_mandatorybooleanrequired
idstring (uuid)required
is_orthobooleanrequired
labelstring
provider_mandatorybooleanrequired
provider_typestring
service_typestringrequired
short_namestringrequired
smart_code_logicbooleanrequired
statusstringrequired
termination_datestring (date)
under_eighteen_onlybooleanrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/codes/procedure-codes/{procedure_code_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
patch/api/v1/{org_id}/codes/explosion-codes/{explosion_code_uuid}

Update Explosion Code

Parameters

Path Parameters
explosion_code_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
conditionsobject[]
descriptionstring
entriesobject[]
namestring
statusstring

Responses

200Successful Response
conditionsobject[]
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstring
entriesobject[]
idstring (uuid)required
namestringrequired
statusstringrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/codes/explosion-codes/{explosion_code_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "conditions": null,
    "description": "string",
    "entries": null,
    "name": "string"
  }'
patch/api/v1/{org_id}/codes/procedure-codes/{procedure_code_uuid}

Update Procedure Code

Parameters

Path Parameters
procedure_code_uuidstringrequired
org_idstringrequired

Request Body

apply_sales_taxboolean
base_versionintegerrequired
categorystring
codestring
code_in_claimsstring
code_typestring
default_billing_orderstring
default_feenumber
descriptionstring
effective_datestring (date)
icd_code_mandatoryboolean
is_orthoboolean
labelstring
provider_mandatoryboolean
provider_typestring
service_typestring
short_namestring
smart_code_logicboolean
statusstring
termination_datestring (date)
under_eighteen_onlyboolean

Responses

200Successful Response
apply_sales_taxbooleanrequired
categorystringrequired
codestringrequired
code_in_claimsstring
code_typestringrequired
created_atstring (date-time)required
default_billing_orderstringrequired
default_feestringrequired
deleted_atstring (date-time)
descriptionstringrequired
effective_datestring (date)
icd_code_mandatorybooleanrequired
idstring (uuid)required
is_orthobooleanrequired
labelstring
provider_mandatorybooleanrequired
provider_typestring
service_typestringrequired
short_namestringrequired
smart_code_logicbooleanrequired
statusstringrequired
termination_datestring (date)
under_eighteen_onlybooleanrequired
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/codes/procedure-codes/{procedure_code_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "apply_sales_tax": null,
    "base_version": 1,
    "category": "string",
    "code": "string",
    "code_in_claims": "string"
  }'

Definitions

9 endpoints

get/api/v1/{org_id}/definitions

List Definitions

Parameters

Path Parameters
org_idstringrequired
Query Parameters
categorystringrequired
pageinteger

Default: 1

page_sizeinteger

Default: 200

is_hiddenboolean
searchstring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/definitions/{definition_uuid}

Get Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
categorystringrequired
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenbooleanrequired
item_colorstring
item_namestringrequired
item_orderintegerrequired
item_valuestringrequired
metadataobject
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/definitions/transitions

List definition transitions

List allowed transitions between definitions in a category. Returns all active transitions with from/to definition names. Used for displaying transition rules in the settings UI.

Parameters

Path Parameters
org_idstringrequired
Query Parameters
categorystringrequired

Definition category to list transitions for.

Responses

200Successful Response
categorystringrequired
itemsobject[]required
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/definitions/transitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/definitions

Create Definition

Parameters

Path Parameters
org_idstringrequired

Request Body

categorystringrequired
item_colorstring
item_namestringrequired
item_orderinteger
item_valuestring
metadataobject

Responses

201Successful Response
categorystringrequired
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenbooleanrequired
item_colorstring
item_namestringrequired
item_orderintegerrequired
item_valuestringrequired
metadataobject
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "string",
    "item_color": "string",
    "item_name": "string",
    "item_order": 1,
    "item_value": ""
  }'
post/api/v1/{org_id}/definitions/{definition_uuid}/archive

Archive Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
categorystringrequired
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenbooleanrequired
item_colorstring
item_namestringrequired
item_orderintegerrequired
item_valuestringrequired
metadataobject
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/definitions/{definition_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/definitions/reorder

Reorder Definitions

Parameters

Path Parameters
org_idstringrequired

Request Body

categorystringrequired
ordered_uuidsstring (uuid)[]required

Responses

200Successful Response
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/definitions/reorder" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "string",
    "ordered_uuids": []
  }'
post/api/v1/{org_id}/definitions/reset-defaults

Reset Definitions

Parameters

Path Parameters
org_idstringrequired

Responses

200Successful Response
createdintegerrequired
hiddenintegerrequired
transitions_resetintegerrequired
updatedintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/definitions/reset-defaults" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
put/api/v1/{org_id}/definitions/transitions

Bulk-replace transitions

Bulk-replace all transitions for a definition category. Soft-deletes all existing transitions for the category, then creates new transitions from the provided pairs. Raises 422 if the category is invalid or any UUID cannot be resolved.

Parameters

Path Parameters
org_idstringrequired

Request Body

categorystringrequired

Definition category (e.g., 'LabCaseStatus').

transitionsobject[]required

Complete set of allowed transitions.

Responses

200Successful Response
categorystringrequired
itemsobject[]required
422Validation Error
detailobject[]
curl
curl -X PUT "https://api.example.com/api/v1/{org_id}/definitions/transitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "string",
    "transitions": []
  }'
patch/api/v1/{org_id}/definitions/{definition_uuid}

Update Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
is_hiddenboolean
item_colorstring
item_namestring
item_orderinteger
item_valuestring
metadataobject

Responses

200Successful Response
categorystringrequired
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenbooleanrequired
item_colorstring
item_namestringrequired
item_orderintegerrequired
item_valuestringrequired
metadataobject
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "is_hidden": null,
    "item_color": "string",
    "item_name": "string",
    "item_order": 1
  }'

Allergy Definitions

5 endpoints

get/api/v1/{org_id}/allergy-definitions

List Allergy Definitions

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

searchstring
is_hiddenboolean

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/allergy-definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/allergy-definitions/{definition_uuid}

Get Allergy Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstringrequired
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
snomed_typestringrequired
unii_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/allergy-definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/allergy-definitions

Create Allergy Definition

Parameters

Path Parameters
org_idstringrequired

Request Body

descriptionstringrequired
include_on_medical_historyboolean
is_hiddenboolean
is_medical_alertboolean
is_permanentboolean
item_orderinteger
snomed_codestring
snomed_typestring
unii_codestring

Responses

201Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstringrequired
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
snomed_typestringrequired
unii_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/allergy-definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "include_on_medical_history": true,
    "is_hidden": false,
    "is_medical_alert": false,
    "is_permanent": false
  }'
post/api/v1/{org_id}/allergy-definitions/{definition_uuid}/archive

Archive Allergy Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstringrequired
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
snomed_typestringrequired
unii_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/allergy-definitions/{definition_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1
  }'
patch/api/v1/{org_id}/allergy-definitions/{definition_uuid}

Update Allergy Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
descriptionstring
include_on_medical_historyboolean
is_hiddenboolean
is_medical_alertboolean
is_permanentboolean
item_orderinteger
snomed_codestring
snomed_typestring
unii_codestring

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
descriptionstringrequired
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
snomed_typestringrequired
unii_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/allergy-definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "description": "string",
    "include_on_medical_history": null,
    "is_hidden": null,
    "is_medical_alert": null
  }'

Disease Definitions

5 endpoints

get/api/v1/{org_id}/disease-definitions

List Disease Definitions

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

searchstring
is_hiddenboolean

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/disease-definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/disease-definitions/{definition_uuid}

Get Disease Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
categorystring
created_atstring (date-time)required
deleted_atstring (date-time)
disease_namestringrequired
icd10_codestring
icd9_codestring
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/disease-definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/disease-definitions

Create Disease Definition

Parameters

Path Parameters
org_idstringrequired

Request Body

categorystring
disease_namestringrequired
icd10_codestring
icd9_codestring
include_on_medical_historyboolean
is_hiddenboolean
is_medical_alertboolean
is_permanentboolean
item_orderinteger
snomed_codestring

Responses

201Successful Response
categorystring
created_atstring (date-time)required
deleted_atstring (date-time)
disease_namestringrequired
icd10_codestring
icd9_codestring
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/disease-definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "string",
    "disease_name": "string",
    "icd10_code": "string",
    "icd9_code": "string",
    "include_on_medical_history": true
  }'
post/api/v1/{org_id}/disease-definitions/{definition_uuid}/archive

Archive Disease Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired

Responses

200Successful Response
categorystring
created_atstring (date-time)required
deleted_atstring (date-time)
disease_namestringrequired
icd10_codestring
icd9_codestring
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/disease-definitions/{definition_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1
  }'
patch/api/v1/{org_id}/disease-definitions/{definition_uuid}

Update Disease Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
categorystring
disease_namestring
icd10_codestring
icd9_codestring
include_on_medical_historyboolean
is_hiddenboolean
is_medical_alertboolean
is_permanentboolean
item_orderinteger
snomed_codestring

Responses

200Successful Response
categorystring
created_atstring (date-time)required
deleted_atstring (date-time)
disease_namestringrequired
icd10_codestring
icd9_codestring
idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
snomed_codestring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/disease-definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "category": "string",
    "disease_name": "string",
    "icd10_code": "string",
    "icd9_code": "string"
  }'

Medication Definitions

5 endpoints

get/api/v1/{org_id}/medication-definitions

List Medication Definitions

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

searchstring
is_hiddenboolean

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/medication-definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/medication-definitions/{definition_uuid}

Get Medication Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
generic_definitionobject

Lightweight reference to a related entity — exposes UUID and optional name.

idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
medication_namestringrequired
notesstring
rx_cuistring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/medication-definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/medication-definitions

Create Medication Definition

Parameters

Path Parameters
org_idstringrequired

Request Body

generic_definition_uuidstring (uuid)
include_on_medical_historyboolean
is_hiddenboolean
is_medical_alertboolean
is_permanentboolean
item_orderinteger
medication_namestringrequired
notesstring
rx_cuistring

Responses

201Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
generic_definitionobject

Lightweight reference to a related entity — exposes UUID and optional name.

idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
medication_namestringrequired
notesstring
rx_cuistring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/medication-definitions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "generic_definition_uuid": "string",
    "include_on_medical_history": true,
    "is_hidden": false,
    "is_medical_alert": false,
    "is_permanent": false,
    "medication_name": "string"
  }'
post/api/v1/{org_id}/medication-definitions/{definition_uuid}/archive

Archive Medication Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
generic_definitionobject

Lightweight reference to a related entity — exposes UUID and optional name.

idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
medication_namestringrequired
notesstring
rx_cuistring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/medication-definitions/{definition_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1
  }'
patch/api/v1/{org_id}/medication-definitions/{definition_uuid}

Update Medication Definition

Parameters

Path Parameters
definition_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
generic_definition_uuidstring (uuid)
include_on_medical_historyboolean
is_hiddenboolean
is_medical_alertboolean
is_permanentboolean
item_orderinteger
medication_namestring
notesstring
rx_cuistring

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
generic_definitionobject

Lightweight reference to a related entity — exposes UUID and optional name.

idstring (uuid)required
include_on_medical_historyboolean
is_hiddenbooleanrequired
is_medical_alertboolean
is_permanentboolean
item_orderintegerrequired
medication_namestringrequired
notesstring
rx_cuistring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/medication-definitions/{definition_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "generic_definition_uuid": "string",
    "include_on_medical_history": null,
    "is_hidden": null,
    "is_medical_alert": null
  }'

Location Groups

15 endpoints

get/api/v1/{org_id}/location-groups/divisions

List Divisions

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

statusstring
searchstring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/location-groups/divisions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/location-groups/divisions/{division_uuid}

Get Division

Parameters

Path Parameters
division_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
namestringrequired
regionsobject[]
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/location-groups/divisions/{division_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/location-groups/groups

List Location Groups

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

statusstring
searchstring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/location-groups/groups" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/location-groups/groups/{group_uuid}

Get Location Group

Parameters

Path Parameters
group_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
zip_rangesobject[]
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/location-groups/groups/{group_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/location-groups/regions

List Regions

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 50

statusstring
searchstring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/location-groups/regions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/location-groups/regions/{region_uuid}

Get Region

Parameters

Path Parameters
region_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/location-groups/regions/{region_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/location-groups/divisions

Create Division

Parameters

Path Parameters
org_idstringrequired

Request Body

namestringrequired
region_uuidsstring (uuid)[]

Responses

201Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
namestringrequired
regionsobject[]
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/location-groups/divisions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "region_uuids": []
  }'
post/api/v1/{org_id}/location-groups/divisions/{division_uuid}/archive

Archive Division

Parameters

Path Parameters
division_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
namestringrequired
regionsobject[]
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/location-groups/divisions/{division_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/location-groups/groups

Create Location Group

Parameters

Path Parameters
org_idstringrequired

Request Body

location_uuidsstring (uuid)[]
namestringrequired
zip_rangesobject[]

Responses

201Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
zip_rangesobject[]
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/location-groups/groups" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "location_uuids": [],
    "name": "string",
    "zip_ranges": []
  }'
post/api/v1/{org_id}/location-groups/groups/{group_uuid}/archive

Archive Location Group

Parameters

Path Parameters
group_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
zip_rangesobject[]
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/location-groups/groups/{group_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/location-groups/regions

Create Region

Parameters

Path Parameters
org_idstringrequired

Request Body

location_uuidsstring (uuid)[]
namestringrequired

Responses

201Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/location-groups/regions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "location_uuids": [],
    "name": "string"
  }'
post/api/v1/{org_id}/location-groups/regions/{region_uuid}/archive

Archive Region

Parameters

Path Parameters
region_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/location-groups/regions/{region_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
patch/api/v1/{org_id}/location-groups/divisions/{division_uuid}

Update Division

Parameters

Path Parameters
division_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
namestring
region_uuidsstring (uuid)[]

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
namestringrequired
regionsobject[]
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/location-groups/divisions/{division_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "name": "string",
    "region_uuids": null
  }'
patch/api/v1/{org_id}/location-groups/groups/{group_uuid}

Update Location Group

Parameters

Path Parameters
group_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
location_uuidsstring (uuid)[]
namestring
zip_rangesobject[]

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
zip_rangesobject[]
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/location-groups/groups/{group_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "location_uuids": null,
    "name": "string",
    "zip_ranges": null
  }'
patch/api/v1/{org_id}/location-groups/regions/{region_uuid}

Update Region

Parameters

Path Parameters
region_uuidstringrequired
org_idstringrequired

Request Body

base_versionintegerrequired
location_uuidsstring (uuid)[]
namestring

Responses

200Successful Response
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
item_orderinteger
locationsobject[]
namestringrequired
statusstring
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/location-groups/regions/{region_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "location_uuids": null,
    "name": "string"
  }'

Operatories

6 endpoints

get/api/v1/{org_id}/operatories

List operatories

List operatories with optional filters. Staff callers receive the full ``OperatoryListOut`` shape.

Parameters

Path Parameters
org_idstringrequired
Query Parameters
pageinteger

Default: 1

page_sizeinteger

Default: 100

location_idstring
is_hiddenboolean
searchstring

Responses

200Successful Response
itemsobject[]required
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/operatories" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/operatories/{operatory_uuid}

Get operatory by ID

Retrieve a single operatory by UUID. Staff callers receive the full ``OperatoryOut`` shape.

Parameters

Path Parameters
operatory_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
abbreviationstring
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenboolean
is_hygieneboolean
item_orderinteger
locationobjectrequired

Lightweight reference to a related entity — exposes UUID and optional name.

namestringrequired
operatory_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_dentistobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_hygienistobject

Lightweight reference to a related entity — exposes UUID and optional name.

set_prospectiveboolean
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/operatories/{operatory_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
get/api/v1/{org_id}/operatories/available-for-slot

List available operatories for a time slot

Return operatories that can safely receive the requested appointment slot. This endpoint deliberately exposes the PMS-owned scheduling decision as a non-PHI resolver capability. Agent-MS should use this instead of parsing raw calendar rows or choosing a room from a generic operatory list.

Parameters

Path Parameters
org_idstringrequired
Query Parameters
location_uuidstringrequired

Location UUID for the appointment slot.

schedule_datestringrequired

Local calendar date of the appointment slot.

start_timestringrequired

Local wall-clock slot start time.

end_timestringrequired

Local wall-clock slot end time.

appointment_type_uuidstring

Optional appointment type UUID used for blockout compatibility checks.

searchstring

Optional operatory name search.

pageinteger

Default: 1

page_sizeinteger

Default: 100

Responses

200Successful Response
itemsobject[]required

Provider-ranked operatories available for the requested slot.

pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
422Validation Error
detailobject[]
curl
curl -X GET "https://api.example.com/api/v1/{org_id}/operatories/available-for-slot" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
post/api/v1/{org_id}/operatories

Create Operatory

Parameters

Path Parameters
org_idstringrequired

Request Body

abbreviationstring
is_hiddenboolean
is_hygieneboolean
item_orderinteger
location_uuidstring (uuid)required
namestringrequired
operatory_type_uuidstring (uuid)
provider_dentist_uuidstring (uuid)
provider_hygienist_uuidstring (uuid)
set_prospectiveboolean

Responses

201Successful Response
abbreviationstring
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenboolean
is_hygieneboolean
item_orderinteger
locationobjectrequired

Lightweight reference to a related entity — exposes UUID and optional name.

namestringrequired
operatory_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_dentistobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_hygienistobject

Lightweight reference to a related entity — exposes UUID and optional name.

set_prospectiveboolean
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/operatories" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abbreviation": "string",
    "is_hidden": null,
    "is_hygiene": null,
    "item_order": 1,
    "location_uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  }'
post/api/v1/{org_id}/operatories/{operatory_uuid}/archive

Archive Operatory

Parameters

Path Parameters
operatory_uuidstringrequired
org_idstringrequired

Responses

200Successful Response
abbreviationstring
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenboolean
is_hygieneboolean
item_orderinteger
locationobjectrequired

Lightweight reference to a related entity — exposes UUID and optional name.

namestringrequired
operatory_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_dentistobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_hygienistobject

Lightweight reference to a related entity — exposes UUID and optional name.

set_prospectiveboolean
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X POST "https://api.example.com/api/v1/{org_id}/operatories/{operatory_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
patch/api/v1/{org_id}/operatories/{operatory_uuid}

Update Operatory

Parameters

Path Parameters
operatory_uuidstringrequired
org_idstringrequired

Request Body

abbreviationstring
base_versionintegerrequired
is_hiddenboolean
is_hygieneboolean
item_orderinteger
location_uuidstring (uuid)
namestring
operatory_type_uuidstring (uuid)
provider_dentist_uuidstring (uuid)
provider_hygienist_uuidstring (uuid)
set_prospectiveboolean

Responses

200Successful Response
abbreviationstring
created_atstring (date-time)required
deleted_atstring (date-time)
idstring (uuid)required
is_hiddenboolean
is_hygieneboolean
item_orderinteger
locationobjectrequired

Lightweight reference to a related entity — exposes UUID and optional name.

namestringrequired
operatory_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_dentistobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_hygienistobject

Lightweight reference to a related entity — exposes UUID and optional name.

set_prospectiveboolean
updated_atstring (date-time)required
versionintegerrequired
422Validation Error
detailobject[]
curl
curl -X PATCH "https://api.example.com/api/v1/{org_id}/operatories/{operatory_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abbreviation": "string",
    "base_version": 1,
    "is_hidden": null,
    "is_hygiene": null,
    "item_order": 1
  }'