US Core Implementation Guide
3.2.0 - ballot

This page is part of the US Core (v3.2.0: STU4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Operations

  • US Core Fetch DocumentReferences

    This operation is used to return all the references to documents related to a patient.

    The operation takes the optional input parameters:

    • patient id
    • start date
    • end date
    • document type

    and returns a Bundle of type "searchset" containing US Core DocumentReference Profiles for the patient. If the server has or can create documents that are related to the patient, and that are available for the given user, the server returns the DocumentReference profiles needed to support the records. The principle intended use for this operation is to provide a provider or patient with access to their available document information.

    This operation is different from a search by patient and type and date range because:

    1. It is used to request a server generate a document based on the specified parameters.

    2. If no parameters are specified, the server SHALL return a DocumentReference to the patient's most current CCD

    3. If the server cannot generate a document based on the specified parameters, the operation will return an empty search bundle.

    This operation is the same as a FHIR RESTful search by patient,type and date range because:

    1. References for existing documents that meet the requirements of the request SHOULD also be returned unless the client indicates they are only interested in 'on-demand' documents using the on-demand parameter.