Tross
ECLINICALWORKS

Fetch Chart Catalog

Fetch chart catalog in eClinicalWorks

POSThttps://api.ontross.com/api/integrations/ecw/fetch-chart-catalog
Request Fields
input
object
required
Input object.
input.keyName
string
required
ECW catalog key to fetch. Supported examples include Examination, HPI, ReviewOfSystems, SocialHistory, and Procedure.
input.patientId
string
ECW patient identifier. Required when includeStructuredFields is true for HPI.
Default
""
input.encounterId
string
ECW encounter identifier. Required when includeStructuredFields is true for HPI.
Default
""
input.categoryIds
array
HPI category IDs returned by this catalog. Required when includeStructuredFields is true.
input.includeStructuredFields
boolean
When true for keyName=HPI, include live structured HPI fields, dependencies, current values, and answer choices for categoryIds.
Default
false
auth_id
string
required
Auth id
Output Fields
categories
array
Top-level catalog categories for the requested keyName, each with nested subcategories.
categories[].id
string
ECW category node identifier. Use this as the category id in write APIs (for example categoryId/catId depending on endpoint).
categories[].name
string
Display label for the category node in ECW.
categories[].subcategories
array
Nested child category nodes under this category.
categories[].structuredFields
array
List of structured Fields.
categories[].structuredFields[].categoryId
string
Category id
categories[].structuredFields[].propertyId
string
Property id
categories[].structuredFields[].detailId
string
Detail id
categories[].structuredFields[].question
string
Question
categories[].structuredFields[].type
string
Type
categories[].structuredFields[].mandatory
boolean
Mandatory
categories[].structuredFields[].parentDetailId
string
Parent detail id
categories[].structuredFields[].nodeLevel
integer
Node level
categories[].structuredFields[].triggerValueId
string
Trigger value id
categories[].structuredFields[].triggerValue
string
Trigger value
categories[].structuredFields[].currentValue
string
Current value
categories[].structuredFields[].currentValueId
string
Current value id
categories[].structuredFields[].confidentialFlag
string
Confidential flag
categories[].structuredFields[].choices
array
List of choices.
categories[].structuredFields[].choices[].value
string
Value
categories[].structuredFields[].choices[].valueId
string
Value id
categories[].structuredFields[].choices[].abnormalFlag
string
Abnormal flag
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ecw/fetch-chart-catalog \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"keyName":"Examination","patientId":"string_id","encounterId":"string_id","categoryIds":[],"includeStructuredFields":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "keyName": "Examination",
    "patientId": "string_id",
    "encounterId": "string_id",
    "categoryIds": [],
    "includeStructuredFields": false
  },
  "auth_id": "auth_uuid_here"
}