Tutorials

Use Cases

Interface

Resources

Operations

Examples & Testing

Endpoints

Document Reference

4.0.1. (R4) 3.0.1. (STU3) 1.0.2 (DSTU2)

A Document Reference represents some form of document available to the information system, such as a CDA or FHIR document. The reference can point to another external system or to a binary resource.

Overview

See the FHIR documentation for more information about Document Reference resources.

Mapped Concepts in HIEBus

  • Report

Supported Interactions

Document Reference resources support the following interactions.

Search Parameters

When searching for Document Reference resources, the following search parameters are supported.

Name Type Prefixes
Modifiers 		Can be Chained? Description
_id Token Resource id.
_lastUpdated Date ne  lt  le  gt  ge  sa  eb  ap  When the resource last changed.
_source Uri :missing  Where the resource comes from.
authenticator Reference :missing  yes Who/what authenticated the document.
author Reference :missing  yes Who and/or what authored the document.
category Token :missing  The classification of the type of report - path DocumentReference.category. Matches CareEvolution reports whose type is in a term subset with scope 'http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category' and name equal to clinical-notes'.
date Date ne  lt  le  gt  ge  sa  eb  ap  :missing  When this document reference was created.
encounter Reference :missing  yes Context of the document content.
patient Reference :missing  yes Who/what is the subject of the document.
period Date ne  lt  le  gt  ge  sa  eb  ap  :missing  Time of service that is being documented.
provenance-agent Reference :missing  yes Search by provenance, specified by its author (aka originator) Organization.
status Token :not  :in  :notin  :missing  current | superseded | entered-in-error.
subject Reference :missing  yes Who/what is the subject of the document.
type Token :not  :in  :notin  :missing  Kind of document (LOINC if possible).

Sortable Parameters

When searching Document Reference resources, it is possible to sort the returned values by the following search parameters.

  • date
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Document Reference resources, it is possible to include the resources referenced by the following field names.

  • Authenticator
  • Author
  • Encounter
  • Patient
  • Provenance Agent
  • Subject

Back to Resources

Have questions about the HIEBus FHIR interface? Contact us at fhir@careevolution.com.

Terms of Use

© 2023 CareEvolution, LLC