Home
API reference
FHIR® API
FHIR® notifications
Document
Document Replaced

Document Replaced Detailed

Page View

Document notifications contain details about any documents related to a patient's chart, including CDAs, signed provider notes, or other PDF documents with patient data.

You can receive notifications when a document is created, deleted, or replaced.

replaced

Indicates that an existing document has been replaced in your connection's system.

You can opt in for lightweight or detailed notifications.

  • A lightweight notification provides the DocumentReference reference, patient info, and timestamp.
  • A detailed notification contains everything in the lightweight plus the document content and related references.

Select payload example

DocumentReferenceReplacedBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "DocumentReferenceReplacedBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/DocumentReferenceReplaced",
9
        "resourceType": "MessageHeader",
10
        "id": "ff5ff901-0ee6-5876-bdcc-350f7cbd7e01",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "focus": [
16
          {
17
            "reference": "urn:uuid:0cbd911e-4b92-54be-821d-c1bb43ca0781"
18
          }
19
        ],
20
        "definition": "https://fhir.redoxengine.com/MessageDefinition/DocumentReferenceReplacedLight"
21
      },
22
      "fullUrl": "urn:uuid:ff5ff901-0ee6-5876-bdcc-350f7cbd7e01"
23
    },
24
    {
25
      "fullUrl": "urn:uuid:0cbd911e-4b92-54be-821d-c1bb43ca0781",
26
      "resource": {
27
        "resourceType": "DocumentReference",
28
        "id": "0cbd911e-4b92-54be-821d-c1bb43ca0781",
29
        "status": "current",
30
        "type": {
31
          "text": "Empty File"
32
        },
33
        "category": [
34
          {
35
            "coding": [
36
              {
37
                "system": "urn:redox:document_kind",
38
                "code": "Media"
39
              }
40
            ]
41
          }
42
        ],
43
        "subject": {
44
          "reference": "urn:uuid:cbec99dd-3826-561f-b79c-f5a2b979fb96"
45
        },
46
        "date": "2022-08-04T14:51:23Z",
47
        "content": [
48
          {
49
            "attachment": {
50
              "contentType": "application/pdf",
51
              "title": "SamplePDF-Order Specific Media"
52
            }
53
          }
54
        ]
55
      }
56
    },
57
    {
58
      "fullUrl": "urn:uuid:cbec99dd-3826-561f-b79c-f5a2b979fb96",
59
      "resource": {
60
        "resourceType": "Patient",
61
        "id": "cbec99dd-3826-561f-b79c-f5a2b979fb96",
62
        "identifier": [
63
          {
64
            "value": "0000000001",
65
            "system": "urn:redox:health-one:MR"
66
          },
67
          {
68
            "value": "101-01-0001",
69
            "system": "http://hl7.org/fhir/sid/us-ssn"
70
          }
71
        ],
72
        "name": [
73
          {
74
            "given": [
75
              "Timothy",
76
              "Paul"
77
            ],
78
            "family": "Bixby"
79
          }
80
        ],
81
        "gender": "male",
82
        "birthDate": "2008-01-06"
83
      }
84
    }
85
  ],
86
  "timestamp": "2021-06-17T20:33:22.422Z"
87
}

Request Body Schema

    Bundle sent as part of a DocumentReference-replaced 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, documentReference, patient, practitioner

    An entry in the bundle containing a FHIR resource

    • fullUrl
      string

      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
      • Results from operations might involve resources that are not identified.
    • 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/DocumentReferenceReplaced
  • timestamp
    string

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

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.