Awell Health Developer Hub
Developer Hub

This query allows us to fetch the details of a clinical note.

Request

Query

  • graphql
01query GetClinicalNote($id: String!) {
02 clinicalNote(id: $id) {
03 clinical_note {
04 id
05 narratives {
06 id # Our unique id for each narrative in a care flow
07 key # A unique id you have set for your narrative
08 title
09 body # A string containing html content
10 }
11 context {
12 key
13 value
14 }
15 }
16 }
17}

Variables

  • json
01{
02 "id": "{{CLINICAL_NOTE_ID}}"
03}

Where to find the clinical note id

The id of the clinical note can be found in the object.id field of an activity.

  • json
01{
02 "activity": {
03 "id": "{{ACTIVITY_ID}}",
04 "object": {
05 "id": "{{CLINICAL_NOTE_ID}}",
06 "type": "clinical_note",
07 "name": "Clinical note"
08 },
09 ...
10 }
11}