Ecw Write structured hpi

POSThttps://preview.ontross.com/api/integrations/ecw/write-structured-hpi

input.patientId

string

required

Patient chart being read or written, from fetch-patients.

Example

"407069"

input.encounterId

string

required

Encounter being read or written, from fetch-appointments.

Example

"1870494"

input.answers

array

required

Structured HPI selections, each naming category, property, detail, and value.

input.answers[].categoryId

string

required

Chart category for the section being written, from fetch-chart-catalog.

Example

"455294"

input.answers[].propertyId

string

required

Structured HPI property for the field being answered, from structuredFields.

Example

"813007"

input.answers[].detailId

string

required

Structured HPI question being answered, from the catalog's structuredFields.

Example

"993140"

input.answers[].valueId

string

required

Chosen answer from the structured HPI field's list of choices.

Example

"4731885"

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"

writeSuccess

boolean

Whether eCW accepted the chart write.

Example

true

answers

array

Structured HPI selections, each naming category, property, detail, and value.

answers[].categoryId

string

Chart category for the section being written, from fetch-chart-catalog.

Example

"900101"

answers[].propertyId

string

Structured HPI property for the field being answered, from structuredFields.

Example

"900201"

answers[].detailId

string

Structured HPI question being answered, from the catalog's structuredFields.

Example

"900301"

answers[].valueId

string

Chosen answer from the structured HPI field's list of choices.

Example

"9001401"

answers[].question

string

Text of the structured HPI question.

Example

"How long have symptoms been present?"

answers[].value

string

Readable answer wording associated with the submitted selection.

Example

"Several days"

answers[].saved

boolean

Whether eCW saved this one HPI answer.

Example

true

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/write-structured-hpi \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","encounterId":"1870494","answers":[{"categoryId":"455294","detailId":"993140","propertyId":"813007","valueId":"4731885"}]},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "answers": [
      {
        "categoryId": "455294",
        "detailId": "993140",
        "propertyId": "813007",
        "valueId": "4731885"
      }
    ]
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "writeSuccess": true,
    "answers": [
      {
        "categoryId": "900101",
        "propertyId": "900201",
        "detailId": "900301",
        "valueId": "9001401",
        "question": "How long have symptoms been present?",
        "value": "Several days",
        "saved": true
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}