Get Progress Notes

This endpoint retrieves all of your progress notes.

NOTE

Replace <base_url> from the examples below with one of the following:

Environment	Base URL
Production	https://api.cirrusmd.com
Sandbox	https://api-sandbox.cirrusmd.com

---

Request URL

GET <base_url>/v2/progress_notes

Optional Query Parameters

Parameter	Description
starts_at	(optional) completed_at Timestamp from which to begin filtered results. If omitted, the default starts_at will be 1 hour in the past.
ends_at	(optional) completed_at Timestamp from which to end filtered results.
include_non_billable	(optional) Progress notes for non-billable encounters included in the results.

Example Request

curl "<base_url>/v2/progress_notes"
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example Response

{
  "links":{
    "self":"<base_url>/v2/progress_notes",
    "prev":null,
    "next":null
  },
  "meta":{
    "paging":{
      "total":1
    }
  },
  "data":[
    {
      "id":5,
      "body":"I determined that the patient has strep throat and wrote a prescription for an antibiotic. The patient has been instructed to reach back out if their condition changes.",
      "communication_channels":[
        "messaging"
      ],
      "completed_at":"2016-10-03T20:11:30Z",
      "created_at":"2016-10-03T20:11:30Z",
      "encounter_created_at":"2016-010-03T21:50:04Z",
      "encounter_duration":26,
      "encounter_id":"a39e4ae1-d19e-471f-926c-30fa88defdc0",
      "membership":{
        "id":3,
        "email":"jane@patient.com",
        "member_id":null,
        "state":"active",
        "type":"memberships",
        "patient":{
          "address":null,
          "dob":"2005-01-11T00:00:00Z",
          "external_id":null,
          "first_name":"Jane",
          "gender":"female",
          "id":3,
          "last_name":"Patient",
          "middle_name":null,
          "phone":null,
          "primary_care_physician":null,
          "type":"patients",
          "zipcode":"80202"
        },
        "metadata":{
          "referring_hospital":"St Vincents"
        },
        "plan":{
          "id":7,
          "active":true,
          "created_at":"2016-09-28T23:33:32Z",
          "description":"Urgent Care",
          "external_id":"hijklm",
          "name":"Plan 1",
          "provider_group":{
            "id":2,
            "created_at":"2016-09-28T23:33:32Z",
            "external_id":null,
            "name":"Family Practice",
            "type":"provider_groups"
          },
          "type":"plans"
        }
      },
      "provider":{
        "id":1,
        "type":"providers",
        "first_name":"Jann",
        "last_name":"Vincent",
        "provider_identifier":null
      },
      "resolution_tags":[
        "referral-to-cirrusmd",
        "wrote-prescription"
      ],
      "type":"progress_notes",
      "icd_codes":[
        {
          "id":32,
          "code":"B34.9",
          "description":"Viral infection, unspecified",
          "primary":true,
          "type":"icd_codes"
        },
        {
          "id":812,
          "code":"J06.9",
          "description":"Acute upper respiratory infection, unspecified",
          "primary":false,
          "type":"icd_codes"
        }
      ]
    }...
  ]
}

Response Properties

Field	Description
id	Progress Note ID
body	Progress Note body
completed_at	Timestamp in which Progress Note was completed
communication_channels	Array of Communication Channels
created_at	Progress Note Created At Timestamp
encounter_created_at	Timestamp in which the Encounter was created
encounter_duration	Length of the Encounter in seconds
encounter_id	ID of the Encounter associated with Progress Note
icd_codes	Array of ICD Codes
membership	Membership Object
provider	Provider Object
resolution_tags	Array of Resolution Tags
type	Resource Type
icd_code	ICD Code Object

All dates will follow the common ISO 8601 date and time standard format, and will be expressed in UTC: YYYY-MM-DDThh:mm:ssZ