API - Get Document List

This API retrieves the list of documents from AWS DynamoDB

Scope

This transaction involves the requestor sending a GET request to the FHIR service to retrieve a list of DocumentReference resources based on certain parameters such as the source system, document category, etc.

Each DocumentReference resource contains an attachment URL of one of the following in root relative path format:

  • binary file (for example /Binary/eimr-ttsh-U2FsdGVkX18KFMPcFnDTG2XO1pP0KO9GEZwFJlnU6bc=:d428e7db-2964-44be-855b-00c7475da6cb)
  • composition json file (for example /Composition/eimr-ttsh-U2FsdGVkX18KFMPcFnDTG2XO1pP0KO9GEZwFJlnU6bc=:d428e7db-2964-44be-855b-00c7475da6cb).

Upon successful retrieval, the FHIR Service returns an HTTP response code (i.e 2xx) and a Bundle containing a collection of DocumentReference resources.

For unsuccessful retrieval, the FHIR Service returns an HTTP response code (i.e 4xx or 5xx) and an OperationOutcome resource.

Interaction Diagram

Could not find subject. File was not found for images/get-document-list.png

Specification

The

Command 'link' could not render: Object reference not set to an instance of an object.
FHIR specification is based on the HL7 FHIR R5 extended operation. (Ref: https://www.hl7.org/fhir/operations.html)

Could not find subject. File was not found for Get-document-list.OperationDefinition.json

Example

Type Value
Method GET
Headers Content-Type: application/fhir+json
URL [base]/DocumentReference/$get-document-list
Message Body
Command 'json' could not render: File was not found for examples/get-document-list-request.json

Message Response

Depending on the HTTP Status Code, the following resources will be sent back to the requestor.

HTTP Status Code Example
201 Created
Command 'json' could not render: File was not found for examples/get-document-list-response.json
4xx, 5xx
Command 'json' could not render: File was not found for examples/OperationOutcome-patientnricnotfound.json

Business Level Errors

This section details the business level errors exposed by OperationOutcome resource for this operation. Refer to API Error Handling for framework level errors.

For illustration only

http status code code details.coding.code details.text
404 patient-nric-not-found E-10000 Patient NRIC is not found
404 source-system-not-found E-10001 Source system is not found
404 source-institution-not-found E-10002 Source Institution code is not found
404 document-category-not-found E-10003 Document Category is not found