TRtruepill
v1

Update Patient

This endpoint updates a patient record in the Truepill ecosystem.<br/><br/>Upon a successful request, the endpoint returns the patient_token of the patient updated, the timestamp, the status, and a message.<br/><br/>Only non-required fields can be updated. Submitting a patient's first name, last name, date of birth, or gender as a field to be updated will be considered a bad request.

post/v1/patient/{patient_token}

Request

Path parameters

patient_tokenstring required

Request body

companystring

Name of company associated with patient (if applicable)

street1string

Street 1 of patient’s address

street2string

Street 2 of patient’s address (if applicable)

citystring

City of patient’s address

statestring

State of patient’s address, two-letter abbreviation

countrystring
zipstring

Patient’s zip code

phonestring

Patient’s phone number

emailstring

Patient’s email address

ssnstring

Social Security Number

ssn_serialstring

Social Security Number (last 4 digits)

communications_opt_inboolean
language_preferencestring

Patient’s preferred language

id_imagestring

URL for image of user ID

mbistring

Medicare Beneficiary ID

viewed_notice_of_privacy_practicesboolean
viewed_notice_of_privacy_practices_datestring

Date NOPP was received

Example request

{
  "company": "True Pill",
  "street1": "123 Some Lane",
  "street2": "Apt. 123",
  "city": "Los Angeles",
  "state": "CA",
  "zip": "94402",
  "phone": "430-304-3949",
  "email": "hulkout@hulk.com",
  "ssn": "123456789",
  "ssn_serial": "6789",
  "language_preference": "English",
  "viewed_notice_of_privacy_practices_date": "20180401"
}

Response

Accepted

patient_tokenstring
timestampinteger
statusstring

Example response

{
  "patient_token": "a35be240f1f5da6b",
  "timestamp": 1631571795,
  "status": "success",
  "details": {
    "message": "Accepted: Patient a35be240f1f5da6b has been updated"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.