This resource contains metadata for any kind of document so that you can locate the document in a system. You can typically use this as a reference in another resource type that includes the subject, author, and context for a related document.
You may want to use this resource if (a) you want raw XML data or (b) you want you to pick what documents to view or retrieve. If you’re familiar with our Redox data models, this is the FHIR® representation of the ClinicalSummary.DocumentGet. Learn more about the DocumentGet event type. Or, if you only want to retrieve the patient’s latest CDA, check out the PatientQuery event type.
You can receive, retrieve, or save document references.
We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the US Core profile.
This operation allows you to save metadata for a document created or referenced in your system to your connection's system.
cURL request example
curl 'https://api.redoxengine.com/fhir/R4/{destinationId}/{environmentFlag}/DocumentReference/$write' \--request POST \--header 'Authorization: Bearer $API_TOKEN' \--header 'Content-Type: application/fhir+json' \--data '{"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","use": "official"},{"text": "Billy","use": "usual"}],"gender": "male","birthDate": "2008-01-06","telecom": [{"value": "+18088675301","system": "phone","use": "home"},{"value": "+18008675309","system": "phone","use": "work"},{"value": "timothy.bixby@redoxengine.com","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": "barbara.bixby@redoxengine.com","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"}]},"subject": {"reference": "Patient/RedoxPatientExampleTimothy"},"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"}}]}}]}'
Identifies the type of the resource
BundleIdentifies this bundle as a message
messageAn entry in the bundle containing a FHIR resource
Additional metadata about the message including the event
Identifies the type of the resource
MessageHeaderInformation about the sender of the message. This will typically be populated by Redox.
Identifies the routing target to send acknowledgements to.
Human-readable name for the source system.
This describes the message being communicated
The identification of the code system that defines the meaning of the symbol in the code.
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Notes-NewThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.