Visit Note

A visit note documents the interaction that a provider had with a patient and contains a summary of the most important information discussed.

The visit note model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the note.

  • Name
    object
    Type
    string
    Description

    Always 'note'.

  • Name
    note_template
    Type
    string
    Description

    Template this note is based on.

  • Name
    note_template_version
    Type
    string
    Description

    Template version this note is based on.

  • Name
    patient
    Type
    string
    Description

    Patient this note is for.

  • Name
    sections
    Type
    array of strings
    Description

    List of sections in the note.

  • Name
    score
    Type
    number
    Description

    Score of the note.

  • Name
    appointment
    Type
    string
    Description

    Appointment this note is associated with.

  • Name
    insurance_claim
    Type
    string
    Description

    Insurance claim this note is associated with.

  • Name
    name
    Type
    string
    Description

    Name of the note.

  • Name
    share_with_patient
    Type
    boolean
    Description

    Whether this note should be shared with the patient.

  • Name
    sections
    Type
    array of strings
    Description

    List of sections in the note.

  • Name
    comments
    Type
    array of strings
    Description

    List of comments added to the note.

  • Name
    addendums
    Type
    array of strings
    Description

    List of addendums appended to the note after the note has been signed and locked.

  • Name
    reviews
    Type
    array of objects
    Description
    Review history of the note.
  • Name
    signers
    Type
    array of objects
    Description
    Signing history of the note.
  • Name
    created_by
    Type
    string
    Description

    Creator of the note.

  • Name
    created_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the note was created.

  • Name
    last_updated_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the note was last updated.

Response

{
    "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",

    "type": "template",
    "note_template": "dtmp_NOIYLBGOBNhSwTWCUzfu",
    "note_template_version": "dtmv_1JtjV1QEY84Fv395Hl7h",

    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "sections": ["dsec_2UxtAULYUrX7GVsTKePy"],
    "score": 8,

    "appointment": "appt_TKePyL2UxtAYUUrX7GVs",
    "insurance_claim": "icl_ULYUr2UxtAX7GVsTKePy",
    "name": "Group Meeting Notes — 9/18/22",
    "share_with_patient": false,

    "sections": ["nsec_2UxtAULYUrX7GVsTKePy"],

    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],

    "reviews": [],
    "signers": [{
        "status": "signedByProvider",
        "signed_by": "user_xeDpGyt67wTor93qKtS7",
        "signed_at": 1653798303000
    }],

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}


POST/v1/notes

Create a note

Creates a new visit note.

Required attributes

  • Name
    patient
    Type
    string
    Description

    Patient this note is for.

Optional attributes

  • Name
    appointment
    Type
    string
    Description

    Appointment this note is associated with.

  • Name
    insurance_claim
    Type
    string
    Description

    Insurance claim this note is associated with.

  • Name
    name
    Type
    string
    Description

    Name of the note.

  • Name
    share_with_patient
    Type
    boolean
    Description

    Whether this note should be shared with the patient. Defaults to whatever the default for this note template is. Only applies if the note template allows the default to be overridden.

  • Name
    review
    Type
    object
    Description
    Review of note.
  • Name
    signer
    Type
    string
    Description

    Signer of note.

Response

{
    "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",

    "type": "template",
    "note_template": "dtmp_NOIYLBGOBNhSwTWCUzfu",
    "note_template_version": "dtmv_1JtjV1QEY84Fv395Hl7h",

    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "sections": ["dsec_2UxtAULYUrX7GVsTKePy"],
    "score": 8,

    "appointment": "appt_TKePyL2UxtAYUUrX7GVs",
    "insurance_claim": "icl_ULYUr2UxtAX7GVsTKePy",
    "name": "Group Meeting Notes — 9/18/22",
    "share_with_patient": false,

    "sections": ["nsec_2UxtAULYUrX7GVsTKePy"],

    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],

    "reviews": [],
    "signers": [{
        "status": "signedByProvider",
        "signed_by": "user_xeDpGyt67wTor93qKtS7",
        "signed_at": 1653798303000
    }],

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

GET/v1/notes/:id

Retrieve a note

Retrieves the specified note.

Response

{
    "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",

    "type": "template",
    "note_template": "dtmp_NOIYLBGOBNhSwTWCUzfu",
    "note_template_version": "dtmv_1JtjV1QEY84Fv395Hl7h",

    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "sections": ["dsec_2UxtAULYUrX7GVsTKePy"],
    "score": 8,

    "appointment": "appt_TKePyL2UxtAYUUrX7GVs",
    "insurance_claim": "icl_ULYUr2UxtAX7GVsTKePy",
    "name": "Group Meeting Notes — 9/18/22",
    "share_with_patient": false,

    "sections": ["nsec_2UxtAULYUrX7GVsTKePy"],

    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],

    "reviews": [],
    "signers": [{
        "status": "signedByProvider",
        "signed_by": "user_xeDpGyt67wTor93qKtS7",
        "signed_at": 1653798303000
    }],

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

POST/v1/notes/:id

Update a note

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

Required attributes

    Optional attributes

    • Name
      appointment
      Type
      string
      Description

      Appointment this note is associated with.

    • Name
      insurance_claim
      Type
      string
      Description

      Insurance claim this note is associated with.

    • Name
      name
      Type
      string
      Description

      Name of the note.

    • Name
      share_with_patient
      Type
      boolean
      Description

      Whether this note should be shared with the patient. Defaults to whatever the default for this note template is. Only applies if the note template allows the default to be overridden.

    • Name
      review
      Type
      object
      Description
      Review of note.
    • Name
      signer
      Type
      string
      Description

      Signer of note.

    Response

    {
        "id": "note_2UxtAULYUrX7GVsTKePy",
        "object": "note",
    
        "type": "template",
        "note_template": "dtmp_NOIYLBGOBNhSwTWCUzfu",
        "note_template_version": "dtmv_1JtjV1QEY84Fv395Hl7h",
    
        "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
        "sections": ["dsec_2UxtAULYUrX7GVsTKePy"],
        "score": 8,
    
        "appointment": "appt_TKePyL2UxtAYUUrX7GVs",
        "insurance_claim": "icl_ULYUr2UxtAX7GVsTKePy",
        "name": "Group Meeting Notes — 9/18/22",
        "share_with_patient": false,
    
        "sections": ["nsec_2UxtAULYUrX7GVsTKePy"],
    
        "comments": [
            "cmmt_op0jVVAdR23DgkQPpdX8"
        ],
        "addendums": [
            "addm_pdX8op0jVVAdR23DgkQP"
        ],
    
        "reviews": [],
        "signers": [{
            "status": "signedByProvider",
            "signed_by": "user_xeDpGyt67wTor93qKtS7",
            "signed_at": 1653798303000
        }],
    
        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": 1653798303000,
        "last_updated_at": 1653798303000
    }
    

    GET/v1/notes

    List all notes

    Returns a list of all notes. The full base64 encoded file may not be returned in the list.

    Optional query parameters

    • Name
      patient
      Type
      string
      Description

      Patient to filter by.

    • Name
      note_template
      Type
      string
      Description

      Note template to filter by.

    • Name
      note_template_version
      Type
      string
      Description

      Note template version to filter by.

    • Name
      appointment
      Type
      string
      Description

      Appointment to filter by.

    • Name
      insurance_claim
      Type
      string
      Description

      Insurance claim to filter by.

    Request

    GET
    /v1/notes
    curl https://{{base_subdomain}}.avonhealth.com/v1/notes?note_template=ntmp_NOIYLBGOBNhSwTWCUzfu&note_template_version=ntmv_1JtjV1QEY84Fv395Hl7h&patient=user_Z1zXZKvqrpwxbznuW6lJ \
      -H "Authorization: Bearer {{token}}" \
      -H "x-jwt: {{jwt}}"
    

    Response

    {
      "object": "list",
      "data": [
        {
            "id": "note_2UxtAULYUrX7GVsTKePy",
            "object": "note",
    
            "type": "template",
            "note_template": "dtmp_NOIYLBGOBNhSwTWCUzfu",
            "note_template_version": "dtmv_1JtjV1QEY84Fv395Hl7h",
    
            "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
            "sections": ["dsec_2UxtAULYUrX7GVsTKePy"],
            "score": 8,
    
            "appointment": "appt_TKePyL2UxtAYUUrX7GVs",
            "insurance_claim": "icl_ULYUr2UxtAX7GVsTKePy",
            "name": "Group Meeting Notes — 9/18/22",
            "share_with_patient": false,
    
            "sections": ["nsec_2UxtAULYUrX7GVsTKePy"],
    
            "comments": [
                "cmmt_op0jVVAdR23DgkQPpdX8"
            ],
            "addendums": [
                "addm_pdX8op0jVVAdR23DgkQP"
            ],
    
            "reviews": [],
            "signers": [{
                "status": "signedByProvider",
                "signed_by": "user_xeDpGyt67wTor93qKtS7",
                "signed_at": 1653798303000
            }],
    
            "created_by": "user_xeDpGyt67wTor93qKtS7",
            "created_at": 1653798303000,
            "last_updated_at": 1653798303000
        },
      ]
    }