This page is part of the Data Access Framework (v2.0.0: STU 2) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

Example: CapabilityStatement-daf-datasource

Formats: Narrative, XML, JSON, Turtle

Raw xml

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="daf-datasource"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
			<h2>Data Source</h2>
			<p>Published: 2016-08-10</p>
			<p>Published by:
        <b>
					<a href="http://www.healthit.gov/">U.S. Office of the National Coordinator (ONC)</a>
				</b>
			</p>
			<p>This profile defines the expected capabilities of the <i>Data Source</i> actor when conforming to the <a href="index.html">DAF-Research IG</a>. The statement includes the complete list of actual profiles, RESTful operations, search parameters supported by a Data Source.
      </p>
			<h2>General</h2>
			<table>
				<tbody>
					<tr>
						<th>FHIR Version:</th>
						<td>STU3</td>
					</tr>
					<tr>
						<th>Supported formats:</th>
						<td>json and xml</td>
					</tr>
				</tbody>
			</table>
			<h2>REST  behavior</h2>
			<p>For the resources and operations supported by the Data Source, the RESTful behavior SHALL conform to the <a href="http://hl7.org/fhir/STU3/http.html">FHIR </a> specification. The Data Source SHOULD use either US-Core or DAF-Research profiles as needed to extract data. The Data Source SHOULD support both json and xml resource formats for all DAF interactions. The Data Source SHOULD identify the DAF profile(s) supported as part of the FHIR BaseResource.Meta.profile attribute for each instance. The Data Source SHOULD declare a Capability statement and identify the list of profiles, operations, search parameter supported.
      </p>
			<p>
				<b>Security:</b>
			</p>
			<p>Data Sources are advised to implement security requirements according to their existing protocols for data extraction purposes.
	  However Data Sources implementing US-Core IG SHOULD reuse US-Core security protocols for data extraction purposes as applicable. Data Sources SHOULD honour patient's data disclosure polices.
      </p>
			<h3>RESTful Operations Summary</h3>
			<table class="grid">
				<thead>
					<tr>
						<th>Resource(Profile Name)</th>
						<th>
							<a href="http://hl7.org/fhir/http.html">Search</a>
						</th>
						<th>
							<a href="http://hl7.org/fhir/http.html">Read</a>
						</th>
						<th>
							<a href="http://hl7.org/fhir/http.html">Version Read</a>
						</th>
						<th>
							<a href="http://hl7.org/fhir/http.html">Instance History</a>
						</th>
						<th>
							<a href="http://hl7.org/fhir/http.html">Create</a>
						</th>
						<th>
							<a href="http://hl7.org/fhir/http.html">Update</a>
						</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<th>
							<a href="StructureDefinition-daf-task.html">DAF-Task</a>
						</th>
						<td>
							<a href="#DAFTaskSearch" title="Allows discovery of DAF-Task resources based on different search criteria">SHOULD</a>
						</td>
						<td>
							<p title="Allows retrieval of a specific DAF-Task by resource id">SHOULD</p>
						</td>
						<td>
							<p title="Allows retrieval of a historical version of a DAF-Task">SHOULD</p>
						</td>
						<td>
							<p title="Allows review of changes to DAF-Task over time">SHOULD</p>
						</td>
						<td>
							<p title="Allows creation of DAF-Task">SHOULD</p>
						</td>
						<td>
							<p title="Allows updates to DAF-Task">SHOULD</p>
						</td>
					</tr>
					<tr>
						<th>
							<a href="http://hl7.org/fhir/STU3/ig/Healthedata1/US-Core">US-Core profiles</a>
						</th>
						<td>
							<p title="Allows discovery of US-Core resources based on different search criteria">SHOULD</p>
						</td>
						<td>
							<p title="Allows retrieval of a specific US-Core resources by resource id">SHOULD</p>
						</td>
						<td>
							<p title="Allows retrieval of a historical version of a US-Core">SHOULD</p>
						</td>
						<td>
							<p title="Allows review of changes to US-Core over time">SHOULD</p>
						</td>
						<td>
							<p title="Allows creation of US-Core">MAY</p>
						</td>
						<td>
							<p title="Allows updates to US-Core">MAY</p>
						</td>
					</tr>
				</tbody>
			</table>
			<br/>
			<br/>
			<h3>Data Source Search Parameters</h3>
			<p>Data Sources SHOULD support the following common parameters as part of queries related to DAF-Research profiles:</p>
			<ul>
				<li>
					<a href="http://hl7.org/fhir/STU3/search.html#id">_id</a>
				</li>
				<li>
					<a href="http://hl7.org/fhir/STU3/search.html#lastUpdated">_lastUpdated</a>
				</li>
				<li>
					<a href="http://hl7.org/fhir/STU3/search.html#profile">_profile</a>
				</li>
				<li>
					<a href="http://hl7.org/fhir/STU3/search.html#count">_count</a>
				</li>
				<li>
					<a href="http://hl7.org/fhir/STU3/search.html#include">_include</a>
				</li>
			</ul>
			<p>Data Sources SHOULD support the following search contexts defined within the
        <a href="http://hl7.org/fhir/STU3/search.html#introduction">FHIR</a> specification.
      </p>
			<ul>
				<li>Search context by specifying a particular resource type</li>
			</ul>
			<table class="grid">
				<thead>
					<tr>
						<th>Resource Name</th>
						<th>Search and Include Parameters</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td id="DAFTaskSearch">DAF-Task</td>
						<td>
							<ul>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">identifier</a> - Search based on Task identifier (
                  <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)
                </li>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">code</a> - Search based on Task code (
                  <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)
                </li>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">status</a> - Search based on Task status (
                  <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)
                </li>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">part-of</a> - Search based on Task this Task is part of (
                  <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>)
                </li>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">owner</a> - Search based on Task owner (
                  <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>)
                </li>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">performer</a> - Search based on Task performer type (
                  <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)
                </li>
								<li>
									<a href="http://hl7.org/fhir/STU3/task.html#search">requester</a> - Search based on Task requester (
                  <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>)
                </li>
							</ul>
						</td>
					</tr>
					<tr>
						<td id="DAFCoreProfilesSearch">US-Core profiles</td>
						<td>
							<ul>
								<li>
                 Search parameters provided by the US-Core IG
                </li>
							</ul>
						</td>
					</tr>
				</tbody>
			</table>
			<h3>DAF-Research Specific Operations</h3>
			<p>Data Sources SHOULD support <a href="http://hl7.org/fhir/patient-operations.html#everything">Patient/$everything</a> operation using the US-Core profiles.</p>
			<p>Data Sources SHALL support <a href="OperationDefinition-daf-extract.html">daf-extract-operation</a> on the ROOT URL of the system.</p>
			<p>Data Marts SHALL publish their Capability statement using the DAF-Capability profile and identify the specific operations supported.</p>
		</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/daf-research/CapabilityStatement/daf-datasource"/>
  <version value="1.0.0"/>
  <name value="Data Source"/>
  <status value="draft"/>
  <date value="2016-08-10"/>
  <publisher value="U.S. Office of the National Coordinator (ONC)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://www.healthit.gov/"/>
    </telecom>
  </contact>
  <description
               value="This profile defines the expected capabilities of the Data Source actor when conforming to the DAF-Research IG."/>
  <kind value="requirements"/>
  <fhirVersion value="3.0.0"/>
  <acceptUnknown value="extensions"/>
  <format value="xml"/>
  <format value="json"/>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-task"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-device"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-observationresults"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"/>
  </profile>
  <profile>
    <reference value="http://hl7.org/fhir/StructureDefinition/vitalsigns"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/>
  </profile>
  <profile>
    <reference
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"/>
  </profile>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The Data Source SHALL support the DAF-Task profile, the daf-extract-operation and SHOULD support the US-Core profiles"/>
    <security>
      <description
                   value="Data Source SHALL use appropriate security protocols for data extraction."/>
    </security>
    <resource>
      <type value="Task"/>
      <profile>
        <reference
                   value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-task"/>
      </profile>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows discovery of existing DAF-Task resources using different search criteria"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific DAF-Task by id"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to DAF-Task instance over time"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="vread"/>
        <documentation
                       value="Allows retrieval of a historical version of a DAF-Task instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows creation of a DAF-Task instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows updation of a DAF-Task instance"/>
      </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="status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="code"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="part-of"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="owner"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="performer"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="requester"/>
        <type value="reference"/>
      </searchParam>
    </resource>
    <operation>
      <name value="daf-extract-operation"/>
      <definition>
        <reference
                   value="http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-extract"/>
      </definition>
    </operation>
    <operation>
      <name value="patient-everything"/>
      <definition>
        <reference
                   value="http://hl7.org/fhir/OperationDefinition/Patient-everything"/>
      </definition>
    </operation>
  </rest>
</CapabilityStatement>