Recommendation Object

recommendations are the mechnism by which practitioners create prescriptions to suggest supplements to their patients once a recommendation is sent via email, it remains accessible to the patient in their store dashboard they may reorder these recommendations at any given time addtiionally the practitioner may specify a recurrening schedule to automatically ship refills at automatic intervals creating recommendations requires a patient id , so a patient record must be created prior to creating a recommendation { "recommendation id" "38e71539 fbd3 499e 94dd 04c6dde01b40", "patient" { "patient id" 71, "firstname" "jon", "lastname" "doe", "email" "jon doe\@example com" }, "patient id" "71", "practice id" "56209", "note" "recommendation for john doe", "status" "pending", "notify email" 1, "notify sms" 0, "notify at" "", "notify status" "queued", "practice conversion url" "https //my practice com/admin/dispensary/recommendation/convert/rid/38e71539 fbd3 499e 94dd 04c6dde01b40", "patient conversion url" "https //my practice com/dispensary/recommendation/convert/rid/38e71539 fbd3 499e 94dd 04c6dde01b40", "items" \[ { "item id" "ae483c8c 11b5 4aa7 871f 17080ab7cdb4", "sku" "sp907", "qty" 1, "note" "take 1 in the morning and 1 at bedtime ", "autoship" 1, "autoship interval" "30d", "fullfillment type" "1l", "availability" "in stock", "doctor id" 25, "location id" 123 "additional options" \[] } ] } core attributes recommendation id string the main identifier uuid for this object patient object patient id integer the identifier for the patient this recommendation is associated with the integer value is unique per instance and interchangeable with the customer id in core magento api calls once a recommendation is created for a patient, it cannot be re assigned to another patient firstname string patient's first name same as magento customer firstname lastname string patient's last name same as magento customer lastname email string patients email address same as magento customer email practice id integer the identifier for the practice which this recommendation has been created by the integer value is unique per instance and interchangeable with the store id in core magento api calls the practice id does not need to be submitted when creating recommendations and is automatically determined by scope path variable of the request note string a personalized note to the patient, which is sent in emailed recommendations and remains visible in the patients recommendations dashboard status string read only read only the transitional status of the recommendation this is a read only attribute possible values are pending and purchased notify email boolean this parameter controls whether an email notification is sent to the patient when the notify endpoint is triggered the system will not send notifications automatically when recommendations are created via the api notify sms boolean this parameter controls whether an sms notification is sent to the patient when the notify endpoint is triggered the system will not send notifications automatically when recommendations are created via the api in order for this call to succeed the patient record must have a valid primary telephone attribute patients are not required to opt in for sms notifications however they are offered to opt out anytime by sending the stop keyword once the stop is requested no further notifications will be sent it is therefore recommended that email notification is always used in combination with sms notification notify status string read only read only this parameter controls the status of nofication possible values include queued and sent if notifications are triggered multipe times, the status always represents the most recent iteration notify at datetime read only read only this attribute parameter controls sending delayed notifications to the patient the format is yyyy mm dd hh\ mm\ ss and specified as utc time items array the items array contains the item details of the recommendation it is possible for this array to by empty as recommendations can be created without an initial item and items may be added or updated on the recommendation after it was created see the recommendation item object attributes for detals additional attributes practice conversion url string read only read only the url which would permit a practitioner to convert the recommendation to a cart and complete the checkout in their web dashboard patient conversion url read only read only https //uat gethealthy store/dispensary/recommendation/convert/rid/38e71539 fbd3 499e 94dd 04c6dde01b40/ the url wich can be used to convert the recommendation to a cart and comple the checkout on the store frontend by the patient this is the primary use case for purchasing recommendations on our platform when appication would like to utilize their own notification system