Patients
POST Patients (Bulk)
important notes upload at most 3,000 patients at a time if we need more than 3,000 at any given time, then patients can be uploaded via an exported file, the api can be called 3,000 patients at a time externalpatientid is the field needed to tie the patient in featherpay db to the pms patient this id represents the pms identifier field for that given patient { "tab" "examples", "url" "https //gfp api acdev io/api/v1/patients/bulk", "name" "create / update patients", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "externalpatientid", "type" "string", "children" \[], "description" "pms identifier for patient" }, { "kind" "required", "name" "firstname", "type" "string", "children" \[], "description" "first name of patient" }, { "kind" "required", "name" "lastname", "type" "string", "children" \[], "description" "last name of patient" }, { "kind" "optional", "name" "email", "type" "string", "children" \[], "description" "email of patient used for email communication" }, { "kind" "optional", "name" "smsphonenumber", "type" "string", "children" \[], "description" "sms phone number used for text messaging" }, { "kind" "optional", "name" "addressline1", "type" "string", "children" \[], "description" "street address of patient" }, { "kind" "optional", "name" "addressline2", "type" "string", "children" \[], "description" "apt / unit # of patient's address" }, { "kind" "optional", "name" "addresscity", "type" "string", "children" \[], "description" "city of patient's address" }, { "kind" "optional", "name" "addressstate", "type" "string", "children" \[], "description" "state of patient's address" }, { "kind" "optional", "name" "addresszip", "type" "string", "children" \[], "description" "zip code of patient's address" }, { "kind" "optional", "name" "dateofbirth", "type" "string", "children" \[], "description" "(yyyy mm dd) date of birth for patient " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "c0f7bjpcqhajikyibqef0", "code" "{\n \\"deleted\\"\ false,\n \\"numsuccess\\" 2,\n \\"numfailure\\" 0\n}\n", "language" "200", "customlabel" "" } ], "selectedlanguageid" "c0f7bjpcqhajikyibqef0" }, "examples" { "languages" \[ { "id" "tsjh4baruelrazdnupv8e", "code" "curl x post \\\\\n url 'https //gfp api acdev io/api/v1/patients/bulk' \\\\\n header 'content type application/json;charset=utf 8' \\\\\n header 'accept application/json' \\\\\n header 'x api key {secret api key}' \\\\\n header 'x store id {store ulid}' \\\\\n data raw '\n \[{\n \\"externalpatientid\\" \\"307\\",\n \\"firstname\\" \\"john\\",\n \\"lastname\\" \\"snow\\",\n \\"email\\" \\"the white wolf\@winterfell com\\",\n \\"smsphonenumber\\" \\"+15556873509\\",\n \\"addressline1\\" \\"1 castle\\",\n \\"addresscity\\" \\"winterfell\\",\n \\"addressstate\\" \\"ga\\",\n \\"addresszip\\" \\"30030\\",\n \\"dateofbirth\\" \\"1990 03 20\\"\n },\n {\n \\"externalpatientid\\" \\"1848\\",\n \\"firstname\\" \\"daenerys\\",\n \\"lastname\\" \\"targaryen\\",\n \\"email\\" \\"breakerofchains\@targaryen org\\",\n \\"smsphonenumber\\" \\"+15551234567\\",\n \\"addressline1\\" \\"1 khaleesi way\\",\n \\"addresscity\\" \\"great seas\\",\n \\"addressstate\\" \\"nh\\",\n \\"addresszip\\" \\"00030\\",\n \\"dateofbirth\\" \\"1991 01 03\\"\n }\n]'", "language" "json", "customlabel" "" } ], "selectedlanguageid" "tsjh4baruelrazdnupv8e" }, "description" "from your backend code, create / update the patients with your store id and private key ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }