Sign in
v1

Create Patient

This endpoint generates a patient record in the Truepill ecosystem.<br/><br/>Upon a successful request, the endpoint returns a patient_token for you to reference in subsequent API requests that require this field.<br/><br/>The patient_token that is returned upon successfully creating a patient record can be used with many of the other endpoints to continue referencing the same record.<br/><br/>If the patient information in the request body matches the information in an existing patient record, the existing patient_token will be returned in the API response.<br/><br/>The address and phone number provided should be the same as the information provided to the prescriber on the e-Script. These attributes are only used for matching purposes.

put/v1/patient

Request body

guardianstring
prefix'Mr.' | 'Ms.' | 'Mrs.' | 'Miss' | 'Ms' | 'Prof' | 'Sir'

Patient title

suffix'Jr.' | 'Sr.' | 'I' | 'II' | 'III' | 'IV' | 'V'

Suffix which qualifies a person

first_namestring required

Patient first name

last_namestring required

Patient last name

gender'male' | 'female' | 'unknown' required

Patient gender

dobstring date required

Patient's date of birth

zipstring

Patient’s zip code

species'Human' | 'Crocodile' | 'Frog' | 'Iguana' | 'Lizard' | 'Snake' | 'Tortoise' | 'Turtle' | 'Spider' | 'Other Arthopoda' | 'Chicken' | 'African Goshawk' | 'Budgerigar' | 'Cockatiel' | 'Cockatoo' | 'Common Canary' | 'Crow' | 'Duck' | 'Eagle' | 'Goose' | 'Guinea Fowl' | 'Kestrel' | 'Kite' | 'Macaw' | 'Ostrich' | 'Other Aves' | 'Owl' | 'Parakeet' | 'Parrot' | 'Partridge' | 'Peregrin Falcon' | 'Pheasant' | 'Pigeon' | 'Quail' | 'Snipe' | 'Sparrow' | 'Starling' | 'Swan' | 'Turtle Dove' | 'Bison' | 'Cattle/Bovine' | 'Buffalo' | 'Other Bovinae' | 'Alpaca' | 'Camel' | 'Llama' | 'Other Camelidae' | 'Dog/Canine' | 'Fox' | 'Jackal' | 'Raccoon Dog' | 'Wolf' | 'Other Caprinae' | 'Goat/Carpine' | 'Sheep/Ovine' | 'Elk' | 'Moose' | 'Fallow' | 'Other Cervidae' | 'Red Deer' | 'Reindeer' | 'Roe Deer' | 'Donkey/Asinine' | 'Horse/Equine' | 'Hybrid' | 'Other Equidae' | 'Zebra' | 'Bobcat' | 'Cougar' | 'Puma' | 'European Lynx' | 'Cat/Feline' | 'Jaguar' | 'Leopard' | 'Lion' | 'Other Felidae' | 'Tiger' | 'Wild Cat' | 'European Rabbit' | 'Hare' | 'Other Leporidae' | 'Bivalvia' | 'Cephalopoda' | 'Other Mollusca' | 'Badger' | 'Ferret' | 'Mink' | 'Other Mustelidae' | 'Bat' | 'Bear' | 'Hedgehog' | 'Monkey' | 'Other Mammalia' | 'Arctic Char' | 'Atlantic Salmon' | 'Brill' | 'Carp' | 'Catfish' | 'Cod' | 'Crucian Carp' | 'European Eel' | 'Gilthead' | 'Goldfish' | 'Gudgeon' | 'Halibut' | 'Largemouth Bass' | 'Mullet' | 'Other Pisces' | 'Perch' | 'Pike' | 'Roach' | 'Sea Bream' | 'Seabass' | 'Sharpsnout Seabream' | 'Sole' | 'Sturgeon' | 'Tench' | 'Trout' | 'Turbot' | 'Rockfish/Wolffish' | 'Beaver' | 'Chinchilla' | 'Dormouse' | 'Dwarf Hamster' | 'European Hamster' | 'Gerbil' | 'Guinea Pig' | 'House Mouse' | 'Other Rodentia' | 'Rat' | 'Russian Hamster' | 'Syrian Hamster' | 'Golden Hamster' | 'Vole' | 'Other Suidae' | 'Pig/Porcine' | 'Wild Boar' | 'Addax'
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
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

{
  "prefix": "Mr",
  "suffix": "Jr.",
  "first_name": "Lola",
  "last_name": "Martin",
  "gender": "female",
  "dob": "20180401",
  "zip": "94402",
  "species": "sparrow",
  "company": "True Pill",
  "street1": "123 Some Lane",
  "street2": "Apt. 123",
  "city": "Los Angeles",
  "state": "CA",
  "phone": "430-304-3949",
  "email": "hulkout@hulk.com",
  "ssn": "123456789",
  "ssn_serial": "6789",
  "language_preference": "English",
  "viewed_notice_of_privacy_practices_date": "20180401"
}

Response

Created

Changes

No recorded changes to this endpoint across all 1 revision of this API.