Radiation Dose Summary for Diagnostic Procedures on FHIR
1.0.0 - STU 1

Radiation Dose Summary for Diagnostic Procedures on FHIR, published by HL7 International / Imaging Integration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-radiation-dose-summary-ig/ and changes regularly. See the Directory of published versions

## : FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors - XML Representation

Page standards status: Trial-use | Maturity Level: 2

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="FHIRServer"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement FHIRServer</b></p><a name="FHIRServer"> </a><a name="hcFHIRServer"> </a><h2 id="title">FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Published on: 2021-06-28 </li><li>Published by: HL7 International / Imaging Integration </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><a href="index.html">http://hl7.org/fhir/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary</a></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>Description of the needed resources to be supported by the FHIR server, and the different possible interactions.</p>
    </div><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction.</li><li>Supports the <code>search-system</code>interaction.</li></ul></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="#Patient1-1">Patient</a></td><td> </td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"><span title="MAY">y?</span></td><td>identifier, given</td><td/><td/><td/></tr><tr><td><a href="#Practitioner1-2">Practitioner</a></td><td> </td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"><span title="MAY">y?</span></td><td>identifier, given</td><td/><td/><td/></tr><tr><td><a href="#ImagingStudy1-3">ImagingStudy</a></td><td> </td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"><span title="MAY">y?</span></td><td>patient</td><td/><td/><td/></tr><tr><td><a href="#Device1-4">Device</a></td><td> </td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"><span title="MAY">y?</span></td><td>manufacturer</td><td/><td/><td/></tr><tr><td><a href="#Observation1-5">Observation</a></td><td> </td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td>identifier, code, patient, device, part-of, date</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Patient</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/patient.html">Patient</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><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li><li><strong>MAY</strong> support <code>create</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Search and Read of patient needs to be available on FHIR server, and patient create can be activated based on the covered use case.</p>
    </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>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td>given</td><td><code>string</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Practitioner1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Practitioner</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/practitioner.html">Practitioner</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><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li><li><strong>MAY</strong> support <code>create</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Search and Read of practitioner shall be supported.</p>
    </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>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td>given</td><td><code>string</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="ImagingStudy1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </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><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li><li><strong>MAY</strong> support <code>create</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Search and Read of ImagingStudy shall be supported.</p>
    </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>MAY</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Device1-4" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Device</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/device.html">Device</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><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li><li><strong>MAY</strong> support <code>create</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Search and Read of Device shall be supported.</p>
    </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>MAY</b></td><td>manufacturer</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-5" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Observation</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/observation.html">Observation</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><strong>SHALL</strong> support <code>create</code>, <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Create, Search and read Radiation Summary observations shall be supported.</p>
    </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>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div><p>Search based on identifiers of radiation dose summary like Accession Number</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Search based on patient identifier</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>device</td><td><code>token</code></td><td><div><p>Search based on modality identifiers</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>part-of</td><td><code>reference</code></td><td><div><p>Search based on ImagingStudy</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Search based on Radiation Summary effective dateTime, can be used to search for radiation through a period of time</p>
    </div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><h2 id="document">FHIR Document Capabilities</h2><table class="table table-condensed table-hover"><thead><tr><th>Mode</th><th>Document Resource Profile</th><th>Documentation</th></tr></thead><tbody><tr><td>consumer</td><td><a href="StructureDefinition-radiation-summary-report.html">Radiation Summary Report</a></td><td><div><p>Documents related to Radiation Summary Report profile.</p>
    </div></td></tr></tbody></table></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="ii"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="2">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary"/>
          </extension>
        </valueInteger>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/uv/radiation-dose-summary/CapabilityStatement/FHIRServer"/>
      <version value="1.0.0"/>
      <name value="RDSC_FHIRServer"/>
      <title
             value="FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors"/>
      <status value="active"/>
      <date value="2021-06-28"/>
      <publisher value="HL7 International / Imaging Integration"/>
      <contact>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/imagemgt"/>
        </telecom>
      </contact>
      <contact>
        <name value="HL7 Imaging Integration Workgroup"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/imagemgt"/>
        </telecom>
      </contact>
      <contact>
        <name value="Abderrazek Boufahja"/>
        <telecom>
          <system value="email"/>
          <value value="abderrazek.boufahja@gehealthcare.com"/>
        </telecom>
      </contact>
      <description
                   value="Defines the operations requirement for FHIR server actor"/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
        </coding>
      </jurisdiction>
      <kind value="requirements"/>
      <fhirVersion value="4.0.1"/>
      <format value="xml"/>
      <format value="json"/>
      <implementationGuide
                           value="http://hl7.org/fhir/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary"/>
      <rest>
        <mode value="server"/>
        <documentation
                       value="Description of the needed resources to be supported by the FHIR server, and the different possible interactions."/>
        <resource>
          <type value="Patient"/>
          <documentation
                         value="Search and Read of patient needs to be available on FHIR server, and patient create can be activated based on the covered use case."/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="search-type"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="identifier"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="given"/>
            <type value="string"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Practitioner"/>
          <documentation
                         value="Search and Read of practitioner shall be supported."/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="search-type"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="identifier"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="given"/>
            <type value="string"/>
          </searchParam>
        </resource>
        <resource>
          <type value="ImagingStudy"/>
          <documentation
                         value="Search and Read of ImagingStudy shall be supported."/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="search-type"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <name value="patient"/>
            <type value="reference"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Device"/>
          <documentation value="Search and Read of Device shall be supported."/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="search-type"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <name value="manufacturer"/>
            <type value="token"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Observation"/>
          <documentation
                         value="Create, Search and read Radiation Summary observations shall be supported."/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="search-type"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="identifier"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="code"/>
            <type value="token"/>
            <documentation
                           value="Search based on identifiers of radiation dose summary like Accession Number"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="patient"/>
            <type value="reference"/>
            <documentation value="Search based on patient identifier"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="device"/>
            <type value="token"/>
            <documentation value="Search based on modality identifiers"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="part-of"/>
            <type value="reference"/>
            <documentation value="Search based on ImagingStudy"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="date"/>
            <type value="date"/>
            <documentation
                           value="Search based on Radiation Summary effective dateTime, can be used to search for radiation through a period of time"/>
          </searchParam>
        </resource>
        <interaction>
          <code value="transaction"/>
        </interaction>
        <interaction>
          <code value="search-system"/>
        </interaction>
      </rest>
      <document>
        <mode value="consumer"/>
        <documentation
                       value="Documents related to Radiation Summary Report profile."/>
        <profile
                 value="http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/radiation-summary-report"/>
      </document>
    </CapabilityStatement>