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
| Active as of 2024-09-28 |
{
"resourceType" : "CapabilityStatement",
"id" : "Esmd-Fhir-Server-Capability",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement Esmd-Fhir-Server-Capability</b></p><a name=\"Esmd-Fhir-Server-Capability\"> </a><a name=\"hcEsmd-Fhir-Server-Capability\"> </a><a name=\"Esmd-Fhir-Server-Capability-en-US\"> </a><h2 id=\"title\">esMD FHIR Server Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code>, <code>application/json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-09-28 </li><li>Published by: CMS FHIR esMD </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li>https://d2we5dsk2cokqn.cloudfront.net</li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>The esMD FHIR server supports electronic submission, retrieval, and validation of medical documentation, with specific esMD profiles, extensions, and security.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"Security.html\">Security</a> section for requirements and recommendations.</li>\n<li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" .</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Bundle1-1\">Bundle</a></td><td><a href=\"StructureDefinition-Esmd-BundleSubmission.html\">https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleSubmission</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"StructureDefinition-Esmd-BundleServiceRegistration.html\">Esmd Bundle Service Registration Profile</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-Esmd-FindBundleListNotifications.html\">Esmd Find Bundle List Notifications</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-Esmd-FindBundleDocumentReferences.html\">Esmd Find Bundle Document References</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#List1-2\">List</a></td><td><a href=\"StructureDefinition-Esmd-ListSubmissionSet.html\">https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListSubmissionSet</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"StructureDefinition-Esmd-ListDeliveryConfirmation.html\">Esmd List Provider Confirmation Profile</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-Esmd-FindListTransactionNotification.html\">Find List of Transaction Notification from esMD</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td>uniqueId, statusCode</td><td/><td/><td/></tr><tr><td><a href=\"#DocumentReference1-3\">DocumentReference</a></td><td><a href=\"StructureDefinition-Esmd-DocumentReference.html\">https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-DocumentReference</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"StructureDefinition-Esmd-FindDocumentReference.html\">Esmd Document Reference Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td>uniqueId, statusCode</td><td/><td/><td/></tr><tr><td><a href=\"#Binary1-4\">Binary</a></td><td><a href=\"StructureDefinition-Esmd-Binary.html\">https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Binary</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Practitioner1-5\">Practitioner</a></td><td><a href=\"StructureDefinition-Esmd-Practitioner.html\">https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Bundle</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Esmd-BundleSubmission.html\">Esmd Bundle Submission Profile</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-Esmd-BundleServiceRegistration.html\">Esmd Bundle Service Registration Profile</a><br/><a href=\"StructureDefinition-Esmd-FindBundleListNotifications.html\">Esmd Find Bundle List Notifications</a><br/><a href=\"StructureDefinition-Esmd-FindBundleDocumentReferences.html\">Esmd Find Bundle Document References</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Handles transaction bundles for esMD submissions, including Esmd-ListSubmissionSet, Esmd-DocumentReference, and Esmd-Binary.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"List1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>List</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Esmd-ListSubmissionSet.html\">Esmd List SubmissionSet Profile</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-Esmd-ListDeliveryConfirmation.html\">Esmd List Provider Confirmation Profile</a><br/><a href=\"StructureDefinition-Esmd-FindListTransactionNotification.html\">Find List of Transaction Notification from esMD</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>The List resource is embedded within the provider delivery confirmation bundle and supports multiple esMD-specific extensions.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>uniqueId</td><td><code>token</code></td><td><div><p>Search by the unique identifier for List resource.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>statusCode</td><td><code>token</code></td><td><div><p>Search by the status code for List resource.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Esmd-DocumentReference.html\">Esmd Document Reference Profile</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-Esmd-FindDocumentReference.html\">Esmd Document Reference Profile</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>The List resource is embedded within the provider delivery confirmation bundle and supports multiple esMD-specific extensions.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>uniqueId</td><td><code>token</code></td><td><div><p>Search by the unique identifier for List resource.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>statusCode</td><td><code>token</code></td><td><div><p>Search by the status code for List resource.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Binary</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Esmd-Binary.html\">Esmd Binary Profile</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Binary resources for esMD transactions must follow the Esmd-Binary profile and include the UniqueId extension.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Practitioner</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Esmd-Practitioner.html\">EsMD Practitioner</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Handles service registration transaction bundles, containing Esmd-Practitioner resources.</p>\n</div></blockquote></div></div></div></div></div></div>"
},
"url" : "https://terminology.esmduat.cms.gov:8099/fhir/CapabilityStatement/Esmd-Fhir-Server-Capability",
"version" : "1.0.0",
"name" : "EsmdFhirServer",
"title" : "esMD FHIR Server Capability Statement",
"status" : "active",
"experimental" : false,
"date" : "2024-09-28",
"publisher" : "CMS FHIR esMD",
"contact" : [
{
"name" : "CMS FHIR esMD",
"telecom" : [
{
"system" : "url",
"value" : "https://www.cms.gov/data-research/computer-data-systems/esmd"
},
{
"system" : "email",
"value" : "esmd_support@cms.hhs.gov"
}
]
}
],
"description" : "This CapabilityStatement describes the esMD FHIR Server, which handles submission, retrieval, and validation of medical documentation, including security via OAuth2 and IP whitelisting.",
"purpose" : "To define the capabilities of the esMD FHIR Server with specific profiles, resources, extensions, and security protocols.",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+json",
"application/json"
],
"implementationGuide" : [
"https://d2we5dsk2cokqn.cloudfront.net"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The esMD FHIR server supports electronic submission, retrieval, and validation of medical documentation, with specific esMD profiles, extensions, and security.\n",
"security" : {
"description" : "1. See the [Security](Security.html) section for requirements and recommendations.\n2. A server **SHALL** reject any unauthorized requests by returning an HTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\" ."
},
"resource" : [
{
"type" : "Bundle",
"profile" : "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleSubmission",
"supportedProfile" : [
🔗 "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration"🔗 ,
"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindBundleListNotifications"🔗 ,
"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindBundleDocumentReferences"
],
"documentation" : "Handles transaction bundles for esMD submissions, including Esmd-ListSubmissionSet, Esmd-DocumentReference, and Esmd-Binary.",
"interaction" : [
{
"code" : "create"
}
]
},
{
"type" : "List",
"profile" : "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListSubmissionSet",
"supportedProfile" : [
🔗 "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListDeliveryConfirmation"🔗 ,
"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification"
],
"documentation" : "The List resource is embedded within the provider delivery confirmation bundle and supports multiple esMD-specific extensions.",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "uniqueId",
"type" : "token",
"documentation" : "Search by the unique identifier for List resource."
},
{
"name" : "statusCode",
"type" : "token",
"documentation" : "Search by the status code for List resource."
}
]
},
{
"type" : "DocumentReference",
"profile" : "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-DocumentReference",
"supportedProfile" : [
🔗 "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindDocumentReference"
],
"documentation" : "The List resource is embedded within the provider delivery confirmation bundle and supports multiple esMD-specific extensions.",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "uniqueId",
"type" : "token",
"documentation" : "Search by the unique identifier for List resource."
},
{
"name" : "statusCode",
"type" : "token",
"documentation" : "Search by the status code for List resource."
}
]
},
{
"type" : "Binary",
"profile" : "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Binary",
"documentation" : "Binary resources for esMD transactions must follow the Esmd-Binary profile and include the UniqueId extension.",
"interaction" : [
{
"code" : "create"
}
]
},
{
"type" : "Practitioner",
"profile" : "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner",
"documentation" : "Handles service registration transaction bundles, containing Esmd-Practitioner resources.",
"interaction" : [
{
"code" : "update"
}
]
}
]
}
]
}