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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
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.
| esMD FHIR Server Capability Statement |
This CapabilityStatement describes the esMD FHIR Server, which handles submission, retrieval, and validation of medical documentation, including security via OAuth2 and IP whitelisting. |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| generate-presigned-url |
Operation to generate a pre-signed S3 URL for file upload or download. |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
| Search Parameter for Esmd-Ext-RequestType: Filtering List and DocumentReference Resources by RequestType |
The RequestTypeCodes SearchParameter allows HIHs to filter esMD notifications based on their type. Supported types include ADMIN_ERROR for administrative issues like file corruption, VALIDATION_FAILURE for failed bundle submissions requiring correction, VALIDATION_SUCCESS for successfully validated submissions forwarded to the RC, and PICKUP for notifications on whether the RC successfully retrieved the package. This parameter helps efficiently track and manage transaction notifications. |
| Search Parameter for Esmd-Ext-UniqueId: Filtering List and DocumentReference Resources by UniqueId |
The uniqueId search parameter allows clients to search for specific resources, such as DocumentReference or Bundle, using a unique identifier assigned to each esMD transaction. This parameter helps quickly locate a document or transaction in the system by its unique reference, ensuring precise and efficient retrieval of resources. |
| Search Parameter for esmd-trans-status |
This search parameter allows users to filter List and DocumentReference resources based on the esmd-trans-status extension. It enables querying for resources associated with a specific sender identifier, facilitating efficient retrieval of relevant lists and documents in the esMD system. This parameter enhances interoperability by ensuring that resources can be accurately identified and accessed based on their sender OIDs. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| EsMD Practitioner |
The Esmd-Practitioner profile extends the USCorePractitioner 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. |
| Esmd Binary Profile |
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. |
| Esmd Bundle Batch Response Profile |
The Esmd-BundleBatchResponse profile is used when receiving a Bundle with a transaction type. Upon processing, the response Bundle should have the BundleBatchResponse type. This profile ensures that the response includes the status of all resources processed within the original bundle. The Bundle type for the response must be set to batch-response, providing a comprehensive status report for each resource involved in the submission, ensuring clarity and consistency in the esMD workflow. |
| Esmd Bundle Delivery Conformation Profile |
The Esmd-BundleDeliveryConfirmation profile in the esMD system is designed for Health Information Handlers (HIHs) who need to send multiple delivery confirmations to esMD. This API enables HIHs to efficiently communicate the successful delivery of healthcare documents to multiple providers at once. Using this profile ensures accurate tracking and timestamping of each delivery, streamlining the documentation process and enhancing the accountability and transparency of document exchanges within the esMD ecosystem. This capability is vital for maintaining precise records of document transactions between HIHs and providers. |
| Esmd Bundle Service Registration Profile |
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. |
| Esmd Bundle Submission Profile |
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. |
| Esmd Bundle Submission Response Profile |
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. |
| Esmd Document Reference Profile |
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. |
| Esmd Document Reference Profile |
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. |
| Esmd Find Bundle Document References |
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. |
| Esmd Find Bundle List Notifications |
The Esmd-FindBundleListNotifications profile in the esMD system is designed for Health Information Handlers (HIHs) who need to send multiple delivery confirmations to esMD. This API enables HIHs to efficiently communicate the successful delivery of healthcare documents to multiple providers at once. Using this profile ensures accurate tracking and timestamping of each delivery, streamlining the documentation process and enhancing the accountability and transparency of document exchanges within the esMD ecosystem. This capability is vital for maintaining precise records of document transactions between HIHs and providers. |
| Esmd List Provider Confirmation Profile |
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. |
| Esmd List SubmissionSet Profile |
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. |
| Find List of Transaction Notification from esMD |
In the esMD system, healthcare providers or their Health Information Handlers (HIHs). |
| esMD Custom OperationOutcome |
A custom OperationOutcome for esMD system to handle errors and warnings during transactions and requests. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Letter Identifier |
The Esmd-Idn-LetterId is a custom esMD FHIR resource that is used to transmit the LetterId. The LetterId is a unique identifier that is assigned to each individual submission. It ensures that each document, claim, or other transaction, can be uniquely identified and tracked throughout the submission and review process. The LetterId plays a crucial role in preventing duplication, ensuring proper routing, and facilitating accurate processing and auditing of clinical documents that are handled by the esMD system. The Esmd-Idn-LetterId resource represents document metadata. As such, it will be included in the Esmd-DocumentReference resource with other document metadata when a clinical document is transmitted via the esMD System. |
| Letter Identifier |
The Esmd-Idn-TransactionId is a custom esMD FHIR resource that is used to transmit a unique identifier which is assigned by the esMD System to track transactions received from Health Information Handlers (HIHs) or Providers. When a transaction is received, esMD generates and assigns the TransactionId. It then uses it to provide clear and efficient tracking for auditing, status reporting, and seamless management of submissions and responses within the esMD workflow. The Esmd-Idn-TransactionId resource is used in the following esMD FHIR profiles: • Esmd-DocumentReference - When used in this profile, the TransactionId represents a unique identifier which is used by the esMD System to track a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. • Esmd-ListDeliveryConfirmation - When used in this profile, the TransactionId is used as a unique identifier that enables users to confirm the delivery of a specific clinical document using esMD's notification features. |
| Letter Identifier |
The Esmd-Idn-UniqueId is a custom esMD FHIR resource that is used by the esMD System to serve as a distinctly unique identifier for each individual submission that is received by esMD. It ensures that every submission, whether a document, claim, or other transaction, can be uniquely identified and tracked throughout the submission and review process. The UniqueID plays a crucial role in preventing duplication, ensuring proper routing, and facilitating accurate processing and auditing of clinical documents within the esMD system. |
| esMD Meta |
esMD Meta profile |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| ESMD Attachment Control Number of the SubmissionSet |
The Esmd-Ext-AttachmentControlNumber is a custom esMD FHIR resource that is used to transmit the Attachment Control Number (ACN). The ACN is a unique identifier which is received as part of an X12N 278 5010 request and stored in the esMD database where it is used to track and manage specific attachments or documents submitted as supporting documentation received using the esMD FHIR workflow. The ACN ensures that each attachment is correctly linked to the relevant submission. In this manner it helps streamline document tracking and prevents errors, ensuring that all attachments are properly accounted for and associated with the correct claim or case. |
| ESMD Case ID |
The Esmd-Ext-CaseId is a custom esMD FHIR resource that is used to represent the Case Identifier (CaseId). The CaseId is a unique identifier that is assigned by the Review Contractor (RC) that links submitted documentation to a specific case. A case may involve multiple claims or services related to a single patient or scenario. The CaseId ensures that all documents are properly associated with the case during submission and review, facilitating accurate tracking and auditing. Moreover, the CaseId helps streamline workflows by linking related claims or documentation under one case, thereby ensuring clarity and preventing mismanagement during the esMD submission process. The Esmd-Ext-CaseId resource is used in the following esMD FHIR profiles: • Esmd-ListSubmissionSet - When used in the profile, the CaseId represents document submission metadata (aka submission set metadata). As such, it will be included in the resource with other document submission metadata when a clinical document is transmitted via the esMD System. • Esmd-FindListTransactionNotification - When used in this profile, the CaseID is used as a unique identifier that enables users to identify and track the status of transactions related to a specific clinical document using esMD's notification features. |
| ESMD Claim ID |
The Esmd-Ext-ClaimId is a custom esMD FHIR resource that is used to represent the Claim Identifier (ClaimId). The ClaimId is a unique identifier that is assigned by the Review Contractor (RC) as part of an Additional Documentation Request (ADR). It ensures that all supporting documents for a specific medical claim, such as medical records or reports, are correctly associated with the relevant claim during the submission, review, or auditing process. The ClaimId is crucial for facilitating communication between healthcare providers, Review Contractors (RCs), and government agencies, ensuring accurate document routing, tracking, and processing. Moreover, the ClaimId helps automate workflows and ensures compliance by linking the correct documentation to the claim thereby avoiding duplication or errors. The Esmd-Ext-ClaimId resource is used in the following esMD FHIR profiles: • Esmd-ListSubmissionSet - When used in the profile, the ClaimId represents document submission metadata (aka submission set metadata). As such, it will be included in the resource with other document submission metadata when a clinical document is transmitted via the esMD System. • Esmd-FindListTransactionNotification - When used in this profile, the ClaimId is used as a unique identifier that enables users to identify and track the status of transactions related to a specific clinical document using esMD's notification features. |
| ESMD Response Type Category |
The Esmd-Ext-ResponseTypeCategory is a custom esMD FHIR resource that is used to classify the type of response that is expected for a particular submission such as: approval, denial, or request for additional information. Health Information Handlers (HIHs) receive the ResponseTypeCategory along with notifications and payload bundles when retrieving them from the esMD system. By categorizing responses, the esMD process streamlines the claim review process by improving clarity, thereby enabling Review Contractors (RCs) and submitting entities to efficiently process and respond to the submitted clinical documentation. |
| ESMD Split Number |
The Esmd-Ext-SplitNumber is a custom esMD FHIR resource that is used by esMD system processes when a Health Information Handler (HIH) submits a large payload which is required to be divided into multiple smaller parts to facilitate efficient submission and delivery. It uniquely identifies the sequence for each part in a series of split submissions, thereby ensuring that all parts of the submission can be correctly combined and reviewed as a complete set by the receiving Review Contractor (RC). The SplitNumber helps streamline the processing of large submissions by maintaining order and integrity across multiple transactions. |
| ESMD Transaction ID |
The Esmd-Ext-TransactionId is a custom esMD FHIR resource that is used to transmit a unique identifier which is assigned by the esMD System to track transactions received from Health Information Handlers (HIHs) or Providers. When a transaction is received, esMD generates and assigns the TransactionId. It then uses it to provide clear and efficient tracking for auditing, status reporting, and seamless management of submissions and responses within the esMD workflow. The Esmd-Ext-TransactionId resource is used in the following esMD FHIR profiles: • Esmd-DocumentReference - When used in this profile, the TransactionId represents a unique identifier which is used by the esMD System to track a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. • Esmd-ListDeliveryConfirmation - When used in this profile, the TransactionId is used as a unique identifier that enables users to confirm the delivery of a specific clinical document using esMD's notification features. |
| HIH Organization ID |
The Esmd-Ext-OrganizationId is a custom esMD FHIR resource that is used to transmit the Organizational Identifier (OID) of the organization or Health Information Handler (HIH) that submits a clinical document to a receiving entity using the esMD System. This is a unique identifier which ensures that the originator of a given esMD submission is correctly identified thereby enabling accurate tracking, routing, communication, and integrity of submissions within the esMD system. NOTE: The Esmd-Ext-OrganizationId must not be used to identity a Review Contractor (RC) organization. |
| Letter ID |
The Esmd-Ext-LetterId is a custom esMD FHIR resource that is used to transmit the LetterId. The LetterId is a unique identifier that is assigned to each individual submission. It ensures that each document, claim, or other transaction, can be uniquely identified and tracked throughout the submission and review process. The LetterId plays a crucial role in preventing duplication, ensuring proper routing, and facilitating accurate processing and auditing of clinical documents that are handled by the esMD system. The Esmd-Ext-LetterId resource represents document metadata. As such, it will be included in the Esmd-DocumentReference resource with other document metadata when a clinical document is transmitted via the esMD System. |
| Provider Delivery Date Time |
The Esmd-Ext-DeliveryDateTime is a custom esMD FHIR resource that is used to record the Provider Delivery date and time. |
| Request Id |
The Esmd-Ext-RequestId is a custom esMD FHIR resource that is used to specify the nature of the clinical document received by healthcare providers or Health Information Handlers (HIHs) through the esMD system. This categorization helps providers and HIHs understand the Id of request associated with each communication, such as requests for additional documentation, responses to prior submissions, or notifications related to claim reviews. The Esmd-Ext-RequestId provides a clear indication of the nature of the request for each clinical document, thereby ensuring that recipients can efficiently process and respond to communications and maintain streamlined operations while maintaining compliance with regulatory standards to protect the integrity and security of healthcare data. |
| Request Type |
The Esmd-Ext-RequestType is a custom esMD FHIR resource that is used to specify the nature of the clinical document received by healthcare providers or Health Information Handlers (HIHs) through the esMD system. This categorization helps providers and HIHs understand the type of request associated with each communication, such as requests for additional documentation, responses to prior submissions, or notifications related to claim reviews. The Esmd-Ext-RequestType provides a clear indication of the nature of the request for each clinical document, thereby ensuring that recipients can efficiently process and respond to communications and maintain streamlined operations while maintaining compliance with regulatory standards to protect the integrity and security of healthcare data. |
| Review Contractor Notification Creation Date and Time |
The Esmd-Ext-RCCreationDateTime is a custom esMD FHIR resource that is used to record the exact date and time that a notification was created by a Review Contractor (RC). This timestamp ensures traceability and accountability in the document exchange process within the esMD system thereby facilitating accurate document tracking, document delivery management, enhanced compliance and operational transparency between RCs and esMD. The Esmd-Ext-RCCreationDateTime resource is used in the following esMD FHIR Profile: • Esmd-FindListTransactionNotification - When used in this profile, RCCreationDateTime is used as a date/time stamp in the esMD System's Notification function to indicate the exact date and time that a specific PA Reject Notification or Admin Error Notification was created by an RC. |
| Review Contractor Notification Submission Date and Time |
The Esmd-Ext-RCSubmissionDateTime is a custom esMD FHIR resource that is used to record the exact date and time that a notification was submitted to the esMD System by a Review Contractor (RC). This timestamp ensures traceability and accountability in the document exchange process within the esMD system thereby facilitating accurate document tracking, document delivery management, enhanced compliance and operational transparency between RCs and esMD. The Esmd-Ext-RCSubmissionDateTime resource is used in the following esMD FHIR Profile: • Esmd-FindListTransactionNotification - When used in this profile, RCSubmissionDateTime is used as a date/time stamp in the esMD System's Notification function to indicate the exact date and time that a specific PA Reject Notification or Admin Error Notification was submitted to esMD by an RC. |
| Review Contractor Transaction package Pickup Date and Time |
The Esmd-Ext-RCPickupDateTime is a custom esMD FHIR resource that is used to record the exact date and time that clinical documents are successfully downloaded from the esMD System by Review Contractors (RCs). The RCPickupDateTime ensures traceability and accountability in the document exchange process within the esMD system thereby facilitating accurate document tracking, document delivery management, enhanced compliance and operational transparency between RCs and esMD. The Ext-RCPickupDateTime resource is used in the following esMD FHIR Profile: • Esmd-FindListTransactionNotification - When used in this profile, RCPickupDateTime is used as a date/time stamp in the esMD System's RC Pickup Notification function to indicate the exact date and time that a specific clinical document was successfully downloaded by a RC. |
| esMD Author organization of the SubmissionSet |
The Esmd-Ext-AuthorOrg is a custom esMD FHIR resource that is used to represent the National Provider Identifier (NPI) when an organization (institution) is the author of a clinical document that is transmitted using the esMD System. The Esmd-Ext-AuthorOrg resource represents document submission metadata (aka submission set metadata). As such, it will be included in the Esmd-ListSubmissionSet resource with other document submission metadata when a clinical document is transmitted via the esMD System. |
| esMD Intended Recipient OID |
The Esmd-Ext-IntendedRecipient is a custom esMD FHIR resource that is used to transmit the Organizational Identifier (OID) of the organization or entity that is designated to receive the submitted clinical documentation. It is a unique identifier which ensures that esMD submissions are correctly routed to the appropriate recipient, such as a government agency, payer, or contractor. The Esmd-Ext-IntendedRecipient resource helps maintain the integrity and efficiency of the esMD documentation delivery process. |
| esMD Parent Unique ID |
The Esmd-Ext-ParentUniqueId is a custom esMD FHIR resource that is used by the esMD System to identify multiple submission files as a single transaction when a Health Information Handler (HIH) needs to split a large payload into multiple submissions. The initial transaction's unique identifier is designated as the ParentUniqueId and it is included in all subsequent transactions for the large split payload. The Esmd-Ext-ParentUniqueId is a unique identifier that enables Review Contractors to efficiently combine and review all submissions that are part of a split payload together, thereby ensuring seamless processing while maintaining the integrity of the clinical documentation. |
| esMD Provider NPI |
The Esmd-Ext-NPI is a custom esMD FHIR resource that is used to transmit the National Provider Identifier (NPI). The NPI is a unique identification number required to healthcare providers who transmit clinical documents electronically using the esMD System. The Esmd-Ext-NPI is used within the esMD System to ensure that clinical documents and data are accurately linked to the correct healthcare provider. Additionally, it is used to authenticate submissions, track submissions, and streamline the review and processing of clinical documents while maintaining compliance with regulatory standards to protect the integrity and security of healthcare data. |
| esMD Provider Number |
The providerNumber extension is used to capture a unique identifier assigned to a healthcare provider within the esMD or FHIR workflow. This identifier helps distinguish the provider for administrative, billing, and regulatory purposes. The providerNumber is essential for tracking provider-related transactions and interactions within healthcare systems, ensuring accurate identification and facilitating compliance with healthcare standards. |
| esMD Provider Tax ID |
The ProviderTaxId extension is used to capture a unique identifier assigned to a healthcare provider within the esMD or FHIR workflow. This identifier helps distinguish the provider for administrative, billing, and regulatory purposes. The ProviderTaxId is essential for tracking provider-related transactions and interactions within healthcare systems, ensuring accurate identification and facilitating compliance with healthcare standards. |
| esMD Receiver OID |
The Esmd-Ext-ReviewContractorOid is a custom esMD FHIR resource that is used to transmit the Organizational Identifier (OID) of the organization or entity that is identified as the receiving Review Contractor (RC). The Esmd-Ext-ReviewContractorOid is a unique identifier which ensures that esMD notifications report reliable status information which helps maintain the integrity and efficiency of the esMD documentation delivery process. |
| esMD Unique ID |
The Esmd-Ext-UniqueId is a custom esMD FHIR resource that is used by the esMD System to serve as a distinctly unique identifier for each individual submission that is received by esMD. It ensures that every submission, whether a document, claim, or other transaction, can be uniquely identified and tracked throughout the submission and review process. The UniqueID plays a crucial role in preventing duplication, ensuring proper routing, and facilitating accurate processing and auditing of clinical documents within the esMD system. |
| esMD support Action Requested Code |
The Esmd-Ext-ActionRequestedCode extension is a custom esMD FHIR resource which is used within the esMD Service Registration workflow to capture the specific registration request action. Actions include Add a new provider, Only sending the ADRs electronically, or Remove provider or service. The required Action Requested Codes are provided by the Esmd-CS-ActionRequested code system, no others shall be accepted. |
| esMD support Lines of Bunsiness Identification Number |
The Esmd-Ext- LinesOfBusinessId is a custom esMD FHIR resource that is used to identify the specific Line of Business (LOB) that is associated with claims or clinical documents submitted via esMD. It helps classify and route submissions based on the type of service or payer-related information, thereby ensuring that documentation is processed according to the correct business category. By associating each submission with a specific line of business, the esMD system enhances the organization and accuracy of claims management and auditing. The Esmd-Ext-LinesOfBusinessId resource is used in the following esMD FHIR profiles: • Esmd-ListSubmissionSet - When used in the profile, the Esmd-Ext-LinesOfBusinessId represents document submission metadata (aka submission set metadata). As such, it will be included in the resource with other document submission metadata when a clinical document is transmitted via the esMD System. • Esmd-FindListTransactionNotification - When used in this profile, the Esmd-Ext-LinesOfBusinessId enables users to identify and track the status of clinical documents that belong to specific business categories using esMD's notification features. |
| esMD supported Service Start Date |
The Esmd-Ext-ServiceStartDate is a custom esMD FHIR resource that captures the date when a service provided by a practitioner in the esMD workflow begins. The ServiceStartDate is mandatory and helps determine the duration of a service by providing a clear record of when a service starts. When combined with information from the optional Esmd-Ext-ServiceEndDate resource, the esMD System can provide accurate tracking and management of services for practitioners associated with Health Information Handlers (HIHs). |
| esMD supported Services Code |
The Esmd-Ext-ServiceCode is a custom esMD FHIR resource which is used within the esMD Service Registration workflow to capture the specific registration information that allows a practitioner to register with esMD to send and receive clinical documents electronically. The ServiceCode ensures that all service-related details are structured and managed efficiently within the practitioner's profile, thereby providing clear traceability and flexibility when handling multiple services within the esMD System. |
| esMD supported Services End Date |
The Esmd-Ext-ServiceEndDate is a custom esMD FHIR resource which is used to capture the optional end date of a service provided by a practitioner in the esMD workflow. It enables healthcare provider systems to specify when a particular service offered by a practitioner concludes, thereby providing a clear timeline for the service's availability. If the service is ongoing or has no defined end date, the ServiceEndDate may be omitted. The Esmd-Ext-ServiceEndDate resource helps ensure accurate tracking, management, and reporting of practitioner service durations. |
| esMD supported Status Code |
The Esmd-Ext-StatusCode is a custom esMD FHIR resource that is used to provide detailed information about a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System to indicate that success or error conditions exist. The StatusCode provides a consistent way to track processing across systems and ensures that the status of clinical documents are accurately tracked and reported. The Esmd-Ext-StatusCode resource is used in the following esMD FHIR profile: • Esmd-FindListTransactionNotification - When used in this profile, StatusCode is used to report the status of a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. |
These define sets of codes used by systems conforming to this implementation guide.
| ESMD ActionRequested ValueSet |
Esmd-VS-ActionRequested is a custom esMD FHIR value set resource that contains the list of codes and related descriptions that are used to communicate specific registration request actions for providers using the esMD Service Registration workflow. |
| ESMD Error or Warning ValueSet |
Esmd-VS-AdminErrors is a custom esMD FHIR value set resource that contains the list of codes and related descriptions which are used to communicate specific admin error messages that are reported by the Review Contractor. |
| ESMD Error or Warning ValueSet |
Esmd-VS- ErrorOrWarningCodes is a custom esMD FHIR value set resource that contains the list of codes and related descriptions which are used to communicate specific error or warning messages that are reported by the esMD workflow. |
| ESMD Facility Type Codes |
Esmd-VS-FacilityTypeCodes is a ValueSet containing a subset of facility type codes used by the esMD system to categorize healthcare facilities involved in medical document submissions and processing. |
| ESMD MimeTypes ValueSet |
Esmd-VS-MimeTypes is a custom esMD FHIR value set resource that contains the list of supported Multipurpose Internet Mail Extension (MIME) type codes and related descriptions that are used to identify the format of a base64-encoded binary document which is attached to a transaction that is processed by esMD. |
| ESMD ReviewContractorOIDs ValueSet |
Esmd-VS-ReviewContractorOIDs is a custom esMD FHIR value set resource that contains the list of unique Organizational Identifier (OID) codes and descriptions (organization business names) which are used within the esMD System to identify and route transactions to Review Contractors (RCs). Note that a given RC may have multiple OIDs assigned to distinguish between jurisdictions. |
| ESMD Service Codes ValueSet |
Esmd-VS-ServiceCodes is a custom esMD FHIR value set resource that contains the list of codes and descriptions which identify the specific registration information required for a practitioner to register with esMD to send and receive clinical documents electronically. |
| ESMD StatusCodes ValueSet |
Esmd-VS-StatusCodes is a custom esMD FHIR value set resource that contains the list of codes and descriptions which provide status information about a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System to indicate that success or error conditions exist. |
| esMD Inbound Lines Of Business ValueSet |
Esmd-VS-IB-LinesOfBusiness is a custom esMD FHIR value set resource that contains the list of esMD Line of Business (LOB) codes (also known as Content Type Codes (CTCs)) and related descriptions that are used to communicate the specific type of service or payer-related information contained in inbound esMD transactions. |
| esMD Lines Of Business ValueSet |
Esmd-VS-LinesOfBusiness is a custom esMD FHIR value set resource that contains the list of esMD Line of Business (LOB) codes (also known as Content Type Codes (CTCs)) and related descriptions that are used to communicate the specific type of service or payer-related information contained in outbound esMD transactions. |
These define new code systems used by systems conforming to this implementation guide.
| ESMD Lines of Business Code System |
Esmd-CS-LinesOfBusiness is a custom esMD FHIR code system resource that contains the list of all esMD Line of Business (LOB) codes (also known as Content Type Codes (CTCs)) and related descriptions that are used to communicate the specific type of service or payer-related information for an esMD transaction. |
| ESMD Review Contractor OIDs |
Esmd-CS-ReviewContractorOIDs is a custom esMD FHIR code system resource that contains the list of all unique Organizational Identifier (OID) codes and descriptions (organization business name) which are used within the esMD System to identify and route transactions to Review Contractors (RCs). Note that a given RC may have multiple OIDs assigned to distinguish between jurisdictions. |
| ESMD supporting Service Codes |
Esmd-CS-ServiceCodes is a custom esMD FHIR code system resource that contains the list of all codes and descriptions which identify the specific registration information that allows a practitioner to register with esMD to send and receive clinical documents electronically. |
| Esmd Cover Sheet Administrative Errors |
This CodeSystem defines the administrative error codes for Esmd Cover Sheet submissions. |
| Esmd Error or Warning Messages |
Esmd-CS-ErrorOrWarningCodes is a custom esMD FHIR code system resource that contains the list of all codes and related descriptions that are used to communicate the specific error or warning messages that are reported within the esMD workflow. |
| Mime Types |
Esmd-CS-MimeTypes is a custom esMD FHIR code system resource that contains the list of all Multipurpose Internet Mail Extension (MIME) type codes and related descriptions that are used to identify the format of a base64-encoded binary document which is attached to a transaction that is processed by esMD. |
| Mime Types |
The RequestTypes Code System categorizes esMD transaction notifications into four types. ADMIN_ERROR notifications indicate that a Review Contractor (RC) found issues with a submitted package, making it unusable due to problems like corrupted files or incorrect metadata. VALIDATION_FAILURE notifications inform HIHs when a submitted bundle fails validation, listing errors that need correction. VALIDATION_SUCCESS confirms that a bundle has passed validation and has been forwarded to the RC. PICKUP notifications indicate whether an RC successfully retrieved a package from esMD, with failure notifications specifying the reason. These categories help HIHs efficiently track and manage their transactions. |
| Service Registration Action Requested |
Esmd-CS-ActionRequested is a custom esMD FHIR code system resource that contains the list of all codes and related descriptions that are used to communicate the specific registration request actions that are used within the esMD Service Registration workflow. |
| esMD Facility Type Codes |
Esmd-CS-FacilityTypeCodes defines a standardized set of codes representing types of healthcare facilities used within the esMD system to accurately identify facility categories during medical document exchanges. |
| esMD support Status Codes |
Esmd-CS-StatusCodes is a custom esMD FHIR code system resource that contains the list of all codes and descriptions which provide status information about a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System to indicate that success or error conditions exist. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Example-BundleSubmission-Error-Response |
This example |
| Example-BundleSubmission-Response-1 |
This example |
| Example-EMDRPostPay-FindBundleDocumentReferences |
This FHIR eSMD Find Bundle Document References example represents a searchset response for retrieving EMDR Postpay document references that are ready to download. The Bundle contains a DocumentReference resource, which provides metadata for the retrieved medical documentation. The DocumentReference includes key extensions such as Transaction ID, Organization ID, Review Contractor OID, and NPI, ensuring accurate tracking and identification of the request. The content section contains multiple attachments, including a PDF and an XML file, with details such as file size, hash, language, and creation timestamp. This structured response enables secure and standardized retrieval of medical records for post-payment review in compliance with FHIR interoperability standards. |
| Example-EMDRPostPayOther-FindBundleDocumentReference |
This FHIR eSMD Find Bundle Document References example represents a searchset response for retrieving EMDR Postpay document references that are ready to download. The Bundle contains a DocumentReference resource, which provides metadata for the retrieved medical documentation. The DocumentReference includes key extensions such as Transaction ID, Organization ID, Review Contractor OID, and NPI, ensuring accurate tracking and identification of the request. The content section contains multiple attachments, including a PDF and an XML file, with details such as file size, hash, language, and creation timestamp. This structured response enables secure and standardized retrieval of medical records for post-payment review in compliance with FHIR interoperability standards. |
| Example-Letter-FindBundleDocumentReference |
This FHIR eSMD Find Bundle Document References example represents a searchset response for retrieving EMDR Postpay document references that are ready to download. The Bundle contains a DocumentReference resource, which provides metadata for the retrieved medical documentation. The DocumentReference includes key extensions such as Transaction ID, Organization ID, Review Contractor OID, and NPI, ensuring accurate tracking and identification of the request. The content section contains multiple attachments, including a PDF and an XML file, with details such as file size, hash, language, and creation timestamp. This structured response enables secure and standardized retrieval of medical records for post-payment review in compliance with FHIR interoperability standards. |
| Example-PAReject-FindBundleDocumentReference |
This FHIR eSMD Find Bundle Document References example represents a searchset response for retrieving EMDR Postpay document references that are ready to download. The Bundle contains a DocumentReference resource, which provides metadata for the retrieved medical documentation. The DocumentReference includes key extensions such as Transaction ID, Organization ID, Review Contractor OID, and NPI, ensuring accurate tracking and identification of the request. The content section contains multiple attachments, including a PDF and an XML file, with details such as file size, hash, language, and creation timestamp. This structured response enables secure and standardized retrieval of medical records for post-payment review in compliance with FHIR interoperability standards. |
| Example-PAResponse-FindBundleDocumentReference |
This FHIR eSMD Find Bundle Document References example represents a searchset response for retrieving EMDR Postpay document references that are ready to download. The Bundle contains a DocumentReference resource, which provides metadata for the retrieved medical documentation. The DocumentReference includes key extensions such as Transaction ID, Organization ID, Review Contractor OID, and NPI, ensuring accurate tracking and identification of the request. The content section contains multiple attachments, including a PDF and an XML file, with details such as file size, hash, language, and creation timestamp. This structured response enables secure and standardized retrieval of medical records for post-payment review in compliance with FHIR interoperability standards. |
| Example-TC001-Esmd-Practitioner |
This example represents an esMD Practitioner resource, detailing a provider's contact information, NPI, Provider Tax ID, and requested service details. It ensures structured data exchange with security labels, service dates, and action codes for regulatory compliance. |
| Example-TC001-Esmd-Practitioner-Response |
This example represents an esMD Practitioner Response, detailing a healthcare provider's information, including NPI, Provider Tax ID, and Service Codes. It includes metadata for confidentiality, service dates, and contact details, ensuring secure and structured provider data exchange. |
| Example-TC008-BundleSubmission-Multipayload-Response |
Refer Testing page - TC008 Multipayload Response |
| Example-generate-presigned-url |
This example |
| Example-generate-presigned-url-response |
This example |
| ExampleEsmdDocumentReferenceValid |
This example |
| Sample Esmd List Submission Set |
The Example-ListSubmissionSet instance represents a FHIR List resource used for submitting metadata in the esMD system. It includes key details such as Organization ID, Intended Recipient, Lines of Business ID, Claim ID, Case ID, Split Number, and Attachment Control Number, which help categorize and track submissions. The Response Type Category is set to ACK, indicating acknowledgment. The resource is assigned a unique identifier and parent unique ID for tracking purposes. The status is marked as 'current', and the mode is 'working', confirming that it is an active submission. The List resource also references a DocumentReference (12345), ensuring structured integration of clinical documents within the esMD framework. |
| Submission Set Title |
Provider Delivery Confirmation. |
| Submission Set Title |
Provider Delivery Confirmation. |
| Submission Set Title |
The list-001 instance represents a FHIR List resource used for submitting metadata in the esMD system. It includes key extensions such as Lines of Business ID, Organization ID, Intended Recipient, Case ID, Unique ID, Response Type Category, NPI, and Claim ID, which help categorize and track submissions. The status is marked as current, and the mode is set to working, indicating an active submission. The submission set title and timestamp provide additional context for the record. This List resource references a DocumentReference (doc-001), ensuring the structured exchange of clinical documents within the esMD framework. |
| TC001-BundleSubmission |
This example represents an esMD Bundle Submission, containing a ListSubmissionSet and DocumentReference for secure healthcare document exchange. It includes metadata like OrganizationId, CaseId, and ClaimId, with the document securely stored in S3 and categorized under LOINC codes with strict confidentiality. |
| TC001-BundleSubmission-Requestid1 |
This example |
| TC001-BundleSubmission-Response |
This example represents an esMD Bundle Submission Response, confirming the successful creation of ListSubmissionSet and DocumentReference resources. Each entry includes a 201 Created status, resource location, and an OperationOutcome message indicating successful processing. The response ensures proper tracking with an ESMDTransactionId and diagnostic details for execution time. |
| TC001-BundleSubmission-Responseid1 |
This example represents an esMD Bundle Submission Response, confirming the successful creation of ListSubmissionSet and DocumentReference resources. It includes transaction details, response statuses, and execution diagnostics for tracking. |
| TC001-Practitioner |
This example represents an esMD Practitioner resource, detailing a provider's contact information, NPI, Provider Tax ID, and requested service details. It ensures structured data exchange with security labels, service dates, and action codes for regulatory compliance. |
| TC001-PractitionerResponse |
This example represents an esMD Practitioner Response, detailing a healthcare provider's information, including NPI, Provider Tax ID, and Service Codes. It includes metadata for confidentiality, service dates, and contact details, ensuring secure and structured provider data exchange. |
| TC0011-BundleSubmission-Ambulance-Response |
Refer Testing page - TC009 Ambulance Response |
| TC0012-BundleSubmission-PWK |
Refer Testing page - TC0012 Ambulance |
| TC0012-BundleSubmission-PWK-Response |
Refer Testing page - TC0012 PWK |
| TC0013-BundleSubmission-Ambulance |
Refer Testing page - TC0013 Ambulance |
| TC0013-BundleSubmission-Ambulance-Response |
Refer Testing page - TC0013 Ambulance Response |
| TC002-BundleSubmission-Validation-Success |
This example |
| TC002-Practitioner |
This example represents an esMD Practitioner resource, detailing a provider's contact information, NPI, Provider Tax ID, and requested service details. It ensures structured data exchange with security labels, service dates, and action codes for regulatory compliance. |
| TC002-PractitionerResponse |
This example represents an esMD Practitioner Response, detailing a healthcare provider's information, including NPI, Provider Tax ID, and Service Codes. It includes metadata for confidentiality, service dates, and contact details, ensuring secure and structured provider data exchange. |
| TC003-BundleSubmission-Pickup-Success |
This Pickup Notification confirms that the Review Contractor (RC) successfully downloaded the package from esMD and sent a pickup notification. It includes transaction details, status codes, timestamps, and organization identifiers to ensure secure and traceable document retrieval. |
| TC003-Practitioner |
This example represents an esMD Practitioner resource, detailing a provider's contact information, NPI, Provider Tax ID, and requested service details. It ensures structured data exchange with security labels, service dates, and action codes for regulatory compliance. |
| TC003-PractitionerResponse |
Refer Testing page - TC003 |
| TC004-BundlePractitioner |
Refer Testing page - TC004 |
| TC004-BundlePractitionerResponse |
Refer Testing page - TC004 Response |
| TC004-BundleSubmission-Admin-Errors |
Refer Testing page - TC004 Admin Errors |
| TC005-BundlePractitioner |
Refer Testing page - TC005 |
| TC005-BundlePractitionerResponse |
Refer Testing page - TC005 Response |
| TC005-BundleSubmission-Requestid5 |
Refer Testing page - Bundle Submission TC005 |
| TC006-BundlePractitioner |
Refer Testing page - TC006 Bundle Practitioner |
| TC006-BundlePractitionerResponse |
Refer Testing page - TC006 Bundle Practitioner Response |
| TC006-BundleSubmission-Requestid6 |
Refer Testing page - TC006 BS Request |
| TC007-BundlePractitioner |
Refer Testing page - TC007 Bundle Practitioner |
| TC007-BundlePractitionerResponse |
Refer Testing page - TC007 Bundle Practitioner Response |
| TC007-Validation-Failure-Notification |
Refer Testing page - TC007 Validation Failure Notification |
| TC008-BundleSubmission-Multipayload |
Refer Testing page - TC008 Multipayload |
| TC009-BundleSubmission-SplitRequest1 |
Refer Testing page - TC009 SplitNumber |
| TC009-BundleSubmission-SplitRequest1-Response |
Refer Testing page - TC009 SplitNumber Response |
| TC009-BundleSubmission-SplitRequest2 |
Refer Testing page - TC009 SplitNumber |
| TC009-BundleSubmission-SplitRequest2-Response |
Refer Testing page - TC009 SplitNumber Response |
| TC009-BundleSubmission-SplitRequest3 |
Refer Testing page - TC009 SplitNumber |
| TC009-BundleSubmission-SplitRequest3-Response |
Refer Testing page - TC009 SplitNumber Response |
| TC010-BundleSubmission-DuplicateUniqueId |
Refer Testing page - TC009 DuplicateUniqueId |
| a6e9ea73-e38d-4a77-b629-4984c58cda4f |
Binary Information. |
| d59fe425-7d1b-4763-af82-f713b4874e8b |
This is Example |
| doc-002 |
This example |
| esMD - Meta Data Validation and Persistence |
This example |
| title |
This example |
| title |
This example |