Mobile access to Health Documents (MHD)
4.0.1 - normative

This page is part of the IHE Mobile Access to Health Documents (v4.0.1: Trial Implementation) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Retrieve Document [ITI-68]

This section corresponds to transaction [ITI-68] of the IHE Technical Framework. Transaction [ITI-68] is used by the Document Consumer and Document Responder Actors.

2:3.68.1 Scope

The Retrieve Document [ITI-68] transaction is used by the Document Consumer to retrieve a document from the Document Responder.

2:3.68.2 Actors Roles

Table 3.68.2-1: Actor Roles

Actor Role
Document Consumer Requests a document from the Document Responder
Document Responder Serves the document to the Document Consumer

2:3.68.3 Referenced Standards

FHIR-R4 HL7 FHIR Release 4.0

2:3.68.4 Messages

Document ConsumerDocument Responder1. Retrieve Document [ITI-68]

Figure 3.68.4-1: Retrieve Document Interactions

2: Retrieve Document Request Message

This message is an HTTP GET request to retrieve the document.

2: Trigger Events

The Document Consumer wants to obtain a document.

2: Message Semantics

The Document Consumer sends a HTTP GET request to the server. The Document Consumer request may be to retrieve the document content referenced by a DocumentReference.content.attachment.url.

The Document Consumer may provide HTTP Accept header, according to the semantics of the HTTP protocols (see RFC2616, Section 14.1). This enables the Document Consumer to indicate prefered mime-types such that the Document Responder could provide the document requested in an encoding other than the encoding indicated in the DocumentReference. For example, indicating application/fhir+json could result in the response from the Document Responder being a json FHIR Bundle of type document with all the content encoded as FHIR resources.

The only MIME type assured to be returned is the MIME type indicated in the DocumentReference.content.attachment.contentType.

The HTTP If-Unmodified-Since header shall not be included in the GET request.

2: Expected Actions

The Document Responder shall provide the document in the requested MIME type or reply with an HTTP status code indicating the error condition. The Document Responder is not required to transform the document.

2: Retrieve Document Response Message

This is the return message sent by the Document Responder.

2: Trigger Events

The HTTP Response message is sent upon completion of the Retrieve Document Request.

2: Message Semantics

This message shall be an HTTP Response, as specified by RFC2616. When the requested document is returned, the Document Responder shall respond with HTTP Status Code 200. The HTTP message-body shall be the content of the requested document.

Table contains error situations and the HTTP Response.

Table HTTP Error Response Codes and Suggested Text

Situation HTTP Response
URI not known 404 Document Not Found
Document is Deprecated or not available 410 Gone (or 404 when 410 is unacceptable due to security/privacy policy)
Document Responder unable to format document in content types listed the ‘Accept’ field 406 Not Acceptable
HTTP request specified is otherwise not a legal value 403 Forbidden/Request Type Not Supported

The Document Responder may return other HTTP Status Codes. Guidance on handling Access Denied related to use of 200, 403 and 404 can be found in ITI TF-2x: Appendix Z.7.

The Document Responder should complement the returned error code with a human readable description of the error condition.

The Document Responder may return HTTP redirect responses (responses with HTTP Status Codes 301, 302, 303 or 307) in response to a request. See RFC7231 Section 6.4 Redirection 3xx.

2: Expected Actions

If the Document Responder returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Consumer shall follow the redirect, but may stop processing if it detects a loop. See RFC7231 Section 6.4 Redirection 3xx.

The Document Consumer processes the results according to application-defined rules.

The .hash and .size, when populated, represent the content in the MIME type indicated in the DocumentReference.content.attachment.contentType. Note there are special .size and .hash handling for On-Demand Documents and Delayed Document Assembly.

2: CapabilityStatement Resource

Document Responders implementing this transaction shall provide a CapabilityStatement Resource as described in ITI TF-2x: Appendix Z.3 indicating the transaction has been implemented.

2:3.68.5 Security Considerations

See MHD Security Considerations.

This transaction should not return information that the Document Consumer is not authorized to access.

2: Security Audit Considerations

The security audit criteria are similar to those for the Retrieve Document Set-b [ITI-43] transaction.

2: Document Consumer Audit

The Document Consumer when grouped with ATNA Secure Node or Secure Application actor shall be able to record a Retrieve Document Consumer Audit Event Log. Audit Example for a Retrieve Document transaction from consumer perspective.

2: Document Responder Audit

The Document Responder when grouped with ATNA Secure Node or Secure Application actor shall be able to record a Retrieve Document Responder Audit Event Log. Audit Example for a Find Document Lists Transaction from responder perspective.