Mobile access to Health Documents (MHD)
4.2.3-current - ci-build
Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 4.2.3-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentConsumer | Version: 4.2.3-current | |||
Active as of 2024-11-26 | Computable Name: IHE_MHD_DocumentConsumer |
IHE ITI Mobile access to Health Documents (MHD) - Document Consumer (client).
This is the Requirements CapabilityStatement for a Document Consumer. The Document Consumer may declared the UnContained References Options. This Actor is allowed to use Find Document List ITI-66, Find Document References ITI-67, and Retrieve Document ITI-68 transactions. The Document Consumer Actor should be robust for unconstrained DocumentReference and List Resources, as the results returned to the Document Consumer from the Document Responder may not follow the conformance constraints.
Figure: Query Actors Interactions
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement IHE.MHD.DocumentConsumer
application/fhir+xml
, application/fhir+json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
client
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
DocumentReference | https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference | y | y | _id, _lastupdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type | |||||
List | https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List | y | y | _id, _lastupdated, code, date, identifier, patient, patient.identifier, source.given, source.family, status, designationType, sourceId | |||||
Binary | y |
https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | _lastupdated | date | When the resource version last changed |
SHALL | author.given | string | These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | author.family | string | These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | category | token | Categorization of document |
SHALL | creation | date | When this document was created |
SHALL | date | date | When this document reference was created |
SHALL | event | token | Main clinical acts documented |
SHALL | facility | token | Kind of facility where patient was seen |
SHALL | format | token | Format/content rules for the document |
SHALL | identifier | token | The identifier for this DocumentReference |
SHALL | patient | reference | Who/what is the subject of the document |
SHALL | patient.identifier | token | An Identifier for Who/what is the subject of the document |
SHALL | period | date | Time of service that is being documented |
SHALL | related | reference | Related Resource |
SHALL | security-label | token | Document security-tags |
SHALL | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
SHALL | status | token | current | superseded | entered-in-error |
SHALL | type | reference | Kind of document (LOINC if possible) |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | _lastupdated | date | When the resource version last changed |
SHALL | code | token | This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated. |
SHALL | date | date | This parameter, of type date, specifies the time when the List was created. |
SHALL | identifier | token | This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2x: Appendix Z.2 for additional constraints on the use of the token search parameter type. |
SHALL | patient | reference | This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder. |
SHALL | patient.identifier | token | An Identifier for Who/what is the subject of the document |
SHALL | source.given | string | These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | source.family | string | These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | status | token | This parameter, of type token, specifies the status of the List. If included in the query, the Document Consumer shall populate the code portion of the token with one of the codes in the following Table 3.66.4.1.2.1-1: Values for code for status of List. The system portion of the token shall not be populated. |
SHALL | designationType | token | This IHE extension on parameters defined as SearchParameter/List-DesignationType, of type token, specifies the designation type of the List. The value of the designation type element indicates the clinical purpose of the SubmissionSet or Folder. Note that servers that do not support this extended search parameter will ignore it, and thus return more results than expected. |
SHALL | sourceId | token | This IHE extension on parameters defined as SearchParameter/List-SourceId, of type token, specifies the source (author) value supplied in the List Resource. |