ReferenceFor engineers

Stakeholders

Look up the stakeholders that participate in a care flow.

Look up the stakeholders that participate in a care flow.

Queries

filterStakeholders

Returns the stakeholders matching the given care flow definition, release, and stakeholder definition filters.

Arguments

ArgumentTypeRequiredDescription
pathway_definition_ids[String!]NoThe IDs of the care flow definitions
release_ids[String!]NoThe IDs of the published care flow definition versions (releases)
stakeholder_definition_ids[String!]NoThe IDs of the stakeholder definitions

Returns: StakeholdersPayload!

Example

query FilterStakeholders($pathway_definition_ids: [String!], $release_ids: [String!], $stakeholder_definition_ids: [String!]) {
  filterStakeholders(pathway_definition_ids: $pathway_definition_ids, release_ids: $release_ids, stakeholder_definition_ids: $stakeholder_definition_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}

Variables:

{
  "pathway_definition_ids": [
    "<string>"
  ],
  "release_ids": [
    "<string>"
  ],
  "stakeholder_definition_ids": [
    "<string>"
  ]
}

stakeholdersByDefinitionIds

Returns the stakeholders for the given stakeholder definition IDs.

Arguments

ArgumentTypeRequiredDescription
stakeholder_definition_ids[String!]!YesThe IDs of the stakeholder definitions

Returns: StakeholdersPayload!

Example

query StakeholdersByDefinitionIds($stakeholder_definition_ids: [String!]!) {
  stakeholdersByDefinitionIds(stakeholder_definition_ids: $stakeholder_definition_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}

Variables:

{
  "stakeholder_definition_ids": [
    "<string>"
  ]
}

stakeholdersByPathwayDefinitionIds

Returns the stakeholders for the given care flow definition IDs.

Arguments

ArgumentTypeRequiredDescription
pathway_definition_ids[String!]!YesThe IDs of the care flow definitions

Returns: StakeholdersPayload!

Example

query StakeholdersByPathwayDefinitionIds($pathway_definition_ids: [String!]!) {
  stakeholdersByPathwayDefinitionIds(pathway_definition_ids: $pathway_definition_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}

Variables:

{
  "pathway_definition_ids": [
    "<string>"
  ]
}

stakeholdersByReleaseIds

Returns the stakeholders for the given published care flow definition versions (releases).

Arguments

ArgumentTypeRequiredDescription
release_ids[String!]!YesThe IDs of the published care flow definition versions (releases)

Returns: StakeholdersPayload!

Example

query StakeholdersByReleaseIds($release_ids: [String!]!) {
  stakeholdersByReleaseIds(release_ids: $release_ids) {
    code
    stakeholders {
      clinical_app_role
      definition_id
      id
      label {
        en
      }
      release_id
      version
    }
    success
  }
}

Variables:

{
  "release_ids": [
    "<string>"
  ]
}

On this page