Document Repository Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Detailed Specification

Document Repository Interfaces

These interfaces are based on the IHE Mobile Access to Health Documents. The audience is expected to have some familiarity with these profiles and transactions. Systems submitting, retrieving or searching for documents SHALL use the following interfaces.

Provide Document Bundle

See ITI-65. This interface SHALL be used to send documents and metadata to the repository.

POST [base]/Bundle

The Bundle profile is LKDocumentBundle.

The response is as described here.

Find Document Lists

See ITI-66. This query returns a FHIR List of document metadata (in a Bundle) that matches the search parameters. From the metadata users can locate documents and retrieve using this guides Retrieve Document interface. This interface SHALL be used to search for documents.

GET [base]/List?

Consideration 🔎 The list of search parameters as described by IHE may need extra consideration and could be shortened or expanded.

Find Document References

See ITI-67. This interface searches for DocumentReference instances that match the search parameters. This interface SHALL be used to find document references.

GET [base]/DocumentReference?

Consideration 🔎 The list of search parameters as described by IHE may need extra consideration and could be shortened or expanded.

Retrieve Document

See ITI-68. This may not be a FHIR interface, but could be an interface provided by a document repository to retrieve documents. This interface is undefined as it depends on the application that acts as the repository. For example the document referenced by DocumentReference.content.attachment.url would be the location of the document in a repository.

Simplified Publish

See ITI-105. This creates a DocumentReference resource with the DocuementReference.content.attachment.data populated with the document (in base64). This interface SHALL be used to publish with just a DocumentReference instance.

POST [base]/DocumentReference

See the profile LKPublishSimpleDocument.

This interface can be thought of as an operation as the server will need to execute steps similar to the Provider Document Bundle interface.

Consideration 🔎 This interface, POSTing a DocumentReference with base64 encoded document, could be a straightforward simplified phase '1' of Document Repository. This is especially true if the DocumentReference is retrieved using an id, bypassing all the processing associated with a Document Management system, setsubmissions, etc. DocumentReferences could be transformed as per IHE MHD later in a phase '2'.

Generate Metadata

See ITI-106. This is a more constrained ITI-105 as it specifies a Binary with CDA or Bundle with FHIR Document, but goes through the same steps. This interface SHALL be used to transmit a structure document to the Document Repository.

POST [base]/DocumentReference/$generate-metadata