Mobile access to Health Documents (MHD)
4.2.3-current - ci-build International flag

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

CapabilityStatement: Document Consumer (client)

Official URL: https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentConsumer Version: 4.2.3-current
Active as of 2024-07-15 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.

Query Actors InteractionsDocument ConsumerDocument ResponderFind Document Lists [ITI-66] ↓Find Document References [ITI-67] ↓Retrieve Document [ITI-68]


Figure: Query Actors Interactions

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IHE.MHD.DocumentConsumer

Document Consumer (client)

  • Implementation Guide Version: 4.2.3-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-07-15 19:14:36+0000
  • Published by: IHE IT Infrastructure Technical Committee

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.

FHIR RESTful Capabilities

Mode: client

Security

Recommend ATNA, encouraged IHE-IUA or SMART-on-FHIR

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DocumentReferencehttps://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReferenceyy_id, _lastupdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type
Listhttps://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Listyy_id, _lastupdated, code, date, identifier, patient, patient.identifier, source.given, source.family, status, designationType, sourceId
Binary y

Resource Conformance: supported DocumentReference

Base System Profile
https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastupdateddate

When the resource version last changed

SHALLauthor.givenstring

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.

SHALLauthor.familystring

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.

SHALLcategorytoken

Categorization of document

SHALLcreationdate

When this document was created

SHALLdatedate

When this document reference was created

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLidentifiertoken

The identifier for this DocumentReference

SHALLpatientreference

Who/what is the subject of the document

SHALLpatient.identifiertoken

An Identifier for Who/what is the subject of the document

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related Resource

SHALLsecurity-labeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLtypereference

Kind of document (LOINC if possible)

 

Resource Conformance: supported List

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastupdateddate

When the resource version last changed

SHALLcodetoken

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.

SHALLdatedate

This parameter, of type date, specifies the time when the List was created.

SHALLidentifiertoken

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.

SHALLpatientreference

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.

SHALLpatient.identifiertoken

An Identifier for Who/what is the subject of the document

SHALLsource.givenstring

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.

SHALLsource.familystring

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.

SHALLstatustoken

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.

SHALLdesignationTypetoken

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.

SHALLsourceIdtoken

This IHE extension on parameters defined as SearchParameter/List-SourceId, of type token, specifies the source (author) value supplied in the List Resource.

 

Resource Conformance: supported Binary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports read.