Get Patient Notes

cURL

curl --request GET \
  --url https://om-staging.mylifeforce.com/api/m2m/patient/{patientId}/notes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "6004582",
      "name": "RG - Async Consultation/Recommendation",
      "created_at": "2022-04-18T09:46:00Z",
      "locked_at": null,
      "finished": true,
      "custom_module_form": {
        "id": "567345",
        "name": "Initial Telehealth Note"
      },
      "filler": {
        "id": "1143305",
        "first_name": "Brett",
        "last_name": "Ulrich",
        "avatar_url": "https://s3.amazonaws.com/healthie-production/image/1143305/medium/mountain_profile.jpeg"
      },
      "locked_by": null,
      "form_answers": [
        {
          "id": "910722521",
          "label": "Skip Async Note",
          "answer": "True",
          "custom_module_id": "23218578",
          "custom_module": {
            "mod_type": "checkbox"
          }
        }
      ]
    }
  ]
}

GET

patient

{patientId}

notes

cURL

curl --request GET \
  --url https://om-staging.mylifeforce.com/api/m2m/patient/{patientId}/notes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "6004582",
      "name": "RG - Async Consultation/Recommendation",
      "created_at": "2022-04-18T09:46:00Z",
      "locked_at": null,
      "finished": true,
      "custom_module_form": {
        "id": "567345",
        "name": "Initial Telehealth Note"
      },
      "filler": {
        "id": "1143305",
        "first_name": "Brett",
        "last_name": "Ulrich",
        "avatar_url": "https://s3.amazonaws.com/healthie-production/image/1143305/medium/mountain_profile.jpeg"
      },
      "locked_by": null,
      "form_answers": [
        {
          "id": "910722521",
          "label": "Skip Async Note",
          "answer": "True",
          "custom_module_id": "23218578",
          "custom_module": {
            "mod_type": "checkbox"
          }
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patientId

string<uuid>

required

The id of the patient in question A universally unique identifier.

Example:

"29ea9012-c622-4851-a57a-9327abd21198"

Query Parameters

notes

enum<string>[]

required

Comma-separated list of note types to include

Available options:

ASYNC_CONSULTATION,

CLINICAL_RX_RECOMMENDATION,

FOLLOW_UP_ASYNC_CONSULTATION,

FOLLOW_UP_CLINICAL_RX_RECOMMENDATION,

FOLLOWON_ASSESSMENT,

FOLLOWUP_HQV3,

HEALTH_COACH_QUARTERLY_NOTE,

INITIAL_HQV3,

INTAKE_ASSESSMENT,

INTAKE_PLUS_CLINICAL_ASSESSMENT,

INTERNAL_CLINICAL_NOTE,

LIFESCORE

Example:

"FOLLOW_UP_CLINICAL_RX_RECOMMENDATION,HEALTH_COACH_QUARTERLY_NOTE"

take

integer<int32>

The number of notes to return

locked

boolean

Whether to return only locked notes

Response

Successful response

data

object[]

Show child attributes

data.id

string

Example:

"6004582"

data.name

string

Example:

"RG - Async Consultation/Recommendation"

data.created_at

string<date-time>

Example:

"2022-04-18T09:46:00Z"

data.locked_at

string<date-time>

Example:

null

data.finished

boolean

Example:

true

data.custom_module_form

object

Show child attributes

data.custom_module_form.id

string

Example:

"567345"

data.custom_module_form.name

string

Example:

"Initial Telehealth Note"

data.filler

object

Show child attributes

data.filler.id

string

Example:

"1143305"

data.filler.first_name

string

Example:

"Brett"

data.filler.last_name

string

Example:

"Ulrich"

data.filler.avatar_url

string<uri>

Example:

"https://s3.amazonaws.com/healthie-production/image/1143305/medium/mountain_profile.jpeg"

data.locked_by

object

Show child attributes

data.locked_by.id

string

Example:

"1143305"

data.locked_by.first_name

string

Example:

"Brett"

data.locked_by.last_name

string

Example:

"Ulrich"

data.locked_by.avatar_url

string<uri>

Example:

"https://s3.amazonaws.com/healthie-production/image/1143305/medium/mountain_profile.jpeg"

Example:

null

data.form_answers

object[]

Show child attributes

data.form_answers.id

string

Example:

"910722521"

data.form_answers.label

string

Example:

"Skip Async Note"

data.form_answers.answer

string

Example:

"True"

data.form_answers.custom_module_id

string

Example:

"23218578"

data.form_answers.custom_module

object

Show child attributes

data.form_answers.custom_module.mod_type

string

Example:

"checkbox"

Create a Patient Get Patient Overview

⌘I

API Documentation

Patient

Biomarkers

Lifescore

Questionnaires

Authorizations

Path Parameters

Query Parameters

Response