DocumentReference
This topic describes information for the DocumentReference resource.
To interact with the REST endpoints in the DocumentReference resource, see DocumentReference.
Overview
The DocumentReference resource is used to reference a clinical document for a patient in the health system. This resource supports reading clinical notes and returning references to retrieve Continuity of Care Documents (CCDs).
Soarian Clinicals supports a read-only Application Programming Interface (API). This API
accepts GET
and POST
based search and GET
based read
interactions. The response represents the most current information about the patient that is
charted in Soarian Clinicals at the time of the query.
Error: The common Client Errors (for more information, see R4 Overview) and OperationOutcomes may be returned.
The following fields are returned if valued for clinical documents:
Terminology Bindings
-
Description: Specifies the particular type of document referenced.
Details: US Core DocumentReference Type
System:
http://loinc.org
-
Description: A categorization for the type of document referenced.
Details: US Core DocumentReference Category
System:
http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category
-
DocumentReference.securityLabel
Description: A set of Security-Tag codes specifying the level of privacy/security of the Document.
Details: SecurityLabels
System:
https://terminology.hl7.org/CodeSystem/v3-Confidentiality
-
DocumentReference.content.format
Description: An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
Details: FormatCodes
System:
https://profiles.ihe.net/fhir/ihe.formatcode.fhir/ValueSet-formatcode.html