Awell
Reference
ReferenceFor engineers

Care flows

Start, stop, pause, and inspect care flows, their activities, and their data points.

Start, stop, pause, and inspect care flows, their activities, and their data points.

Queries

baselineInfo

Returns the baseline info data points for a care flow.

Arguments

ArgumentTypeRequiredDescription
pathway_idString!YesThe ID of the care flow

Returns: BaselineInfoPayload!

Example

query BaselineInfo($pathway_id: String!) {
  baselineInfo(pathway_id: $pathway_id) {
    baselineDataPoints {
      definition {
        category
        id
        key
        optional
        pii
        source_definition_id
        title
        unit
        valueType
      }
      value
    }
    code
    success
  }
}

Variables:

{
  "pathway_id": "<string>"
}

baselineInfoLog

Returns a paginated log of a care flow's baseline info data points.

Arguments

ArgumentTypeRequiredDescription
data_point_definition_idStringNoThe ID of the data point definition
data_point_keyStringNoThe key of the data point
paginationPaginationParamsNoHow many results to return and the offset to start from — see Pagination
pathway_idString!YesThe ID of the care flow
sortingSortingParamsNoThe field to sort by and the sort direction — see Pagination

Returns: BaselineInfoLogPayload!

Example

query BaselineInfoLog($data_point_definition_id: String, $data_point_key: String, $pagination: PaginationParams, $pathway_id: String!, $sorting: SortingParams) {
  baselineInfoLog(data_point_definition_id: $data_point_definition_id, data_point_key: $data_point_key, pagination: $pagination, pathway_id: $pathway_id, sorting: $sorting) {
    code
    dataPoints {
      activity_id
      data_point_definition_id
      data_set_id
      date
      id
      key
      label
      serialized_value
      status
      valueType
    }
    pagination {
      count
      offset
      total_count
    }
    sorting {
      direction
      field
    }
    success
  }
}

Variables:

{
  "data_point_definition_id": "<string>",
  "data_point_key": "<string>",
  "pagination": {
    "count": 0,
    "offset": 0
  },
  "pathway_id": "<string>",
  "sorting": {
    "direction": "<string>",
    "field": "<string>"
  }
}

getPublishedCareflowVersions

Lists the published versions (releases) of a care flow definition.

Arguments

ArgumentTypeRequiredDescription
careflow_definition_idStringNoThe ID of the care flow definition

Returns: CareflowVersionsPayload!

Example

query GetPublishedCareflowVersions($careflow_definition_id: String) {
  getPublishedCareflowVersions(careflow_definition_id: $careflow_definition_id) {
    careflowVersions {
      careflow_definition_id
      versions {
        live
        release_date
        release_id
        title
        version
      }
    }
  }
}

Variables:

{
  "careflow_definition_id": "<string>"
}

latestCareFlowDataPoints

Returns the latest data point values for a care flow.

Arguments

ArgumentTypeRequiredDescription
careflow_idString!YesThe ID of the care flow
release_idString!YesThe ID of the published care flow definition version (release)

Returns: DataPointPayload!

Example

query LatestCareFlowDataPoints($careflow_id: String!, $release_id: String!) {
  latestCareFlowDataPoints(careflow_id: $careflow_id, release_id: $release_id) {
    code
    dataPoints {
      activity_id
      data_point_definition_id
      data_set_id
      date
      id
      key
      label
      serialized_value
      status
      valueType
    }
    pagination {
      count
      offset
      total_count
    }
    sorting {
      direction
      field
    }
    success
  }
}

Variables:

{
  "careflow_id": "<string>",
  "release_id": "<string>"
}

pathway

Retrieves a single care flow by its ID.

Arguments

ArgumentTypeRequiredDescription
idString!YesThe ID of the care flow

Returns: PathwayPayload!

Example

query Pathway($id: String!) {
  pathway(id: $id) {
    code
    pathway {
      complete_date
      created {
        date
        user_email
        user_id
        user_name
      }
      id
      is_archived
      latestActivities {
        action
        container_name
        date
        expires_at
        form_display_mode
        icon_url
        id
        isUserActivity
        metadata
        public
        reference_id
        reference_type
        resolution
        session_id
        status
        stream_id
      }
      pathway_definition_id
      patient {
        id
        tenant_id
      }
      patient_id
      release_id
      start_date
      status
      status_explanation
      stop_date
      title
      version
    }
    success
  }
}

Variables:

{
  "id": "<string>"
}

pathwayActivities

Activities of a care flow. Alias of careflowActivities — the original public name, kept for backward compatibility.

Arguments

ArgumentTypeRequiredDescription
paginationPaginationParamsNoHow many results to return and the offset to start from — see Pagination
pathway_idString!YesThe ID of the care flow
sortingSortingParamsNoThe field to sort by and the sort direction — see Pagination
track_idStringNoThe ID of the track

Returns: ActivitiesPayload!

Example

query PathwayActivities($pagination: PaginationParams, $pathway_id: String!, $sorting: SortingParams, $track_id: String) {
  pathwayActivities(pagination: $pagination, pathway_id: $pathway_id, sorting: $sorting, track_id: $track_id) {
    activities {
      action
      action_component {
        definition_id
        release_id
        title
      }
      container_name
      context {
        action_id
        agent_config_id
        agent_id
        agent_thread_id
        instance_id
        pathway_id
        run_id
        step_id
        track_id
      }
      date
      expires_at
      form {
        definition_id
        id
        key
        metadata
        release_id
        title
        trademark
      }
      form_display_mode
      icon_url
      id
      isUserActivity
      metadata
      public
      reference_id
      reference_type
      resolution
      session_id
      status
      stream_id
    }
    code
    metadata {
      stakeholders {
        email
        id
        name
        preferred_language
        type
      }
    }
    pagination {
      count
      offset
      total_count
    }
    success
  }
}

Variables:

{
  "pagination": {
    "count": 0,
    "offset": 0
  },
  "pathway_id": "<string>",
  "sorting": {
    "direction": "<string>",
    "field": "<string>"
  },
  "track_id": "<string>"
}

pathwayDataPointDefinitions

Lists the data point definitions for a care flow definition release.

Arguments

ArgumentTypeRequiredDescription
filtersFilterPathwayDataPointDefinitionsParamsNoFilters to narrow the results
pathway_definition_idStringNoThe ID of the care flow definition
release_idString!YesThe ID of the published care flow definition version (release)

Returns: PathwayDataPointDefinitionsPayload!

Example

query PathwayDataPointDefinitions($filters: FilterPathwayDataPointDefinitionsParams, $pathway_definition_id: String, $release_id: String!) {
  pathwayDataPointDefinitions(filters: $filters, pathway_definition_id: $pathway_definition_id, release_id: $release_id) {
    code
    data_point_definitions {
      category
      id
      key
      metadata {
        key
        value
      }
      optional
      pii
      possibleValues {
        label
        value
      }
      range {
        max
        min
      }
      source_definition_id
      title
      unit
      valueType
    }
    success
  }
}

Variables:

{
  "filters": {},
  "pathway_definition_id": "<string>",
  "release_id": "<string>"
}

pathwayDataPoints

Returns the data points collected in a care flow.

Arguments

ArgumentTypeRequiredDescription
activity_idStringNoThe ID of the activity
data_point_definition_idStringNoThe ID of the data point definition
data_point_keyStringNoThe key of the data point
paginationPaginationParamsNoHow many results to return and the offset to start from — see Pagination
pathway_idString!YesThe ID of the care flow
sortingSortingParamsNoThe field to sort by and the sort direction — see Pagination

Returns: DataPointPayload!

Example

query PathwayDataPoints($activity_id: String, $data_point_definition_id: String, $data_point_key: String, $pagination: PaginationParams, $pathway_id: String!, $sorting: SortingParams) {
  pathwayDataPoints(activity_id: $activity_id, data_point_definition_id: $data_point_definition_id, data_point_key: $data_point_key, pagination: $pagination, pathway_id: $pathway_id, sorting: $sorting) {
    code
    dataPoints {
      activity_id
      data_point_definition_id
      data_set_id
      date
      id
      key
      label
      serialized_value
      status
      valueType
    }
    pagination {
      count
      offset
      total_count
    }
    sorting {
      direction
      field
    }
    success
  }
}

Variables:

{
  "activity_id": "<string>",
  "data_point_definition_id": "<string>",
  "data_point_key": "<string>",
  "pagination": {
    "count": 0,
    "offset": 0
  },
  "pathway_id": "<string>",
  "sorting": {
    "direction": "<string>",
    "field": "<string>"
  }
}

pathwayFacts

Returns a paginated list of facts recorded for a care flow.

Arguments

ArgumentTypeRequiredDescription
filtersPathwayFactsFilters!YesFilters to narrow the results
paginationPaginationParamsNoHow many results to return and the offset to start from — see Pagination
sortingSortingParamsNoThe field to sort by and the sort direction — see Pagination

Returns: OrchestrationFactsPayload!

Example

query PathwayFacts($filters: PathwayFactsFilters!, $pagination: PaginationParams, $sorting: SortingParams) {
  pathwayFacts(filters: $filters, pagination: $pagination, sorting: $sorting) {
    code
    facts {
      content
      date
      level
      pathway_id
    }
    pagination {
      count
      offset
      total_count
    }
    sorting {
      direction
      field
    }
    success
  }
}

Variables:

{
  "filters": {
    "pathway_id": "<string>"
  },
  "pagination": {
    "count": 0,
    "offset": 0
  },
  "sorting": {
    "direction": "<string>",
    "field": "<string>"
  }
}

pathways

Lists care flows, with optional filtering, pagination, and sorting.

Arguments

ArgumentTypeRequiredDescription
filtersFilterPathwaysNoFilters to narrow the results
paginationPaginationParamsNoHow many results to return and the offset to start from — see Pagination
sortingSortingParamsNoThe field to sort by and the sort direction — see Pagination

Returns: PathwaysPayload!

Example

query Pathways($filters: FilterPathways, $pagination: PaginationParams, $sorting: SortingParams) {
  pathways(filters: $filters, pagination: $pagination, sorting: $sorting) {
    code
    pagination {
      count
      offset
      total_count
    }
    pathways {
      complete_date
      id
      pathway_definition_id
      patient_id
      start_date
      status
      status_explanation
      stop_date
      title
      version
    }
    sorting {
      direction
      field
    }
    success
  }
}

Variables:

{
  "filters": {},
  "pagination": {
    "count": 0,
    "offset": 0
  },
  "sorting": {
    "direction": "<string>",
    "field": "<string>"
  }
}

pathwayStepActivities

Lists the activities for a step within a care flow.

Arguments

ArgumentTypeRequiredDescription
pathway_idString!YesThe ID of the care flow
step_idString!YesThe ID of the step

Returns: ActivitiesPayload!

Example

query PathwayStepActivities($pathway_id: String!, $step_id: String!) {
  pathwayStepActivities(pathway_id: $pathway_id, step_id: $step_id) {
    activities {
      action
      action_component {
        definition_id
        release_id
        title
      }
      container_name
      context {
        action_id
        agent_config_id
        agent_id
        agent_thread_id
        instance_id
        pathway_id
        run_id
        step_id
        track_id
      }
      date
      expires_at
      form {
        definition_id
        id
        key
        metadata
        release_id
        title
        trademark
      }
      form_display_mode
      icon_url
      id
      isUserActivity
      metadata
      public
      reference_id
      reference_type
      resolution
      session_id
      status
      stream_id
    }
    code
    metadata {
      stakeholders {
        email
        id
        name
        preferred_language
        type
      }
    }
    pagination {
      count
      offset
      total_count
    }
    success
  }
}

Variables:

{
  "pathway_id": "<string>",
  "step_id": "<string>"
}

publishedPathwayDefinitions

Lists the published care flow definitions.

Returns: PublishedPathwayDefinitionsPayload!

Example

query PublishedPathwayDefinitions {
  publishedPathwayDefinitions {
    code
    pagination {
      count
      offset
      total_count
    }
    publishedPathwayDefinitions {
      created {
        date
        user_email
        user_id
        user_name
      }
      data_point_definitions {
        category
        id
        key
        optional
        pii
        source_definition_id
        title
        unit
        valueType
      }
      data_store_version
      id
      last_updated {
        date
        user_email
        user_id
        user_name
      }
      release_date
      release_id
      title
      version
    }
    sorting {
      direction
      field
    }
    success
  }
}

Mutations

completeCareflow

Complete a care flow explicitly (the outcome happened). Records manual completion provenance (who/why); a no-op when the care flow is already completed or stopped.

Arguments

ArgumentTypeRequiredDescription
inputCompleteCareflowInput!YesThe details of the care flow to complete

Returns: EmptyPayload!

Example

mutation CompleteCareflow($input: CompleteCareflowInput!) {
  completeCareflow(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "careflow_id": "<string>"
  }
}

deletePathway

Deletes a care flow.

Arguments

ArgumentTypeRequiredDescription
inputDeletePathwayInput!YesThe details of the care flow to delete

Returns: EmptyPayload!

Example

mutation DeletePathway($input: DeletePathwayInput!) {
  deletePathway(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "pathway_id": "<string>"
  }
}

pauseCareFlow

Pauses a care flow.

Arguments

ArgumentTypeRequiredDescription
inputPauseCareFlowInput!YesThe details of the care flow to pause

Returns: EmptyPayload!

Example

mutation PauseCareFlow($input: PauseCareFlowInput!) {
  pauseCareFlow(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "careflow_id": "<string>"
  }
}

saveBaselineInfo

Saves the baseline info for a care flow.

Arguments

ArgumentTypeRequiredDescription
inputSaveBaselineInfoInput!YesThe baseline info to save

Returns: EmptyPayload!

Example

mutation SaveBaselineInfo($input: SaveBaselineInfoInput!) {
  saveBaselineInfo(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "baseline_info": [
      {
        "data_point_definition_id": "<string>",
        "value": "<string>"
      }
    ],
    "pathway_id": "<string>"
  }
}

startPathway

Starts a care flow for a patient from a care flow definition.

Arguments

ArgumentTypeRequiredDescription
inputStartPathwayInput!YesThe details of the care flow to start

Returns: StartPathwayPayload!

Example

mutation StartPathway($input: StartPathwayInput!) {
  startPathway(input: $input) {
    code
    pathway_id
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}

Variables:

{
  "input": {
    "pathway_definition_id": "<string>",
    "patient_id": "<string>"
  }
}

startPathwayWithPatientIdentifier

Starts a care flow for the patient matching a business identifier.

Arguments

ArgumentTypeRequiredDescription
inputStartPathwayWithPatientIdentifierInput!YesThe details of the care flow to start, including the patient identifier

Returns: StartPathwayWithPatientIdentifierPayload!

Example

mutation StartPathwayWithPatientIdentifier($input: StartPathwayWithPatientIdentifierInput!) {
  startPathwayWithPatientIdentifier(input: $input) {
    code
    pathway_id
    patient_id
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}

Variables:

{
  "input": {
    "pathway_definition_id": "<string>",
    "patient_identifier": {
      "system": "<string>",
      "value": "<string>"
    }
  }
}

stopPathway

Stops a care flow.

Arguments

ArgumentTypeRequiredDescription
inputStopPathwayInput!YesThe details of the care flow to stop

Returns: EmptyPayload!

Example

mutation StopPathway($input: StopPathwayInput!) {
  stopPathway(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "pathway_id": "<string>"
  }
}

unpauseCareFlow

Resumes a paused care flow.

Arguments

ArgumentTypeRequiredDescription
inputUnpauseCareFlowInput!YesThe details of the care flow to unpause

Returns: EmptyPayload!

Example

mutation UnpauseCareFlow($input: UnpauseCareFlowInput!) {
  unpauseCareFlow(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "careflow_id": "<string>"
  }
}

updateBaselineInfo

Updates the baseline info for a care flow.

Arguments

ArgumentTypeRequiredDescription
inputUpdateBaselineInfoInput!YesThe baseline info to update

Returns: EmptyPayload!

Example

mutation UpdateBaselineInfo($input: UpdateBaselineInfoInput!) {
  updateBaselineInfo(input: $input) {
    code
    success
  }
}

Variables:

{
  "input": {
    "baseline_info": [
      {
        "data_point_definition_id": "<string>",
        "value": "<string>"
      }
    ],
    "pathway_id": "<string>"
  }
}

Patients

Create, find, update, and manage patients and their data points in the Awell Orchestration API.

Activities

Query the activities in a care flow and retry, expire, or annotate them.

On this page

QueriesbaselineInfobaselineInfoLoggetPublishedCareflowVersionslatestCareFlowDataPointspathwaypathwayActivitiespathwayDataPointDefinitionspathwayDataPointspathwayFactspathwayspathwayStepActivitiespublishedPathwayDefinitionsMutationscompleteCareflowdeletePathwaypauseCareFlowsaveBaselineInfostartPathwaystartPathwayWithPatientIdentifierstopPathwayunpauseCareFlowupdateBaselineInfo