Skip to content

Main content

Research Visit Support Share Tool

Calculate research visit support share from explicit caller-supplied inputs.

Loading tool…

Description

Count distinct planned IDs and distinct IDs with at least one row satisfying all three flags; divide supported by planned.

Support indicators describe which recorded observations meet stated completeness or eligibility conditions. Duration-weighted support and distinct-record support use different denominators.

Count distinct planned IDs and distinct IDs with at least one row satisfying all three flags; divide supported by planned.

When to use this tool

Use Research Visit Support Share when you need a transparent supported fraction from supplied flags.

How to use the tool and how it works

  1. Enter visitIds, occurred, recordComplete, participantAuthorized. Keep parallel arrays aligned. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read plannedVisits, supportedVisits, share, defined. Inspect defined before interpreting the associated values.

Require aligned visit IDs and occurrence, completeness, and authorization flags. Count distinct planned IDs and distinct IDs with at least one row satisfying all three flags; divide supported by planned.1

Input fieldMeaning and unitsAccepted input
visitIdsVisit IdsRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
occurredOccurredRequired. Array of boolean; maximum items 256.
recordCompleteRecord CompleteRequired. Array of boolean; maximum items 256.
participantAuthorizedParticipant AuthorizedRequired. Array of boolean; maximum items 256.
Output fieldInterpretationReturned shape
plannedVisitsPlanned VisitsRequired. Safe integer.
supportedVisitsSupported VisitsRequired. Safe integer.
shareDimensionless fraction under the stated denominator policy.Required. Finite number.
definedWhether the accompanying numeric result has an available denominator or required inputs.Required. Boolean.
json
{
  "input": {
    "visitIds": [
      "a",
      "b"
    ],
    "occurred": [
      true,
      true
    ],
    "recordComplete": [
      true,
      false
    ],
    "participantAuthorized": [
      true,
      true
    ]
  },
  "output": {
    "plannedVisits": 2,
    "supportedVisits": 1,
    "share": 0.5,
    "defined": true
  }
}

Limitations and assumptions

  • Duplicate IDs are consolidated; an empty plan produces share zero and defined false. Flags do not independently verify consent or care delivery.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Inspect missing and excluded records separately and verify the evidence behind each support flag.

References

  1. Calculation and input contract: midwifery/research-visit-support-share — tool.io

Similar or alternative tools

  • Infant Monitor Support Share

    Sum connected time, then time that is connected, artifactFree, and channelMatched; divide the latter by connected time.

  • Study Ingredient Support Share

    Sum total mass and mass with identityReported, amountReported, and sourceVerified all true; divide supported by total mass.