This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions
Orders and Observations Work Group | Maturity Level: 3 | Trial Use | Compartments: N/A |
This operation is used to return all the references to documents related to a patient.
The operation requires a patient id and takes the optional input parameters:
and returns a Bundle of type "searchset" containing DocumentReference resources 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 resources 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:
It is used to request a server to generate a document based on the specified parameters.
If no parameters are specified, the server SHALL return a DocumentReference to the patient's most current CCD
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:
The canonical URL for this operation definition is
http://hl7.org/fhir/OperationDefinition/DocumentReference-docref
Formal Definition (as a OperationDefinition).
URL: [base]/DocumentReference/$docref
This is not an idempotent operation
In Parameters: | ||||||
Name | Scope | Cardinality | Type | Binding | Profile | Documentation |
patient | 1..1 | id | The id of the patient resource located on the server on which this operation is executed. If there is no match, an empty Bundle is returned | |||
start | 0..1 | dateTime | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset. | |||
end | 0..1 | dateTime | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset. | |||
type | 0..1 | CodeableConcept | FHIR Document Type Codes (Required) | The type relates to document type e.g. for the LOINC code for a C-CDA Clinical Summary of Care (CCD) is 34133-9 (Summary of episode note). If no type is provided, the CCD document, if available, SHALL be in scope and all other document types MAY be in scope | ||
on-demand | 0..1 | boolean | This on-demand parameter allows client to dictate whether they are requesting only 'on-demand' or both 'on-demand' and 'stable' documents (or delayed/deferred assembly) that meet the query parameters | |||
Out Parameters: | ||||||
Name | Scope | Cardinality | Type | Binding | Profile | Documentation |
return | 1..1 | Bundle | The bundle type is "searchset"containing DocumentReference resources. Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource |
The server either returns a search result containing a single DocumentReference, or it returns an error.
Request: Example of $docref on a DocumentReference
POST /open/DocumentReference/$docref [some headers] { "resourceType": "Parameters", "id": "example", "parameter": [ { "name": "patient", "valueId": "Patient/example" }, { "name": "on-demand", "valueBoolean": "true" } ] }
Response: Results from $docref
HTTP/1.1 200 OK [other headers] { "resourceType": "Bundle", "id": "26419249-18b3-45de-b10e-dca0b2e72b", "meta": { "lastUpdated": "2012-03-18T03:28:49Z" }, "type": "searchset", "total": 1, "entry": [{ "fullUrl": "http://server/path/DocumentReference/example", "resource": { "resourceType": "DocumentReference", "id": "example", .. snip ... } }] }
For more information about operations, including how they are invoked, see Operations.