Document Answer

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

The document answer model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the document answer.

  • Name
    object
    Type
    string
    Description

    Always 'document_answer'.

  • Name
    question
    Type
    string
    Description

    Corresponding document template version question.

  • Name
    patient
    Type
    string
    Description

    Patient this document answer is for.

  • Name
    type
    Type
    string
    Description

    Type of document template version answer.

    Possible values:
    multipleChoice
    dropdown
    shortAnswer
    grid
    number
    paragraph
    date
    time
    picture
    file
    statement
    consent
    ssn
    address
    insurance
    ICDCodes
    CPTCodes
    editor
    setupPayment
    preferredPharmacy
    allergy
    medication
    scheduledMedication
    vitals
    familyHistory
  • Name
    line1
    Type
    string
    Description

    Only applies to address questions. Line 1 field of the address.

  • Name
    line2
    Type
    string
    Description

    Only applies to address questions. Line 2 field of the address.

  • Name
    city
    Type
    string
    Description

    Only applies to address questions. City field of the address.

  • Name
    state
    Type
    string
    Description

    Only applies to address questions. State field of the address.

  • Name
    postal_code
    Type
    string
    Description

    Only applies to address questions. Postal code field of the address.

  • Name
    country
    Type
    string
    Description

    Only applies to address questions. Country field of the address.

  • Name
    address
    Type
    string
    Description

    Only applies to address questions. Address object shown on the patient panel that responses are synced with.

  • Name
    allergies
    Type
    array of objects
    Description

    Only applies to allergies question.

  • Name
    name
    Type
    string
    Description

    Only applies to consent questions. Name of user giving the consent.

  • Name
    e_sign_consent_given
    Type
    boolean
    Description

    Only applies to consent questions. Whether user has given consent that their electronic signatures is the legal equivalent of their manual/handwritten signature and they consent to be legally bound to this agreement.

  • Name
    signature
    Type
    string
    Description

    Only applies to consent questions. Base64 string of signature.

  • Name
    date
    Type
    number
    Description

    Only applies to consent questions. Date when consent was given.

  • Name
    codes
    Type
    array of strings
    Description

    Only applies to ICD code and CPT code questions. Selected ICD and CPT codes.

  • Name
    month
    Type
    number
    Description

    Only applies to date questions. Month field in date.

  • Name
    day
    Type
    number
    Description

    Only applies to date questions. Day field in date.

  • Name
    year
    Type
    number
    Description

    Only applies to year questions. Year field in date.

  • Name
    response
    Type
    string
    Description

    Only applies to dropdown, editor, grid, multiple choice, number, paragraph, short answer, and SSN questions. For dropdown and multiple choice, only applies when allow multi-select is not selected. Response to question.

  • Name
    score
    Type
    number
    Description

    Only applies to dropdown and multiple choice questions. Score patient receives for this answer based on their response.

  • Name
    filename
    Type
    string
    Description

    Only applies to file questions. Name of file.

  • Name
    policyholder
    Type
    object
    Description

    Only applies to insurance questions. Policyholder of insurance policy.

  • Name
    insurance_card
    Type
    object
    Description

    Only applies to insurance questions. Insurance card details.

  • Name
    policy_type
    Type
    string
    Description

    Only applies to insurance questions. Whether this insurance policy, is the primary, secondary, tertirary, or inactive policy for the patient. Each patient can only have primary policy, one secondary policy, and one tertiary policy.

    Possible values:
    primary
    secondary
    tertiary
    inactive
  • Name
    insurance_policy
    Type
    string
    Description

    Only applies to insurance questions. Insurance policy object shown on the patient panel that responses are synced with.

  • Name
    medications
    Type
    array of objects
    Description

    Only applies to medications questions.

  • Name
    responses
    Type
    array of strings
    Description

    Only applies to dropdown and multiple choice questions, when allow multi-select has been selected. List of responses to the question.

  • Name
    other_field_response
    Type
    string
    Description

    Only applies to multiple choice questions. Custom answer inputted to question.

  • Name
    pharmacy
    Type
    string
    Description

    Only applies to preferred pharmacy questions. Preferred pharmacy selected.

  • Name
    task
    Type
    string
    Description

    Only applies to task questions. Task object shown under tasks tab that responses are synced with.

  • Name
    time
    Type
    string|undefined
    Description

    Only applies to time questions. Time in format "hh:mm"

  • Name
    height
    Type
    number
    Description

    Only applies to vitals questions. Height field in vitals.

  • Name
    weight
    Type
    number
    Description

    Only applies to vitals questions. Weight field in vitals.

  • Name
    blood_pressure
    Type
    object
    Description

    Only applies to vitals questions. Blood pressure field in vitals.

  • Name
    temperature
    Type
    number
    Description

    Only applies to vitals questions. Temperature field in vitals.

  • Name
    pulse
    Type
    number
    Description

    Only applies to vitals questions. Pulse field in vitals.

  • Name
    respiratory_rate
    Type
    number
    Description

    Only applies to vitals questions. Respiratory rate field in vitals.

  • Name
    oxygen_saturation
    Type
    number
    Description

    Only applies to vitals questions. Oxygen saturation field in vitals.

  • Name
    pain
    Type
    number
    Description

    Only applies to vitals questions. Pain field in vitals.

  • Name
    vitals
    Type
    string
    Description

    Only applies to vitals questions. Vitals object shown in the patient panel that responses are synced with.

Response

{
    "id": "dans_U8xtAULYUrX7GVsTKePy",
    "object": "document_answer",
    "document": "doc_841JtjV1QEYFv395Hl7h",
    "question": "dqst_1JtjV1QEY84Fv395Hl7h",
    "patient": "user_3951JtjV1QEY84FvHl7h",
    "response": "Sally Chen"
}


GET/v1/document_answers/:id

Retrieve a document answer

Retrieves the specified document answer.

Response

{
   "id": "dans_U8xtAULYUrX7GVsTKePy",
   "object": "document_answer",
   "document": "doc_841JtjV1QEYFv395Hl7h",
   "question": "dqst_1JtjV1QEY84Fv395Hl7h",
   "patient": "user_3951JtjV1QEY84FvHl7h",
   "response": "Sally Chen"
}


POST/v1/document_answers/:id

Update a document answer

Updates the specified document 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": "dans_U8xtAULYUrX7GVsTKePy",
        "object": "document_answer",
        "document": "doc_841JtjV1QEYFv395Hl7h",
        "question": "dqst_1JtjV1QEY84Fv395Hl7h",
        "patient": "user_3951JtjV1QEY84FvHl7h",
        "response": "Sally Chen"
    }
    

    GET/v1/document_answers

    List all document answers

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

    Optional query parameters

    • Name
      patient
      Type
      string
      Description

      Patient to filter by.

    • Name
      document
      Type
      string
      Description

      Document to filter by.

    Request

    GET
    /v1/document_answers
    curl https://{{base_subdomain}}.avonhealth.com/v1/document_answers?patient=user_Z1zJXZKvqrpwxbznuW6l&document=document_841JtjV1QEYFv395Hl7h \
      -H "Authorization: Bearer {{token}}" \
      -H "x-jwt: {{jwt}}"
    

    Response

    {
      "object": "list",
      "data": [{
        "id": "dans_U8xtAULYUrX7GVsTKePy",
        "object": "document_answer",
        "document": "doc_841JtjV1QEYFv395Hl7h",
        "question": "dqst_1JtjV1QEY84Fv395Hl7h",
        "patient": "user_3951JtjV1QEY84FvHl7h",
        "response": "Sally Chen"
      }]
    }