Home
API reference
FHIR® API
FHIR® notifications
Order
Referral Acknowledged

Referral Acknowledged Detailed

Page View

Order notifications contain details about any order placed by your connection’s system to your organization. This could include device, medication, service, or referral requests, depending on what your organization provides or manages for patients.

Generally, you can receive notifications when an order is created, cancelled, or updated. For 360X workflows, you can receive notifications about referral statuses.

acknowledged

Indicates that a patient referral you sent was successfully delivered to your connection.

This is a minimal ACK message that references the original ServiceRequest you sent.

Select payload example

ReferralAcknowledgedFullBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "ReferralAcknowledgedFullBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/ReferralAcknowledged",
9
        "resourceType": "MessageHeader",
10
        "id": "ReferralAcknowledgedMessageHeader",
11
        "focus": [
12
          {
13
            "reference": "ServiceRequest/example-referral"
14
          }
15
        ],
16
        "source": {
17
          "name": "Good Health Clinics",
18
          "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5"
19
        },
20
        "definition": "https://fhir.redoxengine.com/MessageDefinition/ReferralAcknowledgedFull"
21
      }
22
    }
23
  ],
24
  "timestamp": "2025-09-29T12:05:00.000Z",
25
  "Meta": {
26
    "Logs": [
27
      {
28
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
29
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
30
      }
31
    ],
32
    "Test": true,
33
    "EventDateTime": "2025-12-17T19:15:24.871Z",
34
    "Source": {
35
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
36
      "Name": "Redox Dev Tools"
37
    },
38
    "Destinations": [
39
      {
40
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
41
        "Name": "Redox EMR"
42
      }
43
    ],
44
    "DataModel": "FHIR.Event.Order",
45
    "EventType": "referral-acknowledged"
46
  }
47
}

Request Body Schema

    Bundle sent as part of a referral-acknowledged event

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Indicates the purpose of this bundle - how it is intended to be used.

    Value: message
  • entry
    required, Array of messageHeader or Other

    An entry in the bundle containing a FHIR resource

    • resource
      object

      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        The source application from which this message originated.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

      • focus
        required, Array of object

        The actual data of the message - a reference to the root/focus class of the event.

        Must be a resource of type Resource.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • definition
        required, string

        Permanent link to the MessageDefinition for this message.

      • eventUri
        required, string

        Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.

        Value: https://fhir.redoxengine.com/EventDefinition/ReferralAcknowledged
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.