FHIR R4 DocumentReference API

(0 reviews)
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed.



This asset is a component of MuleSoft Accelerator for Healthcare.

MuleSoft Accelerator for Healthcare enables healthcare providers to unlock critical patient data to build a patient 360 within Salesforce Health Cloud, faster and easier than ever before. The solution includes pre-built APIs, connectors, integration templates, and a prescriptive end-to-end reference architecture to bring patient demographics information and COVID-19 test results from any EHR into Health Cloud using HL7 V2 or FHIR standards.

The solution also provides a library of United States Core Data for Interoperability (USCDI) and FHIR R4 resources to help healthcare developers adhere to interoperability needs and jumpstart the development of healthcare digital transformation initiatives.

Use case covered

The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

A DocumentReference resource is used to index a document, clinical note, and other binary objects to make them available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be displayed to the user), and has defined update management. The DocumentReference resource can be used with any document format that has a recognized mime type and that conforms to this definition.

Typically, DocumentReference resources are used in document indexing systems, such as IHE XDS , such as profiled in IHE Mobile access to Health Documents .

DocumentReference is metadata describing a document such as:

  • CDA documents in FHIR systems
  • FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)
  • PDF documents , Scanned Paper, and digital records of faxes
  • Clinical Notes in various forms
  • Image files (e.g., JPEG, GIF, TIFF)
  • Non-Standard formats (e.g., WORD)
  • Other kinds of documents, such as records of prescriptions or immunizations

This API uses FHIR R4 DocumentReference Library.

More information about the FHIR R4 DocumentReference specification can be found here.

More information about the US Core profile can be found here.


Published by
MuleSoft Organization
Published onSep 8, 2020
Asset overview

Asset versions for 1.0.x

Asset versions


Industry Vertical
HealthcareNo values left to add
HealthcareNo values left to add