RxFill Status Request

View the MailBox API Reference for detailed request body information.

This endpoint should be used to obtain the status of Rxfill requests previously submitted. No request body is required.
HealthDyne employs a mailbox style order status reporting methodology. Therefore, when an order has a status update, the status message is delivered to the partner’s mailbox. This status message remains in the mailbox until the status message is retrieved by the partner and receipt of the message is acknowledged. A maximum of 100 status messages will be returned with a single request. Multiple requests may be necessary to receive all outstanding status messages. Please refer to the Status Codes returned to determine if all messages have been retrieved. Retrieving messages is a two‐step process.

1. Retrieve a batch of messages.
2. Acknowledge the batch using the batchId returned from #1 using a POST method.

Note: Status messages are not considered delivered or removed from the mailbox until an acknowledgment is sent using a POST request with the batchId as a query parameter.
Until this acknowledgment is received, subsequent status fetch requests will return the same events with the same batchId. To avoid duplicate status data, do not submit another status request until the previous response has been acknowledged.

Server

Only https connections are accepted.

Header

GET Request

Sample GET Request

https://uat.apiservices.azure-api.net/v2/mailbox?messageCount=2

This tells the API to only respond with 2 messages. The default message count is 100 messages. The Mailbox only allows 100 messages to be pulled at a time.

GET Status Response

The below table lists the potential response codes that can be received in response to a GET request.

Sample Status Response

{
    "batchId": "e231b030-3788-408e-b374-f1890a0b4fb5",
    "count": 2,
    "approximateRemainingCount": 34,
    "messageList": [
        {
            "eventId": "564F7907-24C3-4374-96DA-5E9871B92EEE",
            "eventDateUtc": "2025-04-23T14:21:28.7169483",
            "eventType": "FILLREQUEST",
            "status": "SUBMITTED",
            "statusMessage": null,
            "eventDetail": {
                "OrderId": "XXH12004492",
                "OrderNumber": "75118113"
            }
        },
        {
            "eventId": "EF0AD4D1-B167-4604-A671-BC5AD1783747",
            "eventDateUtc": "2025-04-23T14:21:33.6899836",
            "eventType": "FILLREQUEST",
            "status": "SUBMITTED",
            "statusMessage": null,
            "eventDetail": {
                "OrderId": XX2004493",
                "OrderNumber": "75130257"
            }
        }
    ]
}

Acknowledge Batch (POST Method)

The POST method acknowledges the batchID of messages from the queue.

Only https connections are accepted.

Header

# POST Request

Sample POST Request

`https://uat.apiservices.azure-api.net/v2/mailbox/e231b030-3788-408e-b374-f1890a0b4fb5/markread

Sample Status Response

JSON

{
    "batchId": "e231b030-3788-408e-b374-f1890a0b4fb5",
    "status": "MARKED DELIVERED",
    "eventId": [
        "564F7907-24C3-4374-96DA-5E9871B92EEE",
        "EF0AD4D1-B167-4604-A671-BC5AD1783747"
    ]
}

Status Event Types:

# Fill Request Status Events

Submitted

HealthDyne will create the order after receiving a RxFill. Once the order has been successfully created, HealthDyne will generate a submitted order status message and queues the event up for the client to retrieve it.

sample "Submitted" event

{
            "eventId": "5948314D-1152-4475-A29C-4B56FAF77437",
            "eventDateUtc": "2025-04-23T14:22:05.3118884",
            "eventType": "FILLREQUEST",
            "status": "Submitted",
            "statusMessage": null,
            "eventDetail": {
                "OrderId": "FR12004497",
                "OrderNumber": "23APR075202390"
            }
        }

Rejected

If order creation errors/rejects; then Rejected event will be created. Possible reasons for system to reject order request include duplicate order number or Invalid NDC used.

Sample "Rejected" event

{
            "eventId": "5948314D-1152-4475-A29C-4B56FAF77437",
            "eventDateUtc": "2025-04-23T14:22:05.3118884",
            "eventType": "FILLREQUEST",
            "status": "REJECTED",
            "statusMessage": "The order has been rejected",
            "eventDetail": {
				"OrderNumber": "84438058",
				"rejectReason": "Validation Failed: Invalid NDC: 12121212121"
			}	
}

Canceled

When an order has been canceled by pharmacy, HealthDyne will send an update notifying of the canceled status along with reason for cancelation.

Sample "Canceled" event

{
            "eventId": "048aaccd-1b55-4edb-9493-d23a46dd364e",
            "eventDateUtc": "2025-05-02T14:49:38.4294261",
            "eventType": "FILLREQUEST",
            "status": "CANCELED", 
            "statusMessage": "The order has been canceled", 
            "eventDetail": {
                "OrderNumber": "TT4234459151",
                "Reason": "cancel reason"
            }
        }

Dispensed

Once the order has been shipped successfully by pharmacy, then send update will be sent to client.

Sample "Dispensed" event

{
            "eventId": "5948314D-1152-4475-A29C-4B56FAF77437",
            "eventDateUtc": "2025-04-23T14:22:05.3118884",
            "eventType": "FILLREQUEST",
            "status": "DISPENSED",
            "statusMessage": "The order has been shipped",
            "eventDetail": {
				"OrderNumber": "84438058",
				"Packages": [
					{
						"ShipmentCode": "UPS GR",
						"TrackingNumber": "1Z765WF80339910758",
						"Weight": 4.9,
						"ShippingCost": 31.34,
						"ShipDateUtc": "2025-03-21T23:09:26.811Z",
						"ShippingAddress": {
							"Address1": "HOSPITAL MENONITA CAYEY ROAD #14",
							"Address2": "KM 72.2 RINCON WARD SECTOR LAS LOMAS",
							"City": "CAYEY",
							"State": "PR",
							"Zip": "00736"
						}
					}
				],
				"FulfillingPharmacy": "HEALTHDYNE-FL"
			}	
}