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
required

The id of the patient in question

Example:

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

Query Parameters

notes
enum<string>[]
required

Comma-separated list of note types to include

Example:

"FOLLOW_UP_CLINICAL_RX_RECOMMENDATION,HEALTH_COACH_QUARTERLY_NOTE"

take
integer

The number of notes to return

locked
boolean

Whether to return only locked notes

Response

200
application/json

Successful response

The response is of type object.