api

Patient search

While the Get Patient endpoint requires a patient_token to retrieve information, you can also retrieve patient information without a patient_token, using the Find Patient endpoint.<br/><br/>Search for patient information by appending the following param fields onto the API endpoint, separated with an &:

get/api/v1/patient

Query parameters

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

Postal code where the company is located

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'

Response

OK

Changes