GuidesAPI ReferenceChangelog
API Reference

Update Referral Subject v1

put
https://staging.api.studyteamapp.com/rpi/sites//referrals/subjects/

Allows you to update an existing referral subject that was already sent to StudyTeam.

Note: Most referral subject fields cannot be updated once they have been reviewed by a site user. The screening encounter is the only field which can be updated anytime even after the referral subject is reviewed. This information will be added as an additional note on the referral subject's timeline.

Path Params
string
required

The unique StudyTeam ID for a clinical research site. Once you are provided with your client credentials, you can retrieve a list of the siteIds you have access to by using the Get Referral Site List API

string
required

A unique referral patient identifier. The subjectId must be unique across all referral patients submitted by a given referral partner

Body Params

submit referral subject updates to a site

name
array of objects

The referral patient’s name.

name
address
array of objects

The referral patient’s address

address
date

The ISO-8601 date of the referral patient’s date of birth

telecom
array of objects

Methods of communication for the referral patient

telecom
string

The sex of the referral patient. Possible sex values include: male, female, intersex

races
array of objects

The race of the referral patient. You can pass multiple races for a single referral.

races
ethnicities
array of objects

The ethnicity of the referral patient

ethnicities
encounter
array of objects

A screening encounter. This field can be used to provide any screening data collected for the given referral subject (usually in question & answer format)

encounter
string | null

The external patient identifier from the IRT system indicating enrollment and/or randomization. This field corresponds to subjectID in the reporting events API.

string
enum

The status of the patient

Responses

Updated 3 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago