Finding and Retrieving Document Entries IHE ITI-67 - XML Representation

Radiology (Sandbox)
0.0.1-current - ci-build International flag
Requirement Specification

This is for collaboration and discussion purposes and is subject to change.

This is not an Implementation Guide
Radiology (Sandbox) - Local Development build (v0.0.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
: Finding and Retrieving Document Entries IHE ITI-67 - XML Representation

Draft as of 2024-04-20
Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="FindDocumentsMHD"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement FindDocumentsMHD</b></p><a name="FindDocumentsMHD"> </a><a name="hcFindDocumentsMHD"> </a><a name="FindDocumentsMHD-en-US"> </a><h2 id="title">Finding and Retrieving Document Entries</h2><ul><li>Implementation Guide Version: 0.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-20 </li><li>Published by: NHS England </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>Recommend <a href="subdomain-audits.html">ATNA/NHS England Audits</a>, encouraged <a href="https://profiles.ihe.net/ITI/IUA/index.html">IHE-IUA</a> plus <a href="https://www.hl7.org/fhir/smart-app-launch/">SMART-on-FHIR</a></p>
</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="#DocumentReference1-1">DocumentReference</a></td><td><a href="StructureDefinition-DocumentEntry.html">https://fhir.nhs.uk/England/RAD/StructureDefinition/DocumentEntry</a><br/><em>Additional supported profiles:</em><br/>  <code>https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference</code></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>_id, _lastupdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="DocumentReference1-1" 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-DocumentEntry.html">Document Entry</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><code>https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference</code></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><h3>Read</h3>
<pre><code>GET /DocumentReference/{id}
</code></pre>
<h4>Example</h4>
<pre><code>GET /DocumentReference/1234
</code></pre>
<p>Example API response:</p>
<ul>
<li><a href="DocumentReference-DocumentReferenceRadiologyIHE.html">DocumentReference IHE for Radiology</a></li>
</ul>
<h3>Search</h3>
<pre><code>GET /DocumentReference?{parameters}
</code></pre>
<h4>Example</h4>
<pre><code>GET /DocumentReference?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888&amp;category=http://snomed.info/sct|721981007,http://snomed.info/sct|4201000179104
</code></pre>
<p>Example response:</p>
<ul>
<li><a href="Bundle-MHDSearchResultsDocuments.html">Document Reference Search Results MHD</a></li>
</ul>
<p>Implementers <strong>SHALL</strong> also conform to <a href="https://simplifier.net/hl7fhirukcorer4/ukcore-documentreference">UKCore-DocumentReference</a> and conformance to all profiles <strong>SHOULD</strong> be tested via <a href="https://hl7.org/fhir/R4/validation.html">FHIR Validation</a>.</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>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_lastupdated</td><td><code>date</code></td><td><div><p>When the resource version last changed</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>author.given</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>author.family</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Categorization of document</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="https://profiles.ihe.net/ITI/MHD/4.2.1/SearchParameter-DocumentReference-Creation.html">creation</a></td><td><code>date</code></td><td><div><p>When this document was created</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>When this document reference was created</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>event</td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>facility</td><td><code>token</code></td><td><div><p>Kind of facility where patient was seen</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>format</td><td><code>token</code></td><td><div><p>Format/content rules for the document</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>The identifier for this DocumentReference</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>reference</code></td><td><div><p>An Identifier for Who/what is the subject of the document</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>period</td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>related</td><td><code>reference</code></td><td><div><p>Related Resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>security-label</td><td><code>token</code></td><td><div><p>Document security-tags</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>setting</td><td><code>token</code></td><td><div><p>Additional details about where the content was created - e.g. clinical specialty</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>Kind of document</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindDocumentsMHD"/>
  <version value="0.0.1-current"/>
  <name value="FindDocumentsMHD"/>
  <title value="Finding and Retrieving Document Entries"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2024-04-20"/>
  <publisher value="NHS England"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="https://www.ihe.net/ihe_domains/it_infrastructure/"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <contact>
    <name value="NHS England"/>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <description
               value="Finding and Retrieving Document Entries

This is [IHE Mobile access to Health Documents (MHD) - Find Document References ITI-67](https://profiles.ihe.net/ITI/MHD/ITI-67.html) linked to UK/NHS England specific Document Metadata"/>
  <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="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="server"/>
    <security>
      <description
                   value="Recommend [ATNA/NHS England Audits](subdomain-audits.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) plus [SMART-on-FHIR](https://www.hl7.org/fhir/smart-app-launch/)"/>
    </security>
    <resource>
      <type value="DocumentReference"/>
      <profile
               value="https://fhir.nhs.uk/England/RAD/StructureDefinition/DocumentEntry"/>
      <supportedProfile
                        value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"/>
      <documentation
                     value="
### Read

```
GET /DocumentReference/{id}
```

#### Example

```
GET /DocumentReference/1234
```

Example API response:

- [DocumentReference IHE for Radiology](DocumentReference-DocumentReferenceRadiologyIHE.html)

### Search

```
GET /DocumentReference?{parameters}
```

#### Example

```
GET /DocumentReference?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888&amp;category=http://snomed.info/sct|721981007,http://snomed.info/sct|4201000179104
```

Example response:
- [Document Reference Search Results MHD](Bundle-MHDSearchResultsDocuments.html)

Implementers **SHALL** also conform to [UKCore-DocumentReference](https://simplifier.net/hl7fhirukcorer4/ukcore-documentreference) and conformance to all profiles **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).
"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation value="Logical id of this artifact"/>
      </searchParam>
      <searchParam>
        <name value="_lastupdated"/>
        <type value="date"/>
        <documentation value="When the resource version last changed"/>
      </searchParam>
      <searchParam>
        <name value="author.given"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="author.family"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="category"/>
        <type value="token"/>
        <documentation value="Categorization of document"/>
      </searchParam>
      <searchParam>
        <name value="creation"/>
        <definition
                    value="https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation"/>
        <type value="date"/>
        <documentation value="When this document was created"/>
      </searchParam>
      <searchParam>
        <name value="date"/>
        <type value="date"/>
        <documentation value="When this document reference was created"/>
      </searchParam>
      <searchParam>
        <name value="event"/>
        <type value="token"/>
        <documentation value="Main clinical acts documented"/>
      </searchParam>
      <searchParam>
        <name value="facility"/>
        <type value="token"/>
        <documentation value="Kind of facility where patient was seen"/>
      </searchParam>
      <searchParam>
        <name value="format"/>
        <type value="token"/>
        <documentation value="Format/content rules for the document"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="The identifier for this DocumentReference"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <type value="reference"/>
        <documentation value="Who/what is the subject of the document"/>
      </searchParam>
      <searchParam>
        <name value="patient.identifier"/>
        <type value="reference"/>
        <documentation
                       value="An Identifier for Who/what is the subject of the document"/>
      </searchParam>
      <searchParam>
        <name value="period"/>
        <type value="date"/>
        <documentation value="Time of service that is being documented"/>
      </searchParam>
      <searchParam>
        <name value="related"/>
        <type value="reference"/>
        <documentation value="Related Resource"/>
      </searchParam>
      <searchParam>
        <name value="security-label"/>
        <type value="token"/>
        <documentation value="Document security-tags"/>
      </searchParam>
      <searchParam>
        <name value="setting"/>
        <type value="token"/>
        <documentation
                       value="Additional details about where the content was created - e.g. clinical specialty"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <type value="token"/>
        <documentation value="current | superseded | entered-in-error"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation value="Kind of document"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>
<prev
top
next>