API Workflows

General Workflows

• Creating Participants
  • Creating a Participant
    • Examples
  • The /Participant Resource
• Creating and Updating Participant Data
  • Resource Versioning
  • Workflows
    • Create Participant Questionnaire Response
    • Create Participant Physical Measurements
    • Cancellation/Amending/Restoring Physical Measurements
    • BioBank Orders
      • Create a BioBank Order
      • Edit a BioBank Order
    • Deceased Reports
      • DeceasedReportApi
      • Creating and reviewing a deceased report
      • Retrieving deceased reports
      • Effects on Participant Summary
• Searching and Filtering Participant Data
  • Participant Summary
    • Querying the Participant Summary Resource
  • Participant Questionnaire Answers
  • Physical Measurements
    • PhysicalMeasurements by ID
    • PhysicalMeasurements for a Participant
• Reporting APIs
  • Participant Counts Over Time
    • Parameters
      • startDate
      • endDate (required)
      • stratification (required)
      • awardee (optional)
      • version (optional)
      • enrollmentStatus (optional)
      • history (optional)
  • Metrics

Task Specific Workflows

PTC to RDR (Raw Data Repository)

• Create and update Participant information

• Create and update Questionnaires and Responses (“PPI”, Participant-provided information)

• Read data about a participant

Health Professional Portal to RDR

• Search Participants

  • At check-in time, look up an individual by name, date of birth, zip code

  • For a Work Queue, filter participants based on summary information (e.g. age, race)

• Get Participant Summary (by id)

• Update a Participant with a new Medical Record Number

• Insert results from physical measurements

• Insert biospecimen orders

BioBank to RDR

• Google Cloud Storage “add a csv file to bucket”, performed daily

For release management and operational monitoring

• Serving version identifier - no auth required

API Resource Reference

• API Resource Reference
  • Participant Summary Field List
  • Awardee InSite Field List
  • BioBank Order Field List
  • Enumerated Field Options Reference
  • Patient API Reference