HL7 FHIR® US Core Implementation Guide CI Build

US Core, published by HL7 International - US Realm Steering Committee. This is not an authorized publication; it is the continuous build for version 3.1.0). This version is based on the current content of https://github.com/HL7/US-Core-R4/ and changes regularly. See the Directory of published versions

Operations defined for this Guide

  • 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](http://hl7.org/fhir/bundle.html) of type "searchset" containing [US Core DocumentReference Profiles](http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference) 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. 1. If no parameters are specified, the server SHALL return a DocumentReference to the patient's most current CCD 1. 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.