Update Referral Subject

put

https://staging.api.studyteamapp.com/rpi/v2/sites/{siteId}/referrals/subjects/{subjectId}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

siteId

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

subjectId

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

additionalConsents

array

Additional consents, such as medical releases, which can be used for integrations.

additionalConsents

trialTags

array of objects

Tags to apply to the subject that will display in the StudyTeam app in the context of a trial.

update/trialTags

accessibilityRequirements

string

Information about the accessibility needs the patient has.

ixrsSubjectId

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.

recruitmentSource

object

Fields meant to capture details of how the referral was found.
This data is useful for tracking and analyzing the effectiveness
of recruitment campaigns, especially across different mediums
and platforms.

See Best Practices for Tracking Recruitment Sources for more information on how to use these fields.

preferredPronounsNotes

string

Free-form notes about the personal pronouns the patient prefers to be addressed by.

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

ethnicities

array of objects

The ethnicity of the referral patient

ethnicities

name

array of objects

The referral patient’s name.

name

address

array of objects

The referral patient’s address

address

patientClinicalInformation

array of objects

A list of clinical information about the patient.

patientClinicalInformation

status

string

enum

The status of the patient

languages

array of objects

Languages the patient uses.

languages

accessibilityRequirementsNotes

string

Free-form notes about the accessibility needs the patient has.

hobbies

string

Any hobbies the patient has.

targetSiteMrn

string

Medical record number to be used for the patient at the site.

additionalContacts

array of objects

Additional people that can be contacted about the patient, such as a parent, caregiver, child, or friend.

additionalContacts

birthDate

date

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

contactAttempts

array of objects

Information about attempts that have been made to contact the patient.

contactAttempts

patientTags

array of objects

Tags to apply to a patient, which will be displayed in StudyTeam.

patientTags

identifiedDate

date

The date the referral patient was identified.

races

array of objects

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

races

sex

string

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

telecom

array of objects

Methods of communication for the referral patient

telecom

employmentStatus

string

Describes how much (if any) employment the patient engages in.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

202

400400: Bad Request. The payload is invalid, which could be caused by bad encoding, invalid content, or validation errors. Will typically be accompanied by a message with details as to the cause of the failure.

401401: Unauthorized. The user failed to authenticate, which could be due to an expired or invalid access token or because the Authorization Header is incorrect or missing. It should be set to Authorization: Bearer ACCESS_TOKEN.

403403: Forbidden. The user is not authorized to perform the requested action.

404404: Not Found. The requested resource could not be found either due to the path not existing or an invalid identifier was provided for an entity in the system.

409409: Conflict. The resource has a conflict with the current state of the system. For example, trying to create a resource that already exists.

500500: Internal Server Error.