Note Section

The note sections contains information about a section in a note.

The note section model

Properties

Name
id
Type
string
Description
Unique identifier for the note section.
Name
object
Type
string
Description
Always 'note_section'.
Name
section
Type
string
Description
Corresponding note template version section.
Name
patient
Type
string
Description
Patient this note section is for.
Name
answers
Type
string
Description
List of answers is this note section.

Response

{
    "id": "nsec_U8xtAULYUrX7GVsTKePy",
    "object": "note_section",
    "note": "note_841JtjV1QEYFv395Hl7h",
    "section": "ntsc_1JtjV1QEY84Fv395Hl7h",
    "patient": "user_3951JtjV1QEY84FvHl7h",
    "questions": ["nans_V1QEY841JtjFv395Hl7h"],
}

GET/v2/note_sections/:id

Retrieve a note section

Retrieves the specified note section.

Response

{
   "id": "nsec_U8xtAULYUrX7GVsTKePy",
   "object": "note_section",
   "note": "note_841JtjV1QEYFv395Hl7h",
   "section": "ntsc_1JtjV1QEY84Fv395Hl7h",
   "patient": "user_3951JtjV1QEY84FvHl7h",
   "questions": ["nans_V1QEY841JtjFv395Hl7h"],
}

GET/v2/note_sections

List all note sections

Returns a list of all note sections. Pass attributes to filter the list of note sections 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_sections

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

Response

{
  "object": "list",
  "data": [{
    "id": "nsec_U8xtAULYUrX7GVsTKePy",
    "object": "note_section",
    "note": "note_841JtjV1QEYFv395Hl7h",
    "section": "ntsc_1JtjV1QEY84Fv395Hl7h",
    "patient": "user_3951JtjV1QEY84FvHl7h",
    "questions": ["nans_V1QEY841JtjFv395Hl7h"],
  }]
}