COcounselhealth
/v1beta/notes

Get a patient note by ID

Retrieves a patient note including its body, a meta label for the note format (SOAP Note), optional structured diagnosis metadata, and timestamps. The note must belong to a patient within your organization. Pass withPhysician=true to include the authoring physician (id, name, email, npi) in the response. This endpoint is in beta and its response shape may still change before promotion to /v1.

get/v1beta/notes/{noteId}/

Request

  • Base URL
    https://api.counselhealth.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

noteIdstring uuid required

Query parameters

withPhysicianboolean

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key. Repeat requests with the same key and body return the original result.

Response

Default Response

idstring uuid required
patient_idstring uuid required
physician_idstring uuid required
thread_idstring uuid nullable required
created_atstring date-time required

datetime in ISO 8601 format

Example response

{
  "created_at": "2030-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.