Mobile access to Health Documents (MHD)
4.2.2 - Trial-Implementation
This page is part of the IHE Mobile Access to Health Documents (v4.2.2: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
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.
The Retrieve Document [ITI-68] transaction is used by the Document Consumer to retrieve a document from the Document Responder.
Table 2: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 |
FHIR-R4 HL7 FHIR Release 4.0
Figure 2:3.68.4-1: Retrieve Document Interactions
This message is an HTTP GET request to retrieve the document.
The Document Consumer wants to obtain a document.
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 preferred 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.
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.
This is the return message sent by the Document Responder.
The HTTP Response message is sent upon completion of the Retrieve Document Request.
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 2:3.68.4.2.2-1 contains error situations and the HTTP Response.
Table 2:3.68.4.2.2-1: 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 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.
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.
See MHD Security Considerations.
This transaction should not return information that the Document Consumer is not authorized to access.
The security audit criteria are similar to those for the Retrieve Document Set-b [ITI-43] transaction.
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.
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.