4.0.0-comment - ballot

This page is part of the IHE Mobile Access to Health Documents (v4.0.0-comment: Public Comment Ballot 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Document Consumer (client)

IHE ITI Mobile access to Health Documents (MHD) - Document Consumer (client).

Document Recipient implementing Comprehensive Option

IHE ITI Mobile access to Health Documents (MHD) - Document Recipient - with Comprehensive declared Option.

Document Recipient

IHE ITI Mobile access to Health Documents (MHD) - Document Recipient - with no declared Options or all declared Options.

Document Recipient implementing UnContained Option

IHE ITI Mobile access to Health Documents (MHD) - Document Recipient - with UnContained declared Option.

Document Responder (server)

IHE ITI Mobile access to Health Documents (MHD) - Document Responder (server).

Document Source (publisher) implementing Comprehensive Option

IHE ITI Mobile access to Health Documents (MHD) - Document Source (publisher) - with Comprehensive Option.

Document Source (publisher)

IHE ITI Mobile access to Health Documents (MHD) - Document Source (publisher) - with no declared Options or all declared Options.

Document Source (publisher) implementing UnContained Option

IHE ITI Mobile access to Health Documents (MHD) - Document Source (publisher) - with UnContained Option.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

SearchParameter/List-DesignationType

This SearchParameter enables finding Lists by the designationType code in a submissionSet or folder.

SearchParameter/List-SourceId

This SearchParameter enables finding Lists by the SourceId of a submissionSet.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

MHD DocumentReference Comprehensive

A profile on the DocumentReference resource for MHD Comprehensive Contained (not UnContained), compatible with XDS-on-FHIR and XCA use.

MHD Folder Comprehensive

A profile on the List resource for MHD Comprehensive Metadata Folder. Note UnContained has no impact on Folder.

MHD Comprehensive Provide Document Bundle

A profile on the Bundle transaction for Provide Document resources with Comprehensive Metadata for MHD.

  • this is otherwise known as XDS-on-FHIR
  • all resources must be Comprehensive
  • shall be a Bundle
  • shall be a Transaction
  • each bundle entry request shall be a POST (create)
  • shall have a SubmissionSet
  • may have one or more DocumentReference
  • may have one or more Binary
  • may have one or more Folder
  • may have one Patient
MHD SubmissionSet Comprehensive

A profile on the List resource for MHD Comprehensive SubmissionSet.

MHD Dummy Provide Document Bundle

A profile on the Bundle transaction for Provide Document resources with Dummy metadata for MHD.

  • all resources are just core FHIR resources
  • shall be a Bundle
  • shall be a Transaction
  • shall have one or more List resources
  • may have one or more DocumentReference
  • may have one or more Binary
  • may have one or more Patient
  • can not have anything else (closed)
Audit Event for Find Document Lists Transaction by the Document Consumer

Defines constraints on the AuditEvent Resource to record when a Find Document Lists Transaction happens, as recorded by the Document Consumer.

  • Query event
  • shall have the source as itself
  • shall have a document consumer agent
  • shall have a document responder agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a the query parameters
Audit Event for Find Document Lists Transaction at Document Responder

Defines constraints on the AuditEvent Resource to record when a Find Document Lists Transaction happens, as recorded by the Document Responder.

  • Query event
  • shall have the source as itself
  • shall have a document consumer agent
  • shall have a document responder agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a the query parameters
Audit Event for Find Document References Transaction at Document Consumer

Defines constraints on the AuditEvent Resource to record when a Find Document References Transaction happens, as recorded by the Document Consumer.

  • Query event
  • shall have the source as itself
  • shall have a document consumer agent
  • shall have a document responder agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a the query parameters
Audit Event for Find Document References Transaction at Document Responder

Defines constraints on the AuditEvent Resource to record when a Find Document References Transaction happens, as recorded by the Document Responder.

  • Query event
  • shall have the source as itself
  • shall have a document consumer agent
  • shall have a document responder agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a the query parameters
MHD Find Document References Comprehensive Response message

A profile on the Find Document References Comprehensive Response message for ITI-68

MHD Find Document References Response message

A profile on the Find Document References Response message for ITI-68

MHD common List with designationType

A profile on the List resource for MHD. Used with both Folder and SubmissionSet.

  • MHD adds a codeable Concept to List for use with Folder and SubmissionSet
MHD DocumentReference Minimal

A profile on the DocumentReference resource for MHD with minimal metadata constraints.

MHD Folder Minimal

A profile on the List resource for MHD use as a Folder with minimal metadata constraints.

MHD Minimal Provide Document Bundle

A profile on the Bundle transaction for Provide Document resources with Minimal metadata for MHD.

  • all resources may be marked minimal, comprehensive, or unContained
  • shall be a Bundle
  • shall be a Transaction
  • each bundle entry request shall be a POST (create)
  • shall have a SubmissionSet
  • may have one or more DocumentReference
  • may have one or more Binary
  • may have one or more Folder
  • may have one Patient
MHD SubmissionSet Minimal

A profile on the List resource for MHD SubmissionSet.

Audit Event for Provide Bundle Transaction at Recipient

Defines constraints on the AuditEvent Resource to record when a Provide Bundle Transaction happens at the Recipient.

  • Import event
  • shall have source of itself
  • shall have a document source agent
  • shall have a document recipient agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a submission set identity entity
Audit Event for Provide Bundle Transaction at Source

Defines constraints on the AuditEvent Resource to record when a Provide Bundle Transaction happens at the Source.

  • Import event
  • shall have source of itself
  • shall have a document source agent
  • shall have a document recipient agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a submission set identity entity
Audit Event for Retrieve Document Transaction at Document Consumer

Defines constraints on the Document Consumer AuditEvent Resource to record when a Retrieve Document Transaction happens, as recorded by the Document Consumer.

  • Import event
  • shall have the source as itself
  • shall have a document consumer agent
  • shall have a document responder agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a document uniqueId (usually a Binary)
Audit Event for Retrieve Document Transaction at the Document Responder

Defines constraints on the Document Responder AuditEvent Resource to record when a Retrieve Document Transaction happens, as recorded by the Document Responder.

  • Export event
  • shall have the source as itself
  • shall have a document consumer agent
  • shall have a document responder agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a document uniqueId (usually a Binary)
MHD DocumentReference Comprehensive UnContained

A profile on the DocumentReference resource for MHD with Comprehensive metadata but without a requirement for contained author, authenticator, or sourcePatientInfo.

MHD UnContained Comprehensive Provide Document Bundle

A profile on the Bundle transaction for Provide Document resources with UnContained allowed but requiring Comprehensive Metadata for MHD.

  • all resources must be Comprehensive other than the Containment requirement
  • shall be a Bundle
  • shall be a Transaction
  • each bundle entry request shall be a POST (create)
  • shall have a SubmissionSet
  • may have one or more DocumentReference
  • may have one or more Binary
  • may have one or more Folder
  • may have one Patient
MHD SubmissionSet Comprehensive UnContained

A profile on the List resource for MHD UnContained Comprehensive SubmissionSet.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

Author organization of the SubmissionSet

When the author of the SubmissionSet is an Organization, this extension shall be used.

Clinical code of the List

Expresses contentType of submissionSet or the codeList of a Folder. Usually expressed in LOINC or SNOMED.

Intended recipient of the SubmissionSet

holds the identity of the organization or person the SubmissionSet is intended. For XDR and eMail (e.g. Direct) this tends to be a Practitioner or Patient with a telecom holding an email, but this is not strictly required.

Publisher organization identity of the SubmissionSet

The globally unique, immutable, identifier of the entity that contributed the SubmissionSet. When a broker is involved in sending SubmissionSets from a collection of client systems, it shall use a different sourceId for submissions from each separate system to allow for tracking. The format of the identifier is an OID.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

ValueSet/MHDlistTypesVS

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

MHD List Types

To use the List resource for two different use-cases we define a code-system with the types of List needed in MHD

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

Example Bundle - Bundle-FindDocumentReferences
Example DocumentReference - DocumentReference-IHE.MHD.Comprehensive.MedicationCard

2-7-MedicationCard

Example AuditEvent - ex-auditFindDocumentLists-consumer
Example AuditEvent - ex-auditFindDocumentLists-responder
Example AuditEvent - ex-auditFindDocumentReferences-consumer
Example AuditEvent - ex-auditFindDocumentReferences-responder
Example AuditEvent - ex-auditProvideBundle-recipient
Example AuditEvent - ex-auditProvideBundle-source
Example AuditEvent - ex-auditRetrieveDocument-consumer
Example AuditEvent - ex-auditRetrieveDocument-responder
Example Bundle - ex-dummyProvideDocumentBundle
Example Bundle - ex-minimalProvideDocumentBundle
Example DocumentReference - 593cd04e-b696-45c1-bc32-39e55a340a46
Example DocumentReference - ex-DocumentReferenceComprehensive

Example of a Comprehensive DocumentReference resource. This is fully filled for all mandatory elements and all optional elements.

Example DocumentReference - ex-DocumentReferenceMinimal
Example DocumentReference - ex-DocumentReferenceUnContained
Example DocumentReference - ex-DocumentReferenceUnContainedFully

Example of a Comprehensive DocumentReference resource. This is minimally filled for all mandatory elements.

Example List - 593cd04e-b696-45c1-bc32-39e55a340a44
Example List - 593cd04e-b696-45c1-bc32-39e55a340a45
Example SubmissionSet for comprehensive metadata with an intendedRecipient
Example Folder with comprehensive metadata
Example SubmissionSet for comprehensive metadata
Example SubmissionSet for comprehensive metadata
Example SubmissionSet for comprehensive metadata
Example List - ex-minimalFolder
Example List - ex-minimalSubmissionSet

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories

Bundle/xds
Binary/ex-b-binary
Device/ex-device
DocumentReference/593cd04e-b696-45c1-bc32-39e55a340a47
DocumentReference/ex-documentreference
DocumentReference/ex-documentreference2
List/593cd04e-b696-45c1-bc32-39e55a340a48
List/ex-list
List/ex-list2
Organization/ex-organization
Patient/593cd04e-b696-45c1-bc32-39e55a340a49
Patient/ex-patient
Practitioner/ex-practitioner