Note Answer

The note answers contains information about an answer in a note.

The note answer model

Properties

Name
id
Type
string
Description
Unique identifier for the note answer.
Name
object
Type
string
Description
Always 'note_answer'.
Name
question
Type
string
Description
Corresponding note template version question.
Name
patient
Type
string
Description
Patient this note answer is for.
Name
line1
Type
string
Description
Name
line2
Type
string
Description
Name
city
Type
string
Description
Name
state
Type
string
Description
Name
postal_code
Type
string
Description
Name
country
Type
string
Description
Name
address
Type
string
Description
Name
allergies
Type
array of objects
Description
Name
name
Type
string
Description
Name
e_sign_consent_given
Type
boolean
Description
Name
signature_url
Type
string
Description
Name
date
Type
number
Description
Name
codes
Type
array of strings
Description
Name
month
Type
number
Description
Name
day
Type
number
Description
Name
year
Type
number
Description
Name
response
Type
string
Description
Name
score
Type
number
Description
Name
filename
Type
string
Description
Name
policyholder
Type
object
Description
Name
insurance_card
Type
object
Description
Name
type
Type
string
Description
Possible values:
primary
secondary
tertiary
inactive
Name
insurance_policy
Type
string
Description
Name
medications
Type
array of objects
Description
Name
responses
Type
array of strings
Description
Name
other_field_response
Type
string
Description
Name
pharmacy
Type
string
Description
Name
task
Type
string
Description
Name
time
Type
number
Description
Name
height
Type
number
Description
Name
weight
Type
number
Description
Name
blood_pressure
Type
object
Description
Name
temperature
Type
number
Description
Name
pulse
Type
number
Description
Name
respiratory_rate
Type
number
Description
Name
oxygen_saturation
Type
number
Description
Name
pain
Type
number
Description
Name
vitals
Type
string
Description

Response

{
    "id": "nans_U8xtAULYUrX7GVsTKePy",
    "object": "note_answer",
    "note": "note_841JtjV1QEYFv395Hl7h",
    "question": "nqst_1JtjV1QEY84Fv395Hl7h",
    "patient": "user_3951JtjV1QEY84FvHl7h",
    "response": "Sally Chen"
}

GET/v2/note_answers/:id

Retrieve a note answer

Retrieves the specified note answer.

Response

{
   "id": "nans_U8xtAULYUrX7GVsTKePy",
   "object": "note_answer",
   "note": "note_841JtjV1QEYFv395Hl7h",
   "question": "nqst_1JtjV1QEY84Fv395Hl7h",
   "patient": "user_3951JtjV1QEY84FvHl7h",
   "response": "Sally Chen"
}

POST/v2/note_answers/:id

Update a note answer

Updates the specified note answer object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

Optional attributes

Name
line1
Type
string
Description
Name
line2
Type
string
Description
Name
city
Type
string
Description
Name
state
Type
string
Description
Name
postal_code
Type
string
Description
Name
country
Type
string
Description
Name
address
Type
string
Description
Name
allergies
Type
array of objects
Description
Name
name
Type
string
Description
Name
e_sign_consent_given
Type
boolean
Description
Name
signature_url
Type
string
Description
Name
date
Type
number
Description
Name
codes
Type
array of strings
Description
Name
month
Type
number
Description
Name
day
Type
number
Description
Name
year
Type
number
Description
Name
response
Type
string
Description
Name
score
Type
number
Description
Name
filename
Type
string
Description
Name
policyholder
Type
object
Description
Name
insurance_card
Type
object
Description
Name
type
Type
string
Description
Possible values:
primary
secondary
tertiary
inactive
Name
insurance_policy
Type
string
Description
Name
medications
Type
array of objects
Description
Name
responses
Type
array of strings
Description
Name
other_field_response
Type
string
Description
Name
pharmacy
Type
string
Description
Name
task
Type
string
Description
Name
time
Type
number
Description
Name
height
Type
number
Description
Name
weight
Type
number
Description
Name
blood_pressure
Type
object
Description
Name
temperature
Type
number
Description
Name
pulse
Type
number
Description
Name
respiratory_rate
Type
number
Description
Name
oxygen_saturation
Type
number
Description
Name
pain
Type
number
Description
Name
vitals
Type
string
Description

Response

{
    "id": "nans_U8xtAULYUrX7GVsTKePy",
    "object": "note_answer",
    "note": "note_841JtjV1QEYFv395Hl7h",
    "question": "nqst_1JtjV1QEY84Fv395Hl7h",
    "patient": "user_3951JtjV1QEY84FvHl7h",
    "response": "Sally Chen"
}

GET/v2/note_answers

List all note answers

Returns a list of all note answers. Pass attributes to filter the list of note answers based on that criteria.

Optional query parameters

Name
patient
Type
string
Description
Patient to filter by.
Name
note
Type
string
Description
Note to filter by.

Request

GET

/v2/note_answers

curl https://{{base_subdomain}}.avonhealth.com/v2/note_answers?patient=user_Z1zJXZKvqrpwxbznuW6l&note=note_841JtjV1QEYFv395Hl7h \
  -H "Authorization: Bearer {{token}}" \
  -H "x-jwt: {{jwt}}"

Response

{
  "object": "list",
  "data": [{
    "id": "nans_U8xtAULYUrX7GVsTKePy",
    "object": "note_answer",
    "note": "note_841JtjV1QEYFv395Hl7h",
    "question": "nqst_1JtjV1QEY84Fv395Hl7h",
    "patient": "user_3951JtjV1QEY84FvHl7h",
    "response": "Sally Chen"
  }]
}