Awell Health Developer Hub
Developer Hub

Query

  • graphql
01query GetPatientPathways($patient_id: String!, $status: [String!]) {
02 patientPathways(
03 patient_id: $patient_id
04 filters: { status: { in: $status } }
05 ) {
06 patientPathways {
07 id
08 title
09 pathway_definition_id
10 status
11 status_explanation
12 version
13 release_id
14 baseline_info {
15 value
16 definition {
17 id
18 title
19 category
20 key
21 valueType
22 possibleValues {
23 label
24 value
25 }
26 unit
27 range {
28 min
29 max
30 }
31 }
32 }
33 }
34 }
35}

Variables

Required parameters

  • json
01{
02 "patient_id": "{{ PATIENT_ID }}"
03}

Filters

The filter is optional: if you don't provide one, all pathways for the patient will be returned.

  • graphql
01query GetPatientPathways($patient_id: String!) {
02 patientPathways(patient_id: $patient_id) {
03 patientPathways {
04 ...Pathway
05 }
06 }
07}

The in filter type for status accepts a list of values and results in an is any of search criteria.

  • json
01{
02 "patient_id": "{{ PATIENT_ID }}",
03 "status": ["active", "completed"]
04}

Status

You can use the following status values in the status filter array.

  • graphql
01enum PathwayStatus {
02 active
03 completed
04 missing_baseline_info
05 starting
06 stopped
07}

Pagination and sorting

There is no pagination or sorting available for this query. All matching patient pathways will be returned.