Athena Prod Fetch needs

POSThttps://preview.ontross.com/api/integrations/athena-prod/fetch-needs

input.org_id

integer

required

Practice context, shown in the athenanet portal URL.

Example

25910

input.department_id

integer

required

Department the session opens, shown in the portal URL.

Example

1

input.patient_id

integer

required

Patient whose chart is read or written, from the chart URL.

Example

1

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"

needs

array

SNOMED barrier catalog scraped from Athena's front-end bundle.

needs[].SnomedCode

string

Barrier SNOMED code, copied unchanged from fetch-needs.

Example

"105419003"

needs[].SnomedDescription

string

Barrier wording Athena stores as the observation summary.

Example

"Academic underachievement"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/fetch-needs \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":25910,"department_id":1,"patient_id":1},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "org_id": 25910,
    "department_id": 1,
    "patient_id": 1
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "needs": [
      {
        "SnomedCode": "105419003",
        "SnomedDescription": "Academic underachievement"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}