SMART Imaging Access
0.1.0 - ci-build
SMART Imaging Access
0.1.0 - ci-build
SMART Imaging Access, published by Argonaut Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/smart-imaging/ and changes regularly. See the Directory of published versions
| Draft as of 2026-08-21 |
{
"resourceType" : "CapabilityStatement",
"id" : "smart-imaging-server",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement smart-imaging-server</b></p><a name=\"smart-imaging-server\"> </a><a name=\"hcsmart-imaging-server\"> </a><h2 id=\"title\">SMART Imaging Access Server</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2026-08-21 </li><li>Published by: Argonaut Project </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><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 class=\"lead\"><em>Security</em></div><blockquote><div><p>Requests carry a SMART on FHIR access token issued by the EHR's authorization server. The Imaging Server validates the token (for example, via SMART Token Introspection) and enforces patient context and scopes.</p>\n</div></blockquote></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=\"#ImagingStudy1-1\">ImagingStudy</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-smart-imaging-study.html\">SMART ImagingStudy</a></td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, identifier, _lastUpdated</td><td><code>ImagingStudy:endpoint</code></td><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ImagingStudy1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>ImagingStudy</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/imagingstudy.html\">ImagingStudy</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-smart-imaging-study.html\">SMART ImagingStudy</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>The server SHALL support searching ImagingStudy by patient, alone and in\ncombination with <code>_lastUpdated</code> and <code>identifier</code> (a DICOM Study Instance UID\nin <code>urn:oid:...</code> form). The server SHALL support <code>_include=ImagingStudy:endpoint</code>\nso apps receive the WADO-RS Endpoint for each study, whether contained or external.</p>\n<p>If results are not yet available (for example, the server is querying an\nunderlying PACS), the server MAY respond <code>503</code> with a <code>Retry-After</code> header;\nthe app retries after the indicated number of seconds.</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><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient whose studies are requested. SHALL be supported alone and in combination with <code>_lastUpdated</code> or <code>identifier</code>.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>A DICOM Study Instance UID in <code>urn:oid:...</code> form, used with <code>patient</code> to look up a specific study.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Used with <code>patient</code> to fetch only studies updated after a given time, e.g. <code>_lastUpdated=gt2023-04-17T04:00:00Z</code>.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "http://fhir.org/argonaut/smart-imaging/CapabilityStatement/smart-imaging-server",
"version" : "0.1.0",
"name" : "SmartImagingAccessServer",
"title" : "SMART Imaging Access Server",
"status" : "draft",
"date" : "2026-08-21",
"publisher" : "Argonaut Project",
"contact" : [
{
"name" : "Argonaut Project",
"telecom" : [
{
"system" : "url",
"value" : "https://confluence.hl7.org/display/AP/Argonaut+Project+Home"
}
]
}
],
"description" : "Requirements for the Imaging Server's FHIR endpoint. In addition to the FHIR\nbehavior described here, the server hosts or links to WADO-RS endpoints as\ndescribed in [Retrieving images](specification.html#retrieving-images), and\nvalidates SMART access tokens as described in\n[Authorization](specification.html#authorization).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"description" : "Requests carry a SMART on FHIR access token issued by the EHR's authorization server. The Imaging Server validates the token (for example, via SMART Token Introspection) and enforces patient context and scopes."
},
"resource" : [
{
"type" : "ImagingStudy",
"supportedProfile" : [
🔗 "http://fhir.org/argonaut/smart-imaging/StructureDefinition/smart-imaging-study"
],
"documentation" : "The server SHALL support searching ImagingStudy by patient, alone and in\ncombination with `_lastUpdated` and `identifier` (a DICOM Study Instance UID\nin `urn:oid:...` form). The server SHALL support `_include=ImagingStudy:endpoint`\nso apps receive the WADO-RS Endpoint for each study, whether contained or external.\n\nIf results are not yet available (for example, the server is querying an\nunderlying PACS), the server MAY respond `503` with a `Retry-After` header;\nthe app retries after the indicated number of seconds.",
"interaction" : [
{
"code" : "search-type"
}
],
"searchInclude" : [
"ImagingStudy:endpoint"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient whose studies are requested. SHALL be supported alone and in combination with `_lastUpdated` or `identifier`."
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "A DICOM Study Instance UID in `urn:oid:...` form, used with `patient` to look up a specific study."
},
{
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Used with `patient` to fetch only studies updated after a given time, e.g. `_lastUpdated=gt2023-04-17T04:00:00Z`."
}
]
}
]
}
]
}