Tross
Demo dataBook a demo
ECLINICALWORKS

Fetch chart catalog

List chart catalog categories for a section.

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-chart-catalog
Request Fields
input.keyName
string
required
ECW catalog key to fetch. Supported examples include Examination, HPI, ReviewOfSystems, SocialHistory, and Procedure.
Example
"JIG"
input.patientId
string
ECW patient identifier. Required when includeStructuredFields is true for HPI.
Example
"348144"
Default
""
input.encounterId
string
ECW encounter identifier. Required when includeStructuredFields is true for HPI.
Example
"9620412"
Default
""
input.categoryIds
array
HPI category IDs returned by this catalog. Required when includeStructuredFields is true.
Example
["455294","455291"]
input.includeStructuredFields
boolean
When true for keyName=HPI, include live structured HPI fields, dependencies, current values, and answer choices for categoryIds.
Example
false
Default
false
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
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).
Example
"330665"
categories[].name
string
Display label for the category node in ECW.
Example
"Jane Doe"
categories[].subcategories
array
Nested child category nodes under this category.
categories[].structuredFields
array
Live structured HPI fields for this category. Populated only when includeStructuredFields=true is requested for HPI.
categories[].structuredFields[].categoryId
string
Chart category for the section being written, from fetch-chart-catalog.
Example
"900101"
categories[].structuredFields[].propertyId
string
Structured HPI property for the field being answered, from structuredFields.
Example
"900201"
categories[].structuredFields[].detailId
string
Structured HPI question being answered, from the catalog's structuredFields.
Example
"900301"
categories[].structuredFields[].question
string
Text of the structured HPI question.
Example
"How long have symptoms been present?"
categories[].structuredFields[].type
string
Input type of the structured HPI field.
Example
"radio"
categories[].structuredFields[].mandatory
boolean
Whether this structured HPI field must be answered.
Example
true
categories[].structuredFields[].parentDetailId
string
Parent HPI field that this one hangs under.
Example
"900300"
categories[].structuredFields[].nodeLevel
integer
Depth of this field in the HPI question tree.
Example
1
categories[].structuredFields[].triggerValueId
string
Id of the answer that makes this field appear.
Example
"9001400"
categories[].structuredFields[].triggerValue
string
Parent answer that makes this field appear.
Example
"Yes"
categories[].structuredFields[].currentValue
string
Answer already recorded for this structured HPI question.
Example
"Several days"
categories[].structuredFields[].currentValueId
string
Identifier of that recorded answer, pairing with currentValue.
Example
"9001401"
categories[].structuredFields[].confidentialFlag
string
Marks this structured HPI field as confidential in eCW.
Example
"0"
categories[].structuredFields[].choices
array
Selectable values for this structured HPI question.
categories[].structuredFields[].choices[].value
string
Readable answer wording available for the structured question.
Example
"Several days"
categories[].structuredFields[].choices[].valueId
string
Chosen answer from the structured HPI field's list of choices.
Example
"9001401"
categories[].structuredFields[].choices[].abnormalFlag
string
Marks a structured HPI choice as clinically abnormal.
Example
"0"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-chart-catalog \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"keyName":"JIG","patientId":"348144","encounterId":"9620412","categoryIds":["455294","455291"],"includeStructuredFields":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "keyName": "JIG",
    "patientId": "348144",
    "encounterId": "9620412",
    "categoryIds": [
      "455294",
      "455291"
    ],
    "includeStructuredFields": false
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "categories": [
      {
        "id": "330665",
        "name": "Jane Doe",
        "subcategories": [
          {}
        ],
        "structuredFields": [
          {
            "categoryId": "900101",
            "propertyId": "900201",
            "detailId": "900301",
            "question": "How long have symptoms been present?",
            "type": "radio",
            "mandatory": true,
            "parentDetailId": "900300",
            "nodeLevel": 1,
            "triggerValueId": "9001400",
            "triggerValue": "Yes",
            "currentValue": "Several days",
            "currentValueId": "9001401",
            "confidentialFlag": "0",
            "choices": [
              {
                "value": "Several days",
                "valueId": "9001401",
                "abnormalFlag": "0"
              }
            ]
          }
        ]
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}