ESMD FHIR Implementation Guide
1.0.0 - esmd
ESMD FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
This page provides a summary of the custom FHIR profile resources which have been created for use with the Electronic Submission of Medical Documentation (esMD) System's REST API web services to enable the exchange of clinical documents, notifications, and system reference documents. These profiles are based on the Health Level 7 (HL7) FHIR resources and are used to provide a standardized way to use esMD-specific FHIR extensions to support esMD business requirements for performing the following key business use cases:
These profiles enable HIHs to transmit submission bundles to the esMD system. These bundles contain submission set metadata and document metadata, which includes the storage URL details, for each clinical XML document payload that has been uploaded to esMD using a presigned URL.
Description:
The Esmd-BundleSubmission profile extends the HL7 Bundle resource. It is used to manage the submission of healthcare documents and metadata in a structured manner within the esMD system. This profile makes use of the Esmd-ListSubmissionSet profile and Esmd-DocumentReference profile to ensure that submissions are complete, well-organized, and easily processed by the esMD System.
Description:
The Esmd-ListSubmissionSet profile extends the HL7 List resource. It is used within the Esmd-BundleSubmission resource to transmit submission set metadata to the esMD System. Submission set metadata represents metadata and identifiers relevant to the submission of a specific clinical document to the esMD System.
Description:
The Esmd-DocumentReference profile extends the HL7 DocumentReference resource. It is used within the Esmd-BundleSubmission resource to transmit document metadata to the esMD System. The document metadata includes a Binary URL (also referred to as a storage URL) which points to the location where the document payload is stored in esMD's secure storage.
This profile provides HIHs with real-time status information regarding the success or failure of their submitted bundle transactions.
Description:
The Esmd-BundleSubmissionResponse profile extends the HL7 Bundle resource. It is used to communicate the validation success or failure status of all resources that are contained in a bundle transaction that was submitted to esMD by an HIH. The Bundle type for the response must be set to "transaction-response". In this manner, the Esmd-BundleSubmissionResponse resource ensures clarity and consistency within the esMD workflow by alerting HIHs to problems regarding their transactions.
These profiles provide HIHs with the capability to submit Provider Service Registration requests as batch submission transactions or single submission transactions.
Description:
The Esmd-BundleServiceRegistration profile extends the HL7 Bundle resource. It is used to enable HIHs to submit provider service registration requests for multiple providers using a single batch bundle request. This profile manages the structured exchange of service-related information between healthcare providers and the esMD system by ensuring that service registration details such as service codes, provider information, and registration dates are captured accurately.
Description:
The Esmd-Practitioner profile extends the HL7 Practitioner profile with additional elements to ensure that practitioner data, including personal details and esMD-specific service-related information is captured and exchanged consistently. HIHs can use this profile to submit a single provider registration request transaction for each provider.
These profiles enable an HIH to request and retrieve lists of the following types of notifications which that specific HIH is authorized to receive.
Description:
The Esmd-FindBundleListNotifications profile extends the HL7 Bundle resource. It is used to enable an HIH to request a list of all notifications which that HIH is authorized to retrieve from esMD. The esMD System responds to the HIH's request with a Bundle resource that contains a collection of Esmd-FindListTransactionNotifications resources. This process facilitates efficient tracking and management of transaction statuses, and helps HIHs maintain up-to-date information on their submissions to esMD.
Description:
The Esmd-FindListTransactionNotifications profile extends the HL7 List resource. It is used to facilitate efficient communication of transaction submission success and failure notifications, package pickup success and failure notifications, and administrative error notifications. HIHs are encouraged to use this resource as part of a scheduled job that automatically retrieve notifications as a means to obtain timely updates that will help enable efficient resolution of potential discrepancies.
These profiles enable an HIH to request and retrieve lists of clinical documents and esMD system reference data files which that specific HIH is authorized to download or redownload.
Description:
The Esmd-FindBundleDocumentReferences profile extends the HL7 Bundle resource. It is used to enable an HIH to request a list of all clinical documents and esMD system reference data files which an HIH is authorized to download or redownload. The esMD System responds to the HIH's request with a Search Set Bundle resource that contains a collection of Esmd-FindBundleDocumentReferences resources which in turn, contains information about each available clinical document or system reference data file which that HIH is authorized to download or redownload.
Description:
The Esmd-FindDocumentReference profile extends the HL7 DocumentReference resource. It is used as a component of the Esmd-FindBundleDocumentReferences bundle resource to provide document metadata and the Binary URL (storage URL) for each clinical document payload or system reference data file that the requesting HIH is authorized to retrieve. HIHs use the Binary URL to download or redownload the base64 binary encoded content of clinical documents and esMD system reference data files from the esMD System's secure storage.
Description: The Esmd-Binary profile extends the HL7 Binary resource. It is used to return the encoded document payload when an authorized HIH requests to download or redownload a clinical document payload or esMD system reference data file from the esMD System's secure storage.
Description:
The Esmd-ListDeliveryConfirmation profile extends the HL7 List resource. It is used to facilitate the efficient communication of Provider Delivery Success acknowledgements and Provider Delivery Failure acknowledgements back to a Review Contractor (RC) after an HIH delivers those clinical documents to the designated healthcare provider.
Please click the Extensions Tab on the menu at the top of the page to obtain more information about the custom esMD extensions used in these profiles.