{"openapi":"3.0.1","info":{"title":"IT Synergistics bexWISE API","description":"API definitions for integration with the bexWISE product suite","version":"1.0.00.02.6"},"servers":[{"url":"https://99-rq2.bexwiseapi.com/BexwiseAPI","description":"Generated server url"}],"paths":{"/v1/engage/donors/{donorId}/appointments/{appointmentId}":{"get":{"tags":["Donor"],"summary":"Get a specified appointment for a donor","operationId":"getDonorAppointment","parameters":[{"name":"donorId","in":"path","description":"id of the donor","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031},{"name":"appointmentId","in":"path","description":"id of the appointment","required":true,"schema":{"type":"integer","format":"int32"},"example":123}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppointmentModel"}}}},"404":{"description":"Data not found"}},"security":[{"httpAuthenticationBearer":[]}]},"put":{"tags":["Donor"],"summary":"Reschedule donor appointment","operationId":"rescheduleAppointment","parameters":[{"name":"donorId","in":"path","description":"id of the donor","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031},{"name":"appointmentId","in":"path","description":"id of the appointment to cancel","required":true,"schema":{"type":"integer","format":"int32"},"example":123}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookAppointmentModel"}}},"required":true},"responses":{"200":{"description":"Successful operation"},"400":{"description":"Appointment already canceled"},"404":{"description":"Data not found"}},"security":[{"httpAuthenticationBearer":[]}]},"delete":{"tags":["Donor"],"summary":"Cancel donor appointment","operationId":"cancelAppointment","parameters":[{"name":"donorId","in":"path","description":"id of the donor","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031},{"name":"appointmentId","in":"path","description":"id of the appointment to cancel","required":true,"schema":{"type":"integer","format":"int32"},"example":123}],"responses":{"200":{"description":"Successful operation"},"400":{"description":"Appointment already canceled"},"404":{"description":"Data not found"}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/donors/{donorId}/appointments":{"get":{"tags":["Donor"],"summary":"Get donor appointments","operationId":"getDonorAppointments","parameters":[{"name":"donorId","in":"path","description":"Verified donor id","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentModel"}}}}},"404":{"description":"Donor not found"}},"security":[{"httpAuthenticationBearer":[]}]},"post":{"tags":["Donor"],"summary":"Book donor appointment","operationId":"bookAppointment","parameters":[{"name":"donorId","in":"path","description":"Donor to book the appointment for","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookAppointmentModel"}}},"required":true},"responses":{"200":{"description":"Successful operation"},"400":{"description":"Appointment slot already taken"},"404":{"description":"Data not found"}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/donors/validate":{"post":{"tags":["Donor"],"summary":"Validate donor","operationId":"validateDonorForPortalAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DonorValidationRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"boolean"}}}},"404":{"description":"Donor not found"}}}},"/v1/engage/appointments/request":{"post":{"tags":["Appointment"],"summary":"Request an appointment without registration","operationId":"requestAppointment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestAppointmentModel"}}},"required":true},"responses":{"200":{"description":"Successful operation"},"400":{"description":"Invalid request data"}}}},"/v1/becs/donations/import/{interfaceName}":{"post":{"tags":["Donation Import"],"summary":"Import donation data","description":"Allows submission of a donation record and its ancillary data","operationId":"donationImport","parameters":[{"name":"interfaceName","in":"path","description":"The name of the interface requesting donation data import. This value is assigned and provided by IT Synergistics.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DonationImportModel"}}},"required":true},"responses":{"200":{"description":"All validations passed (potentially with warnings) and import was successful.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"4XX or 5XX":{"description":"A validation error or exception occurred.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"}}}}},"security":[{"httpAuthenticationBearer":[]}]}},"/oauth2/token":{"post":{"tags":["Authentication"],"summary":"Authenticate and obtain an access token","description":"Allows generation of an access token","operationId":"getToken","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/AuthParamsModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AuthResponseModel"}}}}}}},"/version":{"get":{"tags":["Version"],"summary":"Get bexWISE API version information","operationId":"getApiVersion","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v1/engage/drives":{"get":{"tags":["Drive"],"summary":"Query blood drives","description":"Get blood drives from a specific physical location OR account name","operationId":"getDrives","parameters":[{"name":"origin","in":"query","description":"Search from origin, consisting of coordinates (in the format \"latitude, longitude\"), or an address, a zip code, etc.","required":false,"schema":{"type":"string","description":"Search from origin, consisting of coordinates (in the format \"latitude, longitude\"), or an address, a zip code, etc."}},{"name":"searchRadius","in":"query","description":"Maximum search radius from the origin, in miles","required":false,"schema":{"type":"string","description":"Maximum search radius from the origin, in miles"}},{"name":"accountName","in":"query","description":"Account name","required":false,"schema":{"type":"string","description":"Account name"}}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriveModel"}}}}}}}},"/v1/engage/drives/{driveId}":{"get":{"tags":["Drive"],"summary":"Get information for a specified drive","operationId":"getDrive","parameters":[{"name":"origin","in":"query","description":"Google Maps Distance Matrix API-compatible value (address, coords, etc)","required":false,"schema":{"type":"string","description":"Google Maps Distance Matrix API-compatible value (address, coords, etc)"}},{"name":"driveId","in":"path","description":"id of drive to fetch","required":true,"schema":{"type":"string","description":"id of drive to fetch"}},{"name":"driveDate","in":"query","description":"date to query for drive","required":true,"schema":{"type":"string","description":"date to query for drive","example":"2022-12-11"},"example":"2022-12-11"}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DriveModel"}}}},"404":{"description":"Drive not found"}}}},"/v1/engage/drives/{driveId}/appointments":{"get":{"tags":["Drive"],"summary":"Get the appointments for a given drive","operationId":"getAppointmentsForDrive","parameters":[{"name":"driveId","in":"path","description":"id for the drive","required":true,"schema":{"type":"integer","format":"int32"},"example":123},{"name":"driveDate","in":"query","description":"date to query appointment","required":true,"schema":{"type":"string","format":"date-time"},"example":"2022-12-11"}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriveAppointmentModel"}}}}},"404":{"description":"No appointment data found"}}}},"/v1/engage/donors/{donorId}":{"get":{"tags":["Donor"],"summary":"Get donor details","operationId":"getDonor","parameters":[{"name":"donorId","in":"path","description":"Verified donor id","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DonorModel"}}}},"404":{"description":"Donor not found"}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/donors/{donorId}/getDonorIDBarcode":{"get":{"tags":["Donor"],"summary":"Generates a Barcode containing the Donor ID","operationId":"generateBarcode","parameters":[{"name":"donorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"height","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"width","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"barcodeType","in":"query","required":true,"schema":{"type":"string","enum":["QR","PDF417","CODE128"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/donors/{donorId}/eligibilityDates":{"get":{"tags":["Donor"],"summary":"Get donor eligibility dates","operationId":"getDonorEligibilityDates","parameters":[{"name":"donorId","in":"path","description":"Verified donor id","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DonorAppointmentTypeEligibilityModel"}}}}},"404":{"description":"Donor not found"}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/donors/{donorId}/donations":{"get":{"tags":["Donor"],"summary":"Get donor donations","operationId":"getDonorDonations","parameters":[{"name":"donorId","in":"path","description":"Verified donor id","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DonationModel"}}}}},"404":{"description":"Donor not found"}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/donors/{donorId}/contactPreferences":{"get":{"tags":["Donor"],"summary":"Get donor contact preferences","operationId":"getDonorContactPreferences","parameters":[{"name":"donorId","in":"path","description":"Verified donor id","required":true,"schema":{"type":"integer","format":"int32"},"example":10010031}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DonorContactPreferenceModel"}}}}},"404":{"description":"Donor not found"}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/engage/center":{"get":{"tags":["Center"],"summary":"Retrieves information about the blood center","operationId":"getCenter","responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CenterModel"}}}},"404":{"description":"Center not found"}}}},"/v1/engage/accounts/{accountCode}":{"get":{"tags":["Account"],"summary":"Get account information","operationId":"getAccount","parameters":[{"name":"accountCode","in":"path","description":"accountCode of the account to retrieve","required":true,"schema":{"type":"string"},"example":10865}],"responses":{"200":{"description":"Successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountModel"}}}},"404":{"description":"Account not found"}}}},"/v1/becs/locations":{"get":{"tags":["Location"],"summary":"Get all locations","description":"Allows retrieval of all location data","operationId":"getAllLocations","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupLocation"}}}}}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/becs/donation-orders":{"get":{"tags":["Donation Order"],"summary":"Get all donation orders","description":"Allows retrieval of all donation order data","operationId":"getAllDonationOrders","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DonationOrder"}}}}}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/becs/doctors":{"get":{"tags":["Doctors"],"summary":"Get all doctors","description":"Allows retrieval of all doctor data","operationId":"getAllDoctors","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Doctor"}}}}}},"security":[{"httpAuthenticationBearer":[]}]}},"/v1/becs/collections":{"get":{"tags":["Collection"],"summary":"Get all collections","description":"Allows retrieval of all collection data","operationId":"getAllCollections","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}}}}}},"security":[{"httpAuthenticationBearer":[]}]}}},"components":{"schemas":{"BookAppointmentModel":{"type":"object","properties":{"driveId":{"type":"integer","format":"int32","example":123},"driveDate":{"type":"string","format":"date","example":"2023-01-28"},"appointmentSlotId":{"type":"integer","format":"int32","example":39}}},"DonorValidationRequestModel":{"type":"object","properties":{"firstName":{"type":"string","example":"Herman"},"lastName":{"type":"string","example":"Munster"},"emailAddress":{"type":"string","example":"hmunster@aol.com"},"donorId":{"type":"integer","format":"int32","example":10010031},"dateOfBirth":{"type":"string","format":"date","example":"2023-01-28"}}},"RequestAppointmentModel":{"required":["address","appointmentSlotId","dateOfBirth","driveDate","driveId","emailAddress","firstName","lastName","phoneNumber","sex"],"type":"object","properties":{"firstName":{"type":"string","example":"Herman"},"lastName":{"type":"string","example":"Munster"},"sex":{"type":"string","example":"M"},"dateOfBirth":{"type":"string","format":"date","example":"2023-01-28"},"address":{"type":"string","example":"1313 Mockingbird Lane Los Angeles, CA 12345"},"phoneNumber":{"maxLength":10,"type":"string","example":"5555555555"},"emailAddress":{"type":"string","example":"user@example.com"},"driveId":{"type":"integer","description":"Must be a valid drive id.","format":"int32","example":123},"driveDate":{"type":"string","description":"Must match the drive's date.","format":"date","example":"2023-01-28"},"appointmentSlotId":{"type":"integer","format":"int32","example":1}}},"ResponseModel":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}}}},"ErrorResponseModel":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}},"DonationAttachment":{"required":["data","donationId","fileName","techId"],"type":"object","properties":{"description":{"maxLength":100,"type":"string","example":"Attachment Description"},"techId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"data":{"type":"string","description":"Data provided must be Base64 Encoded.","example":"dGVzdA=="},"donationId":{"type":"integer","description":"Only required if Donation Attachment is not imported with a Donation.","format":"int32","example":123},"fileName":{"maxLength":200,"type":"string","description":"Must have a valid file extension.","example":"test.pdf"}},"description":"Donation Attachments must be provided with a Donation."},"DonationComment":{"required":["originCode","techId","text"],"type":"object","properties":{"originCode":{"type":"string","description":"Valid Origin Codes are BPR (Blood Pressure), HCT (Hematocrit), HGB (Hemoglobin),\nPLE (Pulse Evaluation), PUL (Pulse), and TMP (Temperature).","example":"TMP"},"text":{"maxLength":1000,"type":"string","example":"Example Text"},"techId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"}},"description":"Donation Comments must be provided with a Donation."},"DonationDIN":{"required":["stickNumber","unitNumber"],"type":"object","properties":{"donationId":{"type":"integer","description":"Only required if Donation DIN is not imported with a Donation.","format":"int32","example":123},"unitNumber":{"type":"string","description":"Must be a valid ISBT unit number.","example":"W123404000002"},"stickNumber":{"type":"integer","description":"Must be a whole number. Must have sequential entries starting with 1.","format":"int32","example":1},"fdaNumber":{"type":"string","description":"Must be a valid FDA Number.","example":"1234567"},"bagManufacturer":{"type":"string","description":"Must be a valid bag manufacturer code.","example":"BAX"},"bagType":{"type":"string","description":"Must be a valid bag type code.","example":"52"},"bagLotNumber":{"maxLength":20,"type":"string","example":"10001-1"},"numberOfTubes":{"type":"integer","description":"Must be a positive integer.","format":"int32","example":3},"entryTechId":{"type":"string","description":"Must be a valid employee code. Defaults to '***'.","example":"***"},"entryDateTime":{"type":"string","format":"date","example":"2000-01-01"},"instrumentSerialNumber":{"type":"string","description":"Must be a valid serial number.","example":"123456"}},"description":"Donation DINs must be provided with a Donation."},"DonationImportModel":{"type":"object","properties":{"donor":{"$ref":"#/components/schemas/Donor"},"donation":{"$ref":"#/components/schemas/DonationModel"},"dins":{"type":"array","items":{"$ref":"#/components/schemas/DonationDIN"}},"phlebs":{"type":"array","items":{"$ref":"#/components/schemas/DonationPhleb"}},"deferrals":{"type":"array","items":{"$ref":"#/components/schemas/DonorDeferral"}},"donationAttachments":{"type":"array","items":{"$ref":"#/components/schemas/DonationAttachment"}},"donationComments":{"type":"array","items":{"$ref":"#/components/schemas/DonationComment"}},"donorComments":{"type":"array","items":{"$ref":"#/components/schemas/DonorComment"}},"donationOrders":{"type":"array","items":{"$ref":"#/components/schemas/DonationOrder"}},"donorAttachments":{"type":"array","items":{"$ref":"#/components/schemas/DonorAttachment"}},"reactions":{"type":"array","items":{"$ref":"#/components/schemas/DonationReaction"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}},"DonationModel":{"required":["collectionCode","collectionDate","donorId","regEnteredDate"],"type":"object","properties":{"donorId":{"type":"integer","description":"Only required if Donation is not imported with a Donor.","format":"int32","example":12345678},"registrarId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"donationType":{"type":"string","description":"Valid values are \"D\" (Directed), \"T\" (Therapeutic), \"G\" (Allogeneic), \"U\" (Autologous),\n\"S\" (Source), and \"R\" (Research).","example":"G"},"historianId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"examinerId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"collectionCode":{"type":"string","description":"Must be a valid collection code.","example":"041107-SBC"},"donationProcedure":{"type":"string","description":"Must be a valid donation procedure.","example":"WB"},"orderId":{"type":"integer","description":"Must be a valid donation order.","format":"int32","example":123},"pulse":{"type":"integer","description":"Format: ###","format":"int32","example":80},"temperature":{"type":"number","description":"Format: ###.#","example":98.1},"cuSO4":{"maxLength":1,"type":"string","example":"P"},"hemoglobin":{"type":"number","description":"Format: ##.#","example":15.0},"hematocrit":{"type":"integer","description":"Format: ##","format":"int32","example":55},"armCondition":{"type":"string","description":"Must be 'S' (Satisfactory) or 'U' (Unsatisfactory).","example":"S"},"systolic":{"type":"integer","description":"Must be provided with diastolic.","format":"int32","example":110},"diastolic":{"type":"integer","description":"Must be provided with systolic.","format":"int32","example":80},"closedById":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"creditToLocationCode":{"type":"string","description":"Must be a valid group location code.","example":"SBC"},"instrument":{"type":"string","description":"Must be a valid instrument code.","example":"ALYX"},"creditToPlanOwnerId":{"type":"integer","description":"Must be a valid donor ID.","format":"int32","example":12345678},"proofOfParentalConsent":{"type":"boolean","default":false},"techIdPulse":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techIdBp":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techIdTemp":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"height":{"type":"integer","description":"Must be provided in inches. Must be a whole number.","format":"int32","example":60},"medComments":{"maxLength":2000,"type":"string","example":"This is a comment."},"weight":{"type":"integer","description":"Must be provided in pounds. Must be a whole number.","format":"int32","example":160},"actualWeight":{"type":"boolean","default":false},"actualHeight":{"type":"boolean","default":false},"cholesterolTotal":{"type":"number","description":"Format: ###.##","example":223.0},"directedCrossover":{"type":"boolean","default":false},"externalVendorDonationId":{"maxLength":50,"type":"string","example":"12345"},"pulse2":{"type":"integer","description":"For second reading. First reading must be provided.","format":"int32","example":67},"systolic2":{"type":"integer","description":"For second reading. First reading must be provided.","format":"int32","example":110},"diastolic2":{"type":"integer","description":"For second reading. First reading must be provided.","format":"int32","example":70},"temperature2":{"type":"number","description":"For second reading. First reading must be provided.","example":98.0},"hemoglobin2":{"type":"number","description":"For second reading. First reading must be provided.","example":15.0},"hematocrit2":{"type":"integer","description":"For second reading. First reading must be provided.","format":"int32","example":55},"origDonationProcedure":{"type":"string","description":"Must be a valid donation procedure.","example":"WB"},"techIdHct":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techIdHgb":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"questionnaireStatus":{"type":"string","description":"Must be set to 'D' (DHQ on File) or 'U' (Not Required). Defaults to 'D'.","example":"D"},"consentStatus":{"type":"string","description":"Must be set to 'D' (DHQ on File) or 'N' (Not Required). Defaults to 'D'.","example":"D"},"userDefined":{"maxLength":250,"type":"string"},"creditToComment":{"maxLength":256,"type":"string"},"vehicle":{"type":"string","description":"Must be a valid vehicle.","example":"BUS1"},"cuSO42":{"maxLength":1,"type":"string","example":"P"},"techIdCuSO4":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techId2CuSO4":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techId2Pulse":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techId2Bp":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techId2Temp":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techId2Hct":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techId2Hgb":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"plateletCount":{"type":"integer","description":"Must be a positive integer.","format":"int32","example":100},"resolvedComment":{"maxLength":2000,"type":"string","example":"This is an example comment."},"pulseEvaluation":{"maxLength":10,"type":"string","example":"OK"},"pulseEvaluation2":{"maxLength":10,"type":"string","example":"OK"},"techIdMeasurements":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"techIdPlateletCount":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"collectionDate":{"type":"string","example":"2000-01-01T13:00"},"regEnteredDate":{"type":"string","example":"2000-01-01T13:00"},"medEnteredDate":{"type":"string","example":"2000-01-01T13:00"},"examEnteredDate":{"type":"string","example":"2000-01-01T13:00"},"donationClosedDate":{"type":"string","example":"2000-01-01T13:00"},"consentSignatureMissing":{"type":"boolean","default":true},"medicalSignatureMissing":{"type":"boolean","default":true}}},"DonationOrder":{"required":["doctorId","enteredBy"],"type":"object","properties":{"donorId":{"type":"integer","description":"Must be provided or have an accompanying donor object.","format":"int32","example":123456789},"comment":{"maxLength":250,"type":"string","example":"This is a comment."},"dateOrdered":{"type":"string","format":"date","example":"2000-01-01"},"dateNeeded":{"type":"string","format":"date","example":"2000-01-01"},"surgeryDate":{"type":"string","format":"date","example":"2000-01-01"},"surgicalProc":{"maxLength":50,"type":"string","example":"Hip replacement"},"nbrUnitsReq":{"type":"integer","description":"Must be a positive integer.","format":"int32","example":3},"donationCutoffHours":{"type":"integer","description":"Must be a positive integer.","format":"int32","example":72},"hospitalCode":{"type":"string","description":"Must be a valid hospital code.","example":"A001"},"expirationDate":{"type":"string","format":"date","example":"2000-01-01"},"hospitalPatientId":{"maxLength":20,"type":"string","example":"123456"},"enteredBy":{"type":"string","description":"Must be a valid employee code.","example":"A01"},"doctorId":{"type":"array","example":[1,2],"items":{"type":"integer","format":"int32"}},"attachments":{"type":"array","description":"Donation Order Attachments must be provided with the Donation Order.","items":{"$ref":"#/components/schemas/DonationOrderAttachment"}}},"description":"Donation Order must be provided with a Donation."},"DonationOrderAttachment":{"required":["data","fileName","orderId","techId"],"type":"object","properties":{"description":{"maxLength":100,"type":"string","example":"Attachment Description"},"techId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"data":{"type":"string","description":"Data provided must be Base64 Encoded.","example":"dGVzdA=="},"orderId":{"type":"integer","description":"Only required if Donation Order Attachment is not imported with a Donation Order.","format":"int32","example":123},"fileName":{"maxLength":200,"type":"string","description":"Must have a valid file extension.","example":"test.pdf"}},"description":"Donation Order Attachments must be provided inside Donation Orders."},"DonationPhleb":{"required":["phlebotomistId","stickNbr","unitNbr"],"type":"object","properties":{"donationId":{"type":"integer","description":"Only required if Donation Phleb is not imported with a Donation.","format":"int32","example":123},"stickNbr":{"type":"integer","description":"Must be a whole number. Must have sequential entries starting with 1.","format":"int32","example":1},"arm":{"type":"string","description":"Valid values are L (left), R (right), or B (both).","example":"L"},"unitNbr":{"type":"string","description":"Must be a valid ISBT unit number.","example":"W123404000005"},"phlebotomistId":{"type":"string","description":"Must be a valid employee code.","example":"A01"},"failureCode":{"type":"string","description":"Must be a validate failure code.","example":"QNS"},"drawVolMl":{"type":"integer","description":"Total volume loss for this phlebotomy stick. Provide either the total draw volume here, or separate RBC/Plasma volume loss values to have the total volume loss calculated.","format":"int32","example":350},"rbcLossMl":{"type":"integer","description":"RBC volume loss for this phlebotomy stick. plasmaLossMl must also be provided.","format":"int32","example":250},"plasmaLossMl":{"type":"integer","description":"Plasma volume loss for this phlebotomy stick. rbcLossMl must also be provided.","format":"int32","example":100},"phlebBatchId":{"type":"string","description":"Must be a valid employee code.","example":"A01"},"donationProcedure":{"type":"string","description":"Must be a valid donation procedure.","example":"WB"},"instrument":{"type":"string","description":"Must be a valid instrument.","example":"SC1"},"techIdStart":{"type":"string","description":"Must be a valid employee code.","example":"A01"},"techIdStop":{"type":"string","description":"Must be a valid employee code.","example":"A01"},"techIdBag":{"type":"string","description":"Must be a valid employee code.","example":"A01"},"instrumentSerialNbr":{"type":"string","description":"Must be a valid instrument serial number.","example":"A01"},"sentForTesting":{"type":"boolean","description":"If failure code is not provided, this is automatically set to true."},"ineligibleProcedure":{"type":"boolean","default":false},"fdaNumber":{"maxLength":20,"type":"string","example":"1234567"},"startTime":{"type":"string","example":"2000-01-01T12:00"},"stopTime":{"type":"string","example":"2000-01-01T13:00"},"phlebEnteredDate":{"type":"string","format":"date"}},"description":"Donation Phleb must be provided with a Donation."},"DonationReaction":{"required":["assignedBy","dataEnteredBy","reactionCode","reportedDate"],"type":"object","properties":{"donationId":{"type":"integer","description":"Only required if Reaction is not imported with a Donation.","format":"int32","example":123},"reactionCode":{"type":"string","description":"Must be a valid reaction code.","example":"LH"},"comments":{"maxLength":250,"type":"string","example":"This is a comment."},"reportedDate":{"type":"string","format":"date","example":"2000-01-01"},"entryDate":{"type":"string","description":"Defaults to current date.","format":"date","example":"2000-01-01"},"assignedBy":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"dataEnteredBy":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"notifyForFutureDonationDate":{"type":"string","format":"date","example":"2000-01-01"},"witnessedBy":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"}},"description":"Donation Reaction must be provided with a Donation."},"Donor":{"required":["birthDate","city","firstName","lastName","sex","state","streetAddress","zipCode"],"type":"object","properties":{"donorId":{"maxLength":9,"type":"integer","description":"Provide a Donor ID only for modifying a Donor.","format":"int32","example":123456789},"alternateId":{"maxLength":20,"type":"string","description":"Alt ID 1.","example":"456999"},"lastName":{"maxLength":30,"type":"string","example":"Doe"},"priorLastName":{"type":"array","description":"If provided, must be an array. For modified donors, all prior last names that are not provided but currently exist for the donor will be deleted.","example":["Doe","Johnson"],"items":{"type":"string"}},"firstName":{"maxLength":20,"type":"string","example":"John"},"middleInit":{"maxLength":20,"type":"string","description":"Set to blank if not provided.","example":"X"},"title":{"type":"string","description":"Must be a valid title.","example":"MR."},"streetAddress":{"maxLength":30,"type":"string","description":"Set to blank if not provided.","example":"1234 Anywhere St."},"city":{"maxLength":30,"type":"string","description":"Set to blank if not provided.","example":"Anywhere"},"state":{"maxLength":2,"type":"string","description":"Set to blank if not provided.","example":"NY"},"zipCode":{"type":"string","description":"Must be a valid zip code.","example":"11766"},"county":{"maxLength":30,"type":"string","example":"Anywhere"},"homePhone":{"maxLength":10,"minLength":7,"type":"string","description":"Must be only numbers. Cannot start with 0.","example":"1234567890"},"homeExt":{"maxLength":5,"type":"string","description":"Must be numbers. Cannot start with 0.","example":"123"},"businessPhone":{"maxLength":10,"minLength":7,"type":"string","description":"Must be only numbers. Cannot start with 0.","example":"1234567890"},"busExt":{"maxLength":5,"type":"string","description":"Must be numbers. Cannot start with 0.","example":"123"},"emailHome":{"maxLength":50,"type":"string","description":"@ must be present in e-mail.","example":"test@example.com"},"bloodType":{"maxLength":3,"type":"string","description":"Cannot be modified on existing donor. Example values: A P, B N, O P, and ABP","example":"ABN"},"sex":{"maxLength":1,"type":"string","description":"Valid values are 'M' (male), 'F' (female), and 'X' (other).","example":"M"},"race":{"maxLength":6,"type":"string","description":"Must be valid race code.","example":"A"},"willingCode":{"maxLength":2,"type":"string","description":"Must be valid willing code.","example":"NW"},"homeCallCode":{"maxLength":2,"type":"string","description":"Must be valid call code.","example":"E"},"businessCallCode":{"maxLength":2,"type":"string","description":"Must be valid call code.","example":"M"},"donorClass":{"type":"array","description":"If provided, must be an array. For modified donors, all donor classes that are not provided but currently exist for the donor will be deleted. Each element must be a valid donor class.","example":["WB","PH"],"items":{"type":"string"}},"otherDonationsWb":{"type":"integer","description":"Must be a positive integer.","format":"int32"},"otherDonationsApheresis":{"type":"integer","description":"Must be a positive integer.","format":"int32"},"familyPlanOwner":{"type":"boolean","description":"Cannot be modified on an existing donor.","default":false},"emailBusiness":{"maxLength":50,"type":"string","description":"@ must be present in e-mail.","example":"test@example.com"},"nameSuffix":{"maxLength":10,"type":"string","example":"III"},"hemachromatosis":{"type":"boolean","default":false},"nickName":{"maxLength":30,"type":"string","example":"Tester"},"cellCallCode":{"type":"string","description":"Must be a valid call code.","example":"M"},"cellPhone":{"maxLength":10,"minLength":7,"type":"string","description":"Must be only numbers. Cannot start with 0.","example":"1234567890"},"cmvNeg":{"type":"boolean","description":"Cannot be modified on an existing donor.","default":false},"traliSuspect":{"type":"boolean"},"externalVendorDonorId":{"type":"string","description":"Automatically set on new donors.","example":"12345"},"contactPreferences":{"type":"array","description":"If provided, must be an array. For modified donors, all contact preferences that are not provided but currently exist for the donor will be deleted. Each element must be a valid donor contact preference.","example":["BE","HP"],"items":{"type":"string"}},"addressTwo":{"maxLength":50,"type":"string","example":"123 Anywhere St."},"countryCode":{"maxLength":10,"type":"string","example":"USA"},"socialSecurity":{"maxLength":30,"type":"string","description":"Represents Alt ID 2. SSNs should NOT be stored in this field.","example":"ABC12345"},"birthDate":{"type":"string","format":"date","example":"2000-01-01"},"nextCallDate":{"type":"string","format":"date","example":"2000-01-01"},"lastModifiedDate":{"type":"string","example":"2000-01-01T13:00"},"eligibleDate":{"type":"string","format":"date","example":"2000-01-01"},"newlyAddedDate":{"type":"string","description":"Automatically set for new donors.","example":"2000-01-01T13:00"},"deferralDate":{"type":"string","description":"Date calculate if deferrals provided.","example":"2000-01-01T13:00"},"callMeDate":{"type":"string","format":"date","example":"2000-01-01"}},"description":"An object representation of a Donor."},"DonorAttachment":{"required":["data","donorId","fileName","techId"],"type":"object","properties":{"description":{"maxLength":100,"type":"string","example":"Attachment Description"},"techId":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"data":{"type":"string","description":"Data provided must be Base64 Encoded.","example":"dGVzdA=="},"donorId":{"type":"integer","description":"Only required if Donor Attachment is not imported with a Donor.","format":"int32","example":12345678},"fileName":{"maxLength":200,"type":"string","description":"Must have a valid file extension.","example":"test.pdf"}},"description":"Donor Attachments must be provided with a Donor."},"DonorComment":{"required":["commentType","comments","enteredById"],"type":"object","properties":{"expirationDate":{"type":"string","description":"Can only be set if warnable is true","example":"2000-01-01T13:00"},"warn":{"type":"boolean","description":"Must be set to true if expiration date is provided"},"commentType":{"type":"string","description":"Must be a valid comment type","example":"L"},"comments":{"maxLength":250,"type":"string","example":"Example Comment"},"enteredById":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"}},"description":"Donor Comments must be provided with a Donation."},"DonorDeferral":{"required":["deferralCode","deferredById","effectiveDate"],"type":"object","properties":{"deferralCode":{"type":"string","description":"Must be a valid deferral code.","example":"INDEF"},"comments":{"maxLength":250,"type":"string","example":"This is a comment."},"deferredById":{"maxLength":10,"type":"string","description":"Must be a valid employee code.","example":"A01"},"effectiveDate":{"type":"string","description":"Date when the deferral’s effective period begins.  Historical date is supported.","format":"date","example":"2000-01-01"},"reportedDate":{"type":"string","description":"Date when the deferral is reported.","format":"date","example":"2000-01-01"},"entryDate":{"type":"string","description":"Date when the deferral is entered into the system.","example":"2000-01-01T13:00"},"eligibleDate":{"type":"string","description":"Calculated eligibility date based on the deferral’s configured timeframe.","format":"date","example":"2000-01-01"}},"description":"Donor Deferrals must be provided with a Donor."},"Notification":{"required":["notificationPropertyCode"],"type":"object","properties":{"notificationPropertyCode":{"type":"string","description":"Must be a valid notification property code","example":"TEST"},"comment":{"maxLength":250,"type":"string","description":"Must be a valid notification property code","example":"notification"},"din":{"type":"string","description":"Must be provided if FDA Number is provided"},"fdaNumber":{"maxLength":20,"type":"string","description":"Must be matching the FDA Number for the ICCBBA code of DIN","example":"1234567"},"createdTechId":{"maxLength":10,"type":"string","description":"Must be a valid employee code","example":"A01"},"warnable":{"type":"boolean","description":"Must be true if warning expiration date is provided","default":false},"currentOnly":{"type":"boolean","description":"Must be provided with expiration date if true"},"warningExpirationDate":{"type":"string","format":"date","example":"2000-01-01"},"expirationDate":{"type":"string","format":"date","example":"2000-01-01"},"entryDate":{"type":"string","format":"date","example":"2000-01-01"}},"description":"An object representation of a Notification."},"AuthParamsModel":{"type":"object","properties":{"grant_type":{"type":"string","description":"Must be \"client_credentials\""},"client_id":{"type":"string","description":"Your IT Synergistics-provided client_id"},"client_secret":{"type":"string","description":"Your IT Synergistics-provided client_secret"}},"description":"An object required to generate an access token."},"AuthResponseModel":{"type":"object","properties":{"access_token":{"type":"string","example":"QiOiJPT2N5RWZ4YjFmcUtCN0JpVHZOajR1aDl0bWMzdnlRckF2R3NQK1JGVUZNPSIsImFsZyI6IlJTMjU2In0.\nNlIjoiYWNjZXNzIiwic2NvcGUiOiJiZXh3aXNlLWFwaS1yZXNvdeyJzdWIiOJpb2JhaDU4dDA5OTF1cDAxdTY0bfx28-\nE1Ij88z0q8oA44PwvBj5We2lwnMMlPZLbDj2W_ym4DsPlmoaiefQpTCW9r-Nr_jF8N1GaEHfGvuVmVG88fvNlI"},"expires_in":{"type":"string","example":"3600"},"token_type":{"type":"string","example":"Bearer"}}},"AccountModel":{"type":"object","properties":{"accountCode":{"type":"string","example":"12345"},"accountName":{"type":"string","example":"Blood Bank One"}}},"AppointmentTypeSummaryModel":{"type":"object","properties":{"appointmentType":{"type":"string","example":"WB"},"appointmentTypeDescription":{"type":"string","example":"Whole Blood"},"appointmentsRemaining":{"type":"integer","format":"int32","example":9}}},"DriveModel":{"type":"object","properties":{"resultId":{"type":"integer","format":"int32"},"driveId":{"type":"integer","format":"int32","example":123},"driveDate":{"type":"string","format":"date","example":"2023-01-28"},"account":{"$ref":"#/components/schemas/AccountModel"},"location":{"$ref":"#/components/schemas/LocationDistanceModel"},"startTime":{"type":"string","format":"date-time","example":"2023-01-28T09:00:00-05:00"},"endTime":{"type":"string","format":"date-time","example":"2023-01-28T17:00:00-05:00"},"appointmentTypes":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentTypeSummaryModel"}}}},"LocationDistanceModel":{"type":"object","properties":{"locationCode":{"type":"string","example":"10337"},"name":{"type":"string","example":"Cristo Rey Jesuit High School"},"addressOne":{"type":"string","example":"2924 4th Avenue S"},"addressTwo":{"type":"string"},"city":{"type":"string","example":"Minneapolis"},"state":{"type":"string","example":"MN"},"zipCode":{"type":"string","example":"55408"},"phoneNumber":{"type":"string","example":"5555555555"},"locationType":{"$ref":"#/components/schemas/LocationTypeModel"},"distanceFromOriginText":{"type":"string","example":"21.6 mi"},"distanceFromOriginMeters":{"type":"integer","format":"int64","example":34684},"latitude":{"type":"number","format":"float","example":35.83},"longitude":{"type":"number","format":"float","example":-88.91}}},"LocationTypeModel":{"type":"object","properties":{"code":{"type":"string","example":"M"}}},"AppointmentTimeModel":{"type":"object","properties":{"appointmentSlotId":{"type":"integer","format":"int32","example":39},"appointmentTime":{"type":"string","format":"date"},"available":{"type":"boolean","example":false}}},"DriveAppointmentModel":{"type":"object","properties":{"appointmentTypeSummary":{"$ref":"#/components/schemas/AppointmentTypeSummaryModel"},"appointmentTimes":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentTimeModel"}}}},"BloodTypeModel":{"type":"object","properties":{"code":{"type":"string","example":"O N"},"description":{"type":"string","example":"O Negative"},"symbol":{"type":"string","example":"O-"}}},"DonationStatisticModel":{"type":"object","properties":{"yearToDate":{"type":"integer","format":"int32","example":2},"oneYear":{"type":"integer","format":"int32","example":3},"lifetime":{"type":"integer","format":"int32","example":7}}},"DonationTotalsModel":{"type":"object","properties":{"wholeBlood":{"$ref":"#/components/schemas/DonationStatisticModel"},"pheresis":{"$ref":"#/components/schemas/DonationStatisticModel"},"credits":{"$ref":"#/components/schemas/DonationStatisticModel"}}},"DonorModel":{"type":"object","properties":{"donorId":{"type":"integer","format":"int32","example":10010031},"firstName":{"type":"string","example":"Herman"},"lastName":{"type":"string","example":"Munster"},"middleInit":{"type":"string","example":"P"},"nickName":{"type":"string","example":"Shorty"},"birthDate":{"type":"string","example":"2023-01-28"},"sex":{"$ref":"#/components/schemas/SexModel"},"race":{"$ref":"#/components/schemas/RaceModel"},"address":{"type":"string","example":"1313 Mockingbird Lane"},"city":{"type":"string","example":"New York"},"state":{"type":"string","example":"NY"},"zipCode":{"type":"string","example":"11379"},"homePhone":{"type":"string","example":"5555555555"},"businessPhone":{"type":"string","example":"5555555555"},"cellPhone":{"type":"string","example":"5555555555"},"email":{"type":"string","example":"user@domain.com"},"workEmail":{"type":"string","example":"user@domain.com"},"bloodType":{"$ref":"#/components/schemas/BloodTypeModel"},"cmvNegative":{"type":"string","example":"Negative","enum":["Positive","Negative","Untested"]},"donationTotals":{"$ref":"#/components/schemas/DonationTotalsModel"},"donorCharacteristics":{"type":"array","example":"Allergic to latex","items":{"type":"string"}},"donorRecruitment":{"type":"array","example":"Hard of hearing","items":{"type":"string"}}}},"RaceModel":{"type":"object","properties":{"code":{"type":"string","example":"A"},"description":{"type":"string","example":"Asian"}}},"SexModel":{"type":"object","properties":{"code":{"type":"string","example":"M"},"description":{"type":"string","example":"Male"}}},"DonorAppointmentTypeEligibilityModel":{"type":"object","properties":{"appointmentTypeDescription":{"type":"string","example":"Whole Blood"},"appointmentType":{"type":"string","example":"WB"},"instrumentCode":{"type":"string","example":"HEMO"},"instrumentDescription":{"type":"string","example":"Hemoflow"},"eligibleDate":{"type":"string","format":"date-time","example":"2023-01-28T00:00:00-05:00"}}},"DonorContactPreferenceModel":{"type":"object","properties":{"contactPreferenceCode":{"type":"string","example":"HP"},"contactPreferenceDescription":{"type":"string","example":"Home Phone"}}},"AppointmentModel":{"type":"object","properties":{"appointmentId":{"type":"integer","format":"int32","example":123},"donorId":{"type":"integer","format":"int32","example":10010031},"appointmentSlotId":{"type":"integer","format":"int32","example":46},"appointmentDateTime":{"type":"string","format":"date"},"appointmentType":{"type":"string","example":"WB"},"appointmentTypeDescription":{"type":"string","example":"Whole Blood"},"drive":{"$ref":"#/components/schemas/DriveModel"},"madeBy":{"type":"string","example":"JONES"},"outcome":{"type":"string","example":"Canceled"}}},"CenterModel":{"type":"object","properties":{"code":{"type":"string","example":"ITSy"},"name":{"type":"string","example":"ITSy Blood Center"},"mailingAddress1":{"type":"string","example":"P.O. Box 123"},"mailingAddress2":{"type":"string"},"mailingAddressCity":{"type":"string","example":"Flowood"},"mailingAddressState":{"type":"string","example":"MS"},"mailingAddressZip":{"type":"string","example":"12345"},"physicalAddress1":{"type":"string","example":"115 Tree St."},"physicalAddress2":{"type":"string"},"physicalAddressCity":{"type":"string","example":"Flowood"},"physicalAddressState":{"type":"string","example":"MS"},"physicalAddressZip":{"type":"string","example":"12345"},"phoneNumber":{"type":"string","example":"5555555555"},"contact":{"type":"string","example":"itsy@itsynergistics.com"},"websiteUrl":{"type":"string","example":"www.itsynergistics.com"},"socialNetworks":{"type":"array","items":{"$ref":"#/components/schemas/SocialNetworkModel"}}}},"SocialNetworkModel":{"type":"object","properties":{"name":{"type":"string","example":"Twitter"},"url":{"type":"string","example":"www.twitter.com/test"}}},"GroupLocation":{"type":"object","properties":{"groupLocationId":{"type":"integer","format":"int32","example":1},"name":{"type":"string","example":"ITSy Blood Center Main"},"locationCode":{"type":"string","example":"SBC"}}},"Doctor":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1},"title":{"type":"string","example":"MR."},"lastName":{"type":"string","example":"Doctor"},"firstName":{"type":"string","example":"Example"},"middleName":{"type":"string","example":"X"},"addressOne":{"type":"string","example":"1 Main St."},"addressTwo":{"type":"string"},"city":{"type":"string","example":"Union"},"state":{"type":"string","example":"NJ"},"zipCode":{"type":"string","example":"12345"},"attnTo":{"type":"string","example":"Dr. John Doctor"},"primaryPhone":{"type":"string","example":"1234567890"},"secondaryPhone":{"type":"string","example":"1234567890"},"emailAddress":{"type":"string","example":"doctor@gmail.com"},"comment":{"type":"string","example":"This is a comment."},"status":{"type":"string","example":"A"},"fax_number":{"type":"string","example":"1234567890"}},"description":"An object representation of a Doctor."},"Collection":{"type":"object","properties":{"collectionId":{"type":"integer","format":"int32"},"collectionCode":{"type":"string"},"collectionDate":{"type":"string","format":"date-time"},"groupLocationId":{"type":"integer","format":"int32"},"sponsorGroupCode":{"type":"string"},"description":{"type":"string"},"startDraw":{"type":"string","format":"date-time"},"stopDraw":{"type":"string","format":"date-time"}}}},"securitySchemes":{"httpAuthenticationBearer":{"type":"http","in":"header","scheme":"bearer"},"httpAuthenticationBasic":{"type":"http","in":"header","scheme":"basic"}}}}