Patient Request Fields

📃
Note:
An empty string "" is considered a value and validation rules will apply (length/valid code/etc). Only null or missing elements will use default values.

Patient

Field	Type	Character Limit	Required/Optional	Description
patientKey	String	50	Required	Unique patient ID in Client system.
firstName	String	50	Required	Patient's first name.
lastName	String	50	Required	Patient's last name.
birthDate	Date-time	YYYY-MM-DD	Required	Patient's Date of Birth
gender	String	1	Required	Patient’s Gender – M, F or U
address	Object		Required	Object containing patient’s address information. See Address table.
contact	Object		Required	Object containing patient’s contact information. See Contact table.
allergies	Array		Required	Array containing patient’s allergy information. See the Allergies table for valid list of allergies.
externalMedications	Array		Optional	Array containing patient’s external medications objects. List any external Medications the patient is taking for pharmacy to know if there is any drug interaction. If there are external medications, then ensure all the object elements are populated. See External Medications table.

Address

Field	Type	Character Limit	Required/Optional	Description
addressType	String	15	Optional	Defines the type of address. If the filed is not sent by client, then defaults to HOME. Valid values include HOME, PRIMARY OFFICE, TEMPORARY, CORPORATE, ALTERNATE
line1	String	40	Required	Street Address
line2	String	40	Optional	Street Address
line3	String	40	Optional	Street Address
city	String	20	Required	City
state	String	2	Required	US State Abbreviation Code
zipCode	String	5	Required	Format NNNNN
countryCode	String	2	Optional	ISO-3166 2 character country code. Defaults to US.
defaultAddress	Boolean	1	Optional	Values = true/false. When the address is to be used as the default address for patient, then populate True; otherwise default to FALSE.

Contact

Field	Type	Character Limit	Required/Optional	Description
contactType	String	15	Optional	Patient Contact – Phone, Home Phone, Day Phone, Work Phone, Fax Number, Cellular Number, Alternate
contactAddress	String	10	Required	Contact Details. For instance: Populate phone number if contact type is phone. Format:XXXXXXXXXX

Allergies

Field	Type	Character Limit	Required/Optional	Description
allergies	String/[Array]	40(each)	Required	See valid allergy types below


NO KNOWN	ACE INHIBITORS	ACETAMINOPHEN
AMOXICILLIN	ASPIRIN	BETA ADRENERGIC BLOCKERS
CEPHALOSPORINS	CODEINE	ERYTHROMYCIN
IODIDES	IODINATED DIAGNOSTIC AGENTS	MEPERIDINE AND RELATED
MISC. SULFONAMIDE CONTAINING COMPOUNDS	PENICILLINS	QUINOLONES
SHELLFISH-DERIVED PRODUCTS	STATINS	SULFA
TETRACYCLINES	IBUPROFEN

📃
Additional Allergy Information
Allergy information not matching the defined allergy list will still be accepted. However the information will be added in the HealthDyne system under the "notes" section of the Patient's profile for pharmacist to review. Each non-defined allergy list entry has a 40 character limit.

External Medications

Field	Type	Character Limit	Required/Optional	Description
ndc	String	11	Required	NDC of the medication
startDate	Date-time	YYYY-MM-DD	Optional	Date when medication was started
endDate	Date-time	YYYY-MM-DD	Optional	Date when medication was ended

Updated 2 months ago