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

CapabilityStatement: esMD FHIR Server Capability Statement

Official URL: https://terminology.esmduat.cms.gov:8099/fhir/CapabilityStatement/Esmd-Fhir-Server-Capability Version: 1.0.0
Active as of 2024-09-28 Computable Name: EsmdFhirServer

This CapabilityStatement describes the esMD FHIR Server, which handles submission, retrieval, and validation of medical documentation, including security via OAuth2 and IP whitelisting.

To define the capabilities of the esMD FHIR Server with specific profiles, resources, extensions, and security protocols.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement Esmd-Fhir-Server-Capability

esMD FHIR Server Capability Statement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/json
  • Supported Patch Formats:
  • Published on: 2024-09-28
  • Published by: CMS FHIR esMD

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.

SHALL Support the Following Implementation Guides

  • https://d2we5dsk2cokqn.cloudfront.net

FHIR RESTful Capabilities

Mode: server

The esMD FHIR server supports electronic submission, retrieval, and validation of medical documentation, with specific esMD profiles, extensions, and security.

Security
  1. See the Security section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" .
Summary of System-wide Interactions

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
Bundlehttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleSubmission
Additional supported profiles:
  Esmd Bundle Service Registration Profile
  Esmd Find Bundle List Notifications
  Esmd Find Bundle Document References		y
Listhttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListSubmissionSet
Additional supported profiles:
  Esmd List Provider Confirmation Profile
  Find List of Transaction Notification from esMD		yyuniqueId, statusCode
DocumentReferencehttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-DocumentReference
Additional supported profiles:
  Esmd Document Reference Profile		yyuniqueId, statusCode
Binaryhttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Binaryy
Practitionerhttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitionery

Resource Conformance: supported Bundle

Base System Profile
Esmd Bundle Submission Profile
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Esmd Bundle Service Registration Profile
Esmd Find Bundle List Notifications
Esmd Find Bundle Document References

Interaction summary
  • Supports create.

Documentation

Handles transaction bundles for esMD submissions, including Esmd-ListSubmissionSet, Esmd-DocumentReference, and Esmd-Binary.

Resource Conformance: supported List

Base System Profile
Esmd List SubmissionSet Profile
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Esmd List Provider Confirmation Profile
Find List of Transaction Notification from esMD

Interaction summary
  • Supports create, read.

Documentation

The List resource is embedded within the provider delivery confirmation bundle and supports multiple esMD-specific extensions.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLuniqueIdtoken

Search by the unique identifier for List resource.

SHALLstatusCodetoken

Search by the status code for List resource.

 

Resource Conformance: supported DocumentReference

Base System Profile
Esmd Document Reference Profile
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Esmd Document Reference Profile

Interaction summary
  • Supports create, read.

Documentation

The List resource is embedded within the provider delivery confirmation bundle and supports multiple esMD-specific extensions.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLuniqueIdtoken

Search by the unique identifier for List resource.

SHALLstatusCodetoken

Search by the status code for List resource.

 

Resource Conformance: supported Binary

Base System Profile
Esmd Binary Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create.

Documentation

Binary resources for esMD transactions must follow the Esmd-Binary profile and include the UniqueId extension.

Resource Conformance: supported Practitioner

Base System Profile
EsMD Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update.

Documentation

Handles service registration transaction bundles, containing Esmd-Practitioner resources.