Redox | FHIR.DocumentReference

Table of Contents

FHIR.DocumentReference

read
search
$message

read

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.DocumentReference
- Meta.EventType
  String
  Reliable
  Required
  read
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
id
- id
  string
  Possible
  Required
  The id of the resource

Sample MessageDownload JSON Schema

{
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2022-07-01T17:19:28.573Z",
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.DocumentReference",
      "EventType": "read"
   },
   "id": "15aae13e-005d-4073-8ccf-f3a967c1aa9e"
}

search

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.DocumentReference
- Meta.EventType
  String
  Reliable
  Required
  search
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
_id
- _id[]
  token
  Possible
  The internal ID (UUIDv4) of the Document.
_include
- _include[]
  special
  Possible
  Include resources referenced by the DocumentReference resource in the results. Value should be DocumentReference:parameter where the parameter is a reference-type parameter of the DocumentReference resource.
_revinclude
- _revinclude[]
  special
  Possible
  Include resources that reference the DocumentReference resource in the results. Value should be ReferencingResource:parameter where the parameter is a reference-type parameter of a resource that references the DocumentReference resource.
_sort
- _sort[]
  string
  Possible
  The name of a DocumentReference parameter used to sort multiple search results in ascending order. Prefix with - to sort in descending order.
_count
- _count[]
  number
  Possible
  Specifies the maximum number of DocumentReference resources to return.
type
- type[]
  token
  Possible
  Kind of document
category
- category[]
  token
  Possible
  The categorization of the document. Pass urn:redox:document_kind|CDA to retrieve XML-formatted CDA documents.
patient
- patient[]
  reference
  Possible
  Who is the subject of the document
- patient.identifier[]
  array
  Possible
  One or more external identifiers for the patient
date
- date[]
  date
  Possible
  The date/time this document reference was created
encounter-identifier
- encounter-identifier[]
  token
  Possible
  Identifier for encounter associated with documents
identifier
- identifier[]
  token
  Possible
  A master version specific identifier for the document reference
period
- period[]
  date
  Possible
  The time of service that is being documented
_elements
- _elements[]
  string
  Possible
  A comma-separated list of DocumentReference field names to return. This is helpful in reducing the initial response size, especially for DocumentReferences resources where content can carry binary data.
  
  Redox recommends passing subject,masterIdentifier,date,type,context to retrieve meaningful fields while still omitting the content which can be retrieved via subsequent searches or GET operations.

Sample MessageDownload JSON Schema

{
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2022-07-01T17:19:28.573Z",
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.DocumentReference",
      "EventType": "search"
   },
   "_id": [],
   "_include": [],
   "_revinclude": [],
   "_sort": [],
   "_count": [],
   "type": [],
   "category": [],
   "patient": [],
   "date": [],
   "encounter-identifier": [],
   "identifier": [],
   "period": [],
   "_elements": [],
   "patient.identifier": []
}

$message

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.DocumentReference
- Meta.EventType
  String
  Reliable
  Required
  $message
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "RedoxBlobExampleTimothy",
   "type": "message",
   "timestamp": "2021-12-17T20:33:22.422Z",
   "entry": [
      {
         "resource": {
            "resourceType": "MessageHeader",
            "id": "RedoxMessageHeaderExample",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "eventCoding": {
               "system": "urn:redox:event-type",
               "code": "Media-New"
            }
         }
      },
      {
         "resource": {
            "resourceType": "Patient",
            "id": "RedoxPatientExampleTimothyWrite",
            "extension": [
               {
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     }
                  ],
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
               },
               {
                  "extension": [
                     {
                        "url": "ombCategory",
                        "valueCoding": {
                           "code": "2135-2",
                           "system": "urn:oid:2.16.840.1.113883.6.238",
                           "display": "Hispanic or Latino"
                        }
                     },
                     {
                        "url": "text",
                        "valueString": "Hispanic"
                     }
                  ],
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
               }
            ],
            "name": [
               {
                  "given": [
                     "Timothy",
                     "Paul"
                  ],
                  "family": "Bixby"
               },
               {
                  "text": "Billy",
                  "use": "usual"
               }
            ],
            "gender": "male",
            "birthDate": "2008-01-06",
            "telecom": [
               {
                  "value": "+18088675301",
                  "system": "phone",
                  "use": "home"
               },
               {
                  "value": "+18008675309",
                  "system": "phone",
                  "use": "work"
               },
               {
                  "value": "[email protected]",
                  "system": "email"
               }
            ],
            "address": [
               {
                  "line": [
                     "4762 Hickory Street"
                  ],
                  "city": "Monroe",
                  "district": "Greene",
                  "state": "WI",
                  "postalCode": "53566",
                  "country": "US",
                  "use": "home"
               }
            ],
            "maritalStatus": {
               "coding": [
                  {
                     "code": "M",
                     "system": "http://hl7.org/fhir/v3/MaritalStatus",
                     "display": "Married"
                  }
               ],
               "text": "Married"
            },
            "communication": [
               {
                  "language": {
                     "coding": [
                        {
                           "code": "en",
                           "system": "urn:ietf:bcp:47"
                        }
                     ],
                     "text": "English"
                  }
               }
            ],
            "contact": [
               {
                  "name": {
                     "given": [
                        "Barbara"
                     ],
                     "family": "Bixby"
                  },
                  "telecom": [
                     {
                        "value": "+18088675303",
                        "system": "phone",
                        "use": "home"
                     },
                     {
                        "value": "[email protected]",
                        "system": "email"
                     }
                  ],
                  "address": {
                     "line": [
                        "4762 Hickory St."
                     ],
                     "city": "Monroe",
                     "district": "Green",
                     "state": "WI",
                     "postalCode": "53566",
                     "country": "USA"
                  },
                  "relationship": [
                     {
                        "coding": [
                           {
                              "code": "MTH",
                              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                              "display": "mother"
                           }
                        ],
                        "text": "Mother"
                     },
                     {
                        "coding": [
                           {
                              "code": "C",
                              "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
                              "display": "Emergency Contact"
                           }
                        ],
                        "text": "Emergency Contact"
                     }
                  ]
               }
            ],
            "generalPractitioner": [
               {
                  "reference": "Practitioner/RedoxPractitionerExamplePat"
               }
            ],
            "managingOrganization": {
               "reference": "Organization/RedoxOrganizationManagingExample"
            },
            "identifier": [
               {
                  "value": "0000000001",
                  "type": {
                     "text": "MR"
                  }
               }
            ]
         }
      },
      {
         "resource": {
            "resourceType": "DocumentReference",
            "id": "RedoxDocumentReferenceExampleBlobTimothy",
            "masterIdentifier": {
               "value": "129.6.58.92.88336",
               "system": "urn:redox:test:media",
               "extension": [
                  {
                     "url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
                     "valueString": "RedoxApi"
                  }
               ]
            },
            "status": "current",
            "description": "Test Description",
            "type": {
               "text": "Empty File"
            },
            "category": [
               {
                  "coding": [
                     {
                        "system": "urn:redox:document_kind",
                        "code": "Media"
                     }
                  ]
               }
            ],
            "context": {
               "period": {
                  "start": "2015-05-06T06:00:58.872Z"
               }
            },
            "content": [
               {
                  "attachment": {
                     "url": "https://blob.redoxengine.com/123456789",
                     "contentType": "application/pdf",
                     "title": "SamplePDF-Order Specific Media"
                  }
               }
            ]
         }
      }
   ],
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2022-07-01T17:19:28.573Z",
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.DocumentReference",
      "EventType": "$message"
   }
}

FHIR.DocumentReference

readlink

Fields

Meta

id

searchlink

Fields

Meta

_id

_include

_revinclude

_sort

_count

type

category

patient

date

encounter-identifier

identifier

period

_elements

$messagelink

Fields

Meta

read

search

$message