Finding and Retrieving Document Entries IHE ITI-67 - TTL 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 - TTL Representation

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

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "FindDocumentsMHD"] ; # 
  fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<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>\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=\"#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>\n<pre><code>GET /DocumentReference/{id}\n</code></pre>\n<h4>Example</h4>\n<pre><code>GET /DocumentReference/1234\n</code></pre>\n<p>Example API response:</p>\n<ul>\n<li><a href=\"DocumentReference-DocumentReferenceRadiologyIHE.html\">DocumentReference IHE for Radiology</a></li>\n</ul>\n<h3>Search</h3>\n<pre><code>GET /DocumentReference?{parameters}\n</code></pre>\n<h4>Example</h4>\n<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\n</code></pre>\n<p>Example response:</p>\n<ul>\n<li><a href=\"Bundle-MHDSearchResultsDocuments.html\">Document Reference Search Results MHD</a></li>\n</ul>\n<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>\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>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr><tr><td><b>SHALL</b></td><td>related</td><td><code>reference</code></td><td><div><p>Related Resource</p>\n</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>\n</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>\n</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>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>Kind of document</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div></div>"
  ] ; # 
  fhir:url [ fhir:v "https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindDocumentsMHD"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "0.0.1-current"] ; # 
  fhir:name [ fhir:v "FindDocumentsMHD"] ; # 
  fhir:title [ fhir:v "Finding and Retrieving Document Entries"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:experimental [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:date [ fhir:v "2024-04-20"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "NHS England"] ; # 
  fhir:contact ( [
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.ihe.net/ihe_domains/it_infrastructure/" ]     ] )
  ] [
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ]     ] )
  ] [
fhir:name [ fhir:v "NHS England" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "Finding and Retrieving Document Entries\n\nThis 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"] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ]     ] )
  ] ) ; # 
  fhir:kind [ fhir:v "requirements"] ; # 
  fhir:fhirVersion [ fhir:v "4.0.1"] ; # 
  fhir:format ( [ fhir:v "application/fhir+xml"] [ fhir:v "application/fhir+json"] ) ; # 
  fhir:rest ( [
fhir:mode [ fhir:v "server" ] ;
fhir:security [
fhir:description [ fhir:v "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/)" ]     ] ;
    ( fhir:resource [
fhir:type [ fhir:v "DocumentReference" ] ;
fhir:profile [
fhir:v "https://fhir.nhs.uk/England/RAD/StructureDefinition/DocumentEntry"^^xsd:anyURI ;
fhir:link <https://fhir.nhs.uk/England/RAD/StructureDefinition/DocumentEntry>       ] ;
      ( fhir:supportedProfile [
fhir:v "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"^^xsd:anyURI ;
fhir:link <https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference>       ] ) ;
fhir:documentation [ fhir:v "\n### Read\n\n```\nGET /DocumentReference/{id}\n```\n\n#### Example\n\n```\nGET /DocumentReference/1234\n```\n\nExample API response:\n\n- [DocumentReference IHE for Radiology](DocumentReference-DocumentReferenceRadiologyIHE.html)\n\n### Search\n\n```\nGET /DocumentReference?{parameters}\n```\n\n#### Example\n\n```\nGET /DocumentReference?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888&category=http://snomed.info/sct|721981007,http://snomed.info/sct|4201000179104\n```\n\nExample response:\n- [Document Reference Search Results MHD](Bundle-MHDSearchResultsDocuments.html)\n\nImplementers **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).\n" ] ;
      ( fhir:interaction [
fhir:code [ fhir:v "read" ]       ] [
fhir:code [ fhir:v "search-type" ]       ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "_id" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Logical id of this artifact" ]       ] [
fhir:name [ fhir:v "_lastupdated" ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "When the resource version last changed" ]       ] [
fhir:name [ fhir:v "author.given" ] ;
fhir:type [ fhir:v "string" ]       ] [
fhir:name [ fhir:v "author.family" ] ;
fhir:type [ fhir:v "string" ]       ] [
fhir:name [ fhir:v "category" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Categorization of document" ]       ] [
fhir:name [ fhir:v "creation" ] ;
fhir:definition [
fhir:v "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation>         ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "When this document was created" ]       ] [
fhir:name [ fhir:v "date" ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "When this document reference was created" ]       ] [
fhir:name [ fhir:v "event" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Main clinical acts documented" ]       ] [
fhir:name [ fhir:v "facility" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Kind of facility where patient was seen" ]       ] [
fhir:name [ fhir:v "format" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Format/content rules for the document" ]       ] [
fhir:name [ fhir:v "identifier" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "The identifier for this DocumentReference" ]       ] [
fhir:name [ fhir:v "patient" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "Who/what is the subject of the document" ]       ] [
fhir:name [ fhir:v "patient.identifier" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "An Identifier for Who/what is the subject of the document" ]       ] [
fhir:name [ fhir:v "period" ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "Time of service that is being documented" ]       ] [
fhir:name [ fhir:v "related" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "Related Resource" ]       ] [
fhir:name [ fhir:v "security-label" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Document security-tags" ]       ] [
fhir:name [ fhir:v "setting" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Additional details about where the content was created - e.g. clinical specialty" ]       ] [
fhir:name [ fhir:v "status" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "current | superseded | entered-in-error" ]       ] [
fhir:name [ fhir:v "type" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Kind of document" ]       ] )     ] )
  ] ) . #
<prev
top
next>