Netsmart Fetch patient

POSThttps://preview.ontross.com/api/integrations/netsmart/fetch-patient

input.patient_id

string

required

Compass NX client whose chart is read or written, from fetch-appointments.

Example

"433194"

input.system

string

Which Compass NX deployment to call, live or test.

Example

"PROD"

Default

"PROD"

Accepted values

PRODUAT

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"

string

Client identifier returned with the patient's demographics.

Example

"000999731"

name

string

Patient's name uppercased, surname first, as Compass NX stores it.

Example

"EXAMPLE, JAMIE"

firstName

string

Patient's given name in mixed case.

Example

"Jamie"

middleName

string

Patient's middle name, often an empty string.

Example

"Lee"

lastName

string

Patient's family name in mixed case.

Example

"Example"

suffix

string

Name suffix such as Jr, often empty.

Example

"Jr"

fullName

string

Surname first, mixed case, unlike the all-capitals name field.

Example

"Example, Jamie"

dob

string

Patient's date of birth in month, day, year order.

Example

"04/18/1988"

ssn

string

Patient's social security number, as Compass NX stores it.

Example

"000-00-0000"

address

object

Home address block Compass NX returns for the patient.

address.street

string

First line of the patient's street address.

Example

"123 Example Avenue"

address.street2

string

Second street address line, null when unused.

Example

"Apt 4B"

address.city

string

Town or city of the patient's address.

Example

"Columbus"

address.state

string

Two letter state code of the patient's address.

Example

"OH"

address.postalCode

string

ZIP code of the patient's address.

Example

"43215"

address.idNoLeadingZeros

string

Same identifier with its padding zeros stripped off.

Example

"999731"

phoneHome

string

Landline on file, null when none is recorded.

Example

"614-555-0142"

phoneMobile

string

Cell number on file, null when none is recorded.

Example

"614-555-0143"

phoneWork

string

Work number on file, null when none is recorded.

Example

"614-555-0144"

sex

string

Patient's sex spelled the way Compass NX spells it.

Example

"Female"

age

string

Patient's age in years, returned as a string.

Example

"38"

episodes

array

Care episodes on this chart, selectable when filing notes.

properties

object

Extra Compass NX chart fields passed through unmapped.

nameID

string

The uppercased name with the padded id in brackets.

Example

"EXAMPLE, JAMIE [000999731]"

idNoLeadingZeros

string

Same identifier with its padding zeros stripped off.

Example

"999731"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/netsmart/fetch-patient \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"system":"PROD","patient_id":"433194"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "system": "PROD",
    "patient_id": "433194"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "id": "000999731",
    "name": "EXAMPLE, JAMIE",
    "firstName": "Jamie",
    "middleName": "Lee",
    "lastName": "Example",
    "suffix": "Jr",
    "fullName": "Example, Jamie",
    "dob": "04/18/1988",
    "ssn": "000-00-0000",
    "address": {
      "street": "123 Example Avenue",
      "street2": "Apt 4B",
      "city": "Columbus",
      "state": "OH",
      "postalCode": "43215",
      "idNoLeadingZeros": "999731"
    },
    "phoneHome": "614-555-0142",
    "phoneMobile": "614-555-0143",
    "phoneWork": "614-555-0144",
    "sex": "Female",
    "age": "38",
    "episodes": [
      null
    ],
    "properties": {},
    "nameID": "EXAMPLE, JAMIE [000999731]",
    "idNoLeadingZeros": "999731"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}