Treatment Mutations

These mutations allow you to interact with treatment data.

addCustomTreatmentSheetRow

Arguments

Argument	Type	Description
`input`required	CustomTreatmentSheetRowInput!	Input
`treatmentSheetId`required	ID!	ID of the treatmentsheet

Example Query

mutation(
  $input: CustomTreatmentSheetRowInput!,
  $treatmentSheetId: ID!
) {
  addCustomTreatmentSheetRow(
    input: $input,
    treatmentSheetId: $treatmentSheetId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {},
  "treatmentSheetId": "1"
}

addTreatmentSheetCellComment

Returns: TreatmentSheetCell

Arguments

Argument	Type	Description
`text`	String	Text
`treatmentSheetCellId`required	ID!	ID of the treatmentsheetcell

Example Query

mutation(
  $text: String,
  $treatmentSheetCellId: ID!
) {
  addTreatmentSheetCellComment(
    text: $text,
    treatmentSheetCellId: $treatmentSheetCellId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "text": "example",
  "treatmentSheetCellId": "1"
}

addTreatmentSheetRow

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`input`required	TreatmentSheetRowInput!	Input
`treatmentSheetId`required	ID!	ID of the treatmentsheet

Example Query

mutation(
  $input: TreatmentSheetRowInput!,
  $treatmentSheetId: ID!
) {
  addTreatmentSheetRow(
    input: $input,
    treatmentSheetId: $treatmentSheetId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {},
  "treatmentSheetId": "1"
}

continueTreatment

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`at`	DateTime	When administration resumes. Defaults to now.
`id`required	ID!	Unique identifier

Example Query

mutation(
  $at: DateTime,
  $id: ID!
) {
  continueTreatment(
    at: $at,
    id: $id
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "at": {},
  "id": "1"
}

createTreatmentSheet

Returns: TreatmentSheet

Arguments

Argument	Type	Description
`input`required	CreateTreatmentSheetInput!	Input

Example Query

mutation($input: CreateTreatmentSheetInput!) {
  createTreatmentSheet(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createTreatmentSheetCell

Returns: TreatmentSheetCell

Arguments

Argument	Type	Description
`input`	TreatmentSheetCellInput	Input data for treatment sheet cell operation
`treatmentSheetRowId`	ID	ID of the treatmentsheetrow

Example Query

mutation(
  $input: TreatmentSheetCellInput,
  $treatmentSheetRowId: ID
) {
  createTreatmentSheetCell(
    input: $input,
    treatmentSheetRowId: $treatmentSheetRowId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {},
  "treatmentSheetRowId": "1"
}

createTreatmentSheetTemplate

Returns: TreatmentSheetTemplate

Arguments

Argument	Type	Description
`input`required	TreatmentSheetTemplateInput!	Input

Example Query

mutation($input: TreatmentSheetTemplateInput!) {
  createTreatmentSheetTemplate(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

deleteTreatment

Returns: Treatment!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteTreatment(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteTreatmentSheet

Returns: TreatmentSheet

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteTreatmentSheet(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteTreatmentSheetRow

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteTreatmentSheetRow(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteTreatmentSheetRowAdditiveEntry

Returns: TreatmentSheetRowAdditiveEntry

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteTreatmentSheetRowAdditiveEntry(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteTreatmentSheetRowConfig

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`rowId`required	ID!	ID of the row
`startAt`required	DateTime!	The `startsAt` of the configuration to delete.

Example Query

mutation(
  $rowId: ID!,
  $startAt: DateTime!
) {
  deleteTreatmentSheetRowConfig(
    rowId: $rowId,
    startAt: $startAt
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "rowId": "1",
  "startAt": {}
}

deleteTreatmentSheetTemplate

Returns: TreatmentSheetTemplate

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteTreatmentSheetTemplate(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

discontinueTreatmentSheetRow

Returns: TreatmentSheetRow

Discontinues a treatment from now and records who stopped it. No dose is owed from that instant on. Refused when the treatment is already discontinued.

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`reason`	String	Why it was stopped. At most 1,000 characters.

Example Query

mutation(
  $id: ID!,
  $reason: String
) {
  discontinueTreatmentSheetRow(
    id: $id,
    reason: $reason
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "reason": "example"
}

emailTreatmentSheetSummary

Returns: String

Arguments

Argument	Type	Description
`emailBody`	String	Content of the email message
`emailTo`	[String]	Recipient email address
`includeIncompleteTreatments`	Boolean	Include incomplete treatments
`locationId`	ID	ID of the location
`treatmentSheetId`required	ID!	ID of the treatmentsheet

Example Query

mutation(
  $emailBody: String,
  $emailTo: [String],
  $includeIncompleteTreatments: Boolean,
  $locationId: ID,
  $treatmentSheetId: ID!
) {
  emailTreatmentSheetSummary(
    emailBody: $emailBody,
    emailTo: $emailTo,
    includeIncompleteTreatments: $includeIncompleteTreatments,
    locationId: $locationId,
    treatmentSheetId: $treatmentSheetId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "emailBody": "example",
  "emailTo": "example",
  "includeIncompleteTreatments": true,
  "locationId": "1",
  "treatmentSheetId": "1"
}

mergeNovaTemplateRows

Returns: TreatmentSheet!

Arguments

Argument	Type	Description
`input`required	NovaSheetMergeInput!	Input
`sheetId`required	ID!	ID of the sheet

Example Query

mutation(
  $input: NovaSheetMergeInput!,
  $sheetId: ID!
) {
  mergeNovaTemplateRows(
    input: $input,
    sheetId: $sheetId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {},
  "sheetId": "1"
}

pauseTreatment

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`at`	DateTime	When the pause begins. Defaults to now.
`id`required	ID!	Unique identifier

Example Query

mutation(
  $at: DateTime,
  $id: ID!
) {
  pauseTreatment(
    at: $at,
    id: $id
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "at": {},
  "id": "1"
}

restartTreatmentSheetRow

Returns: TreatmentSheetRow

Restarts a discontinued treatment from now. The time it was stopped stays suppressed, so no dose from that span is owed.

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  restartTreatmentSheetRow(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

saveTreatmentSheetCellOrderItem

Returns: TreatmentSheetCell

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`	SaveTreatmentSheetCellOrderItemInput	Input data for save treatment sheet cell order item operation

Example Query

mutation(
  $id: ID!,
  $input: SaveTreatmentSheetCellOrderItemInput
) {
  saveTreatmentSheetCellOrderItem(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

saveTreatmentSheetRowAdditiveEntry

Returns: TreatmentSheetRowAdditiveEntry

Arguments

Argument	Type	Description
`additiveId`	ID	ID of the additive
`input`	TreatmentSheetRowAdditiveEntryInput	Input data for treatment sheet row additive entry operation

Example Query

mutation(
  $additiveId: ID,
  $input: TreatmentSheetRowAdditiveEntryInput
) {
  saveTreatmentSheetRowAdditiveEntry(
    additiveId: $additiveId,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "additiveId": "1",
  "input": {}
}

saveTreatmentSheetRowConfig

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`config`required	TreatmentSheetRowConfigInput!	Config
`endAt`	DateTime	When the treatment stops. Omit to run until checkout. An end cannot be changed once set.
`reason`	String	Why the treatment stops. Sent with `endAt`.
`rowId`required	ID!	ID of the row
`startAt`required	DateTime!	When this configuration takes effect.

Example Query

mutation(
  $config: TreatmentSheetRowConfigInput!,
  $endAt: DateTime,
  $reason: String,
  $rowId: ID!,
  $startAt: DateTime!
) {
  saveTreatmentSheetRowConfig(
    config: $config,
    endAt: $endAt,
    reason: $reason,
    rowId: $rowId,
    startAt: $startAt
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "config": {},
  "endAt": {},
  "reason": "example",
  "rowId": "1",
  "startAt": {}
}

signTreatmentSheet

Returns: TreatmentSheet

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`signed`	Boolean	Signed

Example Query

mutation(
  $id: ID!,
  $signed: Boolean
) {
  signTreatmentSheet(
    id: $id,
    signed: $signed
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "signed": true
}

undoPauseTreatment

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`intervalId`required	ID!	The interval to delete.
`rowId`required	ID!	ID of the row

Example Query

mutation(
  $intervalId: ID!,
  $rowId: ID!
) {
  undoPauseTreatment(
    intervalId: $intervalId,
    rowId: $rowId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "intervalId": "1",
  "rowId": "1"
}

updateCustomTreatmentSheetRow

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	CustomTreatmentSheetRowInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: CustomTreatmentSheetRowInput!
) {
  updateCustomTreatmentSheetRow(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateTreatment

Returns: Treatment

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	TreatmentInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: TreatmentInput!
) {
  updateTreatment(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateTreatmentSheet

Returns: TreatmentSheet

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	TreatmentSheetInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: TreatmentSheetInput!
) {
  updateTreatmentSheet(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateTreatmentSheetCell

Returns: TreatmentSheetCell

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	TreatmentSheetCellInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: TreatmentSheetCellInput!
) {
  updateTreatmentSheetCell(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateTreatmentSheetRow

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	TreatmentSheetRowInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: TreatmentSheetRowInput!
) {
  updateTreatmentSheetRow(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateTreatmentSheetRowInactiveIntervals

Returns: TreatmentSheetRow

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`inactiveIntervals`required	[TreatmentTimeIntervalInput!]!	Inactive intervals

Example Query

mutation(
  $id: ID!,
  $inactiveIntervals: [TreatmentTimeIntervalInput!]!
) {
  updateTreatmentSheetRowInactiveIntervals(
    id: $id,
    inactiveIntervals: $inactiveIntervals
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "inactiveIntervals": {}
}

updateTreatmentSheetStart

Returns: TreatmentSheet

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`start`required	DateTime!	Starting point for the range

Example Query

mutation(
  $id: ID!,
  $start: DateTime!
) {
  updateTreatmentSheetStart(
    id: $id,
    start: $start
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "start": {}
}

updateTreatmentSheetTemplate

Returns: TreatmentSheetTemplate

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	TreatmentSheetTemplateInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: TreatmentSheetTemplateInput!
) {
  updateTreatmentSheetTemplate(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateTreatmentSheetTimeSlots

Returns: TreatmentSheet

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`timeSlots`required	[DateTime]!	Time slots

Example Query

mutation(
  $id: ID!,
  $timeSlots: [DateTime]!
) {
  updateTreatmentSheetTimeSlots(
    id: $id,
    timeSlots: $timeSlots
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "timeSlots": {}
}