📃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.
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| scriptKeys | Array | 50 | Required | List of Array of scriptKey(s) (scriptKey is unique Id associated with script request). |
| shipping | Object (shipping) | | Required | Object containing shipping information for the order. |
| insurance | Object (insurance) | | Optional | Optionally specify insurance information to be used on the fill request. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| address | Object (address) | | Required | Object containing address information for order to be shipped to. |
| ShippingCode | String | 10 | Required | Shipping method to be used for the order. See Shipping Codesbelow |
| SaturdayDelivery | Boolean | true/false | Optional | Values: True/False. Saturday Delivery is an option for certain shipping codes, depending on the carrier. To have an order delivered on a Saturday, select the correct Shipping Code and then set this flag to true. |
| SignatureRequired | Boolean | true/false | Optional | Values: True/False. Select the option if the package requires a signature |
| Code | Description | Notes |
|---|
| POS 1C | USPS 1st Class | Saturday delivery |
| POS 1M | USPS Priority | Saturday delivery |
| UPS 1D | UPS Next Day Air (12:00 PM Delivery) | Saturday delivery |
| UPS 1DAM | UPS Next Day Air AM Delivery | Saturday delivery |
| UPS 1S | UPS Next Day Air Saver (3:00 PM Delivery) | Saturday delivery |
| UPS 2D | UPS 2nd Day (12:00 PM Delivery) | Saturday delivery |
| UPS 2DAM | UPS 2nd Day (Morning Delivery) | Saturday delivery |
| UPS GR | UPS Ground | |
| UPS MID | Mail Innovations | |
| UPS 3DS | UPS 3 Day Select | Saturday delivery |
| UPS USG | UPS-USPS Sure Post | Saturday delivery |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| line1 | String | 40 | Required | Street Address |
| line2 | String | 40 | Optional | Street Address |
| line3 | String | 40 | Optional | Street Address |
| city | String | 35 | Required | City |
| state | String | 2 | Required | US State Abbreviation Code |
| zipCode | String | 10 | Required | Format NNNNN or NNNNN-NNNN |
| countryCode | String | 2 | Optional | ISO-3166 2 character country code. Defaults to US. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| planNumber | String | 100 | Required | Insurance plan number to be used on order previously provided by HealthDyne on a create Insurance response. |
| coPay | String | 6 | Required | Payment collected from the patient at checkout. Format "xx.xx" or "xxx.xx" |
| transactionNumber | String | Max | Required | The payment transaction number. This should be the stripe transaction number if payment is managed by HealthDyne. |
| personCode | String | 3 | Optional | Number 0 to 9. |
| relationshipCode | String | 1 | Optional | Number 0 to 9. See relationship code table [below] |
| code | Description |
|---|
| 0 | Relation is NOT SPECIFIED |
| 1 | Relation is CARDHOLDER |
| 2 | Relation is SPOUSE |
| 3 | Relation is CHILD |
| 4 | Relation is OTHER DEPENDENT |
| 5 | Relation is STUDENT DEPENDENT |
| 6 | Relation is DISABLED DEPENDENT |
| 7 | Relation is ADULT DEPENDENT |
| 8 | Relation is SIGNIFICANT OTHER |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| submitted | Array [submitted] | | Optional | Array of submitted Objects containing event details. |
| rxVerified | Array [rxVerified] | | Optional | Array of rxVerified objects containing verified information. |
| rxShipped | Array [rxshipped] | | Optional | Array of rxShipped objects containing tracking/shipping information. |
| rxIssue | Array [rxissue] | | Optional | Array of rxIssue objects containing issued information. |
| rxCanceled | Array [rxcanceled] | | Optional | Array of rxCanceled objects containing cancel reason information. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| scriptKeys | Array | 50 per value | Required | List of Array of scriptKey(s) (scriptKey is unique Id associated with script request). |
| shipping | Object (shipping) | | Required | Object containing shipping information for the order. |
| insurance | Object (insurance) | | Optional | Optionally specify insurance information to be used on the fill request. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| address | Object (address) | | Required | Object containing address information for order to be shipped to. |
| ShippingCode | String | 10 | Required | Shipping method to be used for the order. See Shipping Codesbelow |
| SaturdayDelivery | Boolean | true/false | Optional | Values: True/False. Saturday Delivery is an option for certain shipping codes, depending on the carrier. To have an order delivered on a Saturday, select the correct Shipping Code and then set this flag to true. |
| SignatureRequired | Boolean | true/false | Optional | Values: True/False. Select the option if the package requires a signature |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| message | String | Max | Required | Status messages string. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| scriptsKeys | Object scriptsKeys | 50 per value | Required | List of Array of scriptsKeys Object. |
| shipping | Object (shipping) | | Required | Object containing shipping information for the order. |
| transactionNumber | String | | Required | A unique identifier assigned to each transaction by the client. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| scriptsKey | String | 50 | Required | Unique Id associated with script request |
| patientInsurance | Object patientInsurance | | Required | Object containing shipping information for the order. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| planNumber | String | 10 | Required | An identifier representing a specific insurance or benefit plan associated with a transaction for the client. |
| clientItemCost | Decimal | | Required | The base cost of the item (e.g., medication, product, or service) billed to the client before any additional fees or discounts. |
| clientDispenseFee | Decimal | | Required | A fee charged to the client for the dispensing or handling of the item. |
| clientOtherFee | Decimal | | Required | An additional fee billed to the client that does not fall under item cost or dispensing. |
| clientCoPay | Decimal | | Required | The portion of the transaction that the client is required to pay out-of-pocket. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| address | Object (address) | | Required | Object containing address information for order to be shipped to. |
| ShippingCode | String | 10 | Required | Shipping method to be used for the order. See Shipping Codesbelow |
| SaturdayDelivery | Boolean | true/false | Optional | Values: True/False. Saturday Delivery is an option for certain shipping codes, depending on the carrier. To have an order delivered on a Saturday, select the correct Shipping Code and then set this flag to true. |
| SignatureRequired | Boolean | true/false | Optional | Values: True/False. Select the option if the package requires a signature |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| message | String | Max | Required | Status messages string. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| scriptKeys | Array | 50 per value | Required | List of Array of scriptKey(s) (scriptKey is unique Id associated with script request). |
| shipping | Object (shipping) | | Required | Object containing shipping information for the order. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| message | String | Max | Required | Status messages string. |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| scriptKeys | Array | 50 per value | Required | List of Array of scriptKey(s) (scriptKey is unique Id associated with script request). |
| cancelReason | String | Max | Required | TBD |
| Field | Type | Character Limit | Required/Optional | Description |
|---|
| fillRequestKey | String | 50 | Required | Unique ID assigned by sending pharmacy to each fill request for tracking. |
| message | String | Max | Required | Status messages string. |
