SDOH Clinical Care
1.1.0 - STU 2 ballot
SDOH Clinical Care
1.1.0 - STU 2 ballot
This page is part of the SDOH Clinical Care for Multiple Domains (v1.1.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions 
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="SDOHCC-PatientApp"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>SDOHCC Patient Application</h2>
<p>(Requirements Definition Capability Statement)</p>
<p>Canonical URL: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-PatientApp Published: 2021-06 (draft)</p>
<p>This resource describes the required and desired behavior of systems acting as apps for patients and care-givers who need to monitor progress on SDOH referrals and may need to take actions such as filling out forms, booking appointments, etc.</p>
<h2>General</h2>
<div class="table-wrapper">
<table class="grid">
<tbody>
<tr>
<th>FHIR Version:</th>
<td>4.0.1</td>
</tr>
<tr>
<th>Supported formats:</th>
<td>xml, json</td>
</tr>
</tbody>
</table>
</div>
<h2>REST client behavior</h2>
<p>Patient apps query for data relevant to the current patient, post updates as appropriate and occasionally create new resources, such as QuestionnaireResponses</p>
<p>
<b>Security:</b>
</p>SMART-on-FHIR<br/>
<p>Implementations must meet the general privacy & security requirements documented in <a href="privacy_and_security.html">this implementation guide</a>.</p>
<h3>Resource summary</h3>
<div class="table-wrapper">
<table class="grid">
<thead>
<tr>
<th>Resource</th>
<th>Search</th>
<th>Read</th>
<th>Read Version</th>
<th>Instance History</th>
<th>Resource History</th>
<th>Create</th>
<th>Update</th>
<th>Delete</th>
<th>Operations</th>
</tr>
</thead>
<tbody>
<tr>
<th>CareTeam</th>
<td>
<a href="#CareTeam-search-type" title="Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.">MAY</a>
</td>
<td>
<a href="#CareTeam-read" title="Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.">MAY</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Condition</th>
<td>
<a href="#Condition-search-type" title="Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.">SHOULD</a>
</td>
<td>
<a href="#Condition-read" title="Allows the system to retrieve a Condition that is the requester or performer of a ServiceRequest.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Consent</th>
<td>
<a href="#Consent-search-type" title="Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.">SHOULD</a>
</td>
<td>
<a href="#Consent-read" title="Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Device</th>
<td>
<a href="#Device-search-type" title="Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.">SHOULD</a>
</td>
<td>
<a href="#Device-read" title="Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>DocumentReference</th>
<td>
<a href="#DocumentReference-search-type" title="Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.">SHOULD</a>
</td>
<td>
<a href="#DocumentReference-read" title="Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.">SHALL</a>
</td>
<td/>
<td/>
<td/>
<td>
<a href="#DocumentReference-create" title="Allows the app to record a new PDF (e.g. a completed form)">SHALL</a>
</td>
<td>
<a href="#DocumentReference-update" title="Allows the system to revise a previously stored PDF">SHOULD</a>
</td>
<td/>
<td/>
</tr>
<tr>
<th>Goal</th>
<td>
<a href="#Goal-search-type" title="Allows the monitoring of previously-retrieved Goals in the event they are updated.">SHOULD</a>
</td>
<td>
<a href="#Goal-read" title="Allows the system to retrieve a goal referenced by a ServiceRequest.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>HealthcareService</th>
<td>
<a href="#HealthcareService-search-type" title="Allows the monitoring of previously-retrieved HealthcareServices.">MAY</a>
</td>
<td>
<a href="#HealthcareService-read" title="Allows the system to retrieve a HealthcareService referenced by a Task.">SHALL</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Location</th>
<td>
<a href="#Location-search-type" title="Allows the monitoring of previously-retrieved Locations that are the intended locations for services.">MAY</a>
</td>
<td>
<a href="#Location-read" title="Allows the system to retrieve a Location that is an available location for a service.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Practitioner</th>
<td>
<a href="#Practitioner-search-type" title="Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.">SHOULD</a>
</td>
<td>
<a href="#Practitioner-read" title="Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>PractitionerRole</th>
<td>
<a href="#PractitionerRole-search-type" title="Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.">SHOULD</a>
</td>
<td>
<a href="#PractitionerRole-read" title="Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Questionnaire</th>
<td>
<a href="#Questionnaire-search-type" title="Allows the referral source to search for questionnaires relevant to a patient context.">SHALL</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>$populate: <a href="#Questionnaire-populate" title="Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere">MAY</a>
</td>
</tr>
<tr>
<th>QuestionnaireResponse</th>
<td>
<a href="#QuestionnaireResponse-search-type" title="Allows checking for updates in previously retrieved QuestionnaireResponses.">SHOULD</a>
</td>
<td>
<a href="#QuestionnaireResponse-read" title="Allows the retrieval of QuestionnaireResponses linked to a pointed to as supporting information by a ServiceRequest or as outputs of a Task.">SHALL</a>
</td>
<td/>
<td/>
<td/>
<td>
<a href="#QuestionnaireResponse-create" title="Allows the creation of QuestionnaireResponses in response to Tasks.">SHALL</a>
</td>
<td>
<a href="#QuestionnaireResponse-update" title="Allows the revision of 'in progress' QuestionnaireResponses.">SHOULD</a>
</td>
<td/>
<td/>
</tr>
<tr>
<th>RelatedPerson</th>
<td>
<a href="#RelatedPerson-search-type" title="Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.">MAY</a>
</td>
<td>
<a href="#RelatedPerson-read" title="Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.">MAY</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>ServiceRequest</th>
<td>
<a href="#ServiceRequest-search-type" title="Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.">SHOULD</a>
</td>
<td>
<a href="#ServiceRequest-read" title="Allows client systems to retrieve the ServiceRequest pointed to by a Task.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<th>Task</th>
<td>
<a href="#Task-search-type" title="Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.">SHALL</a>
</td>
<td>
<a href="#Task-read" title="Allows retrieval of a Task that was previously accessed.">MAY</a>
<br/>(conditional read:<br/>modified-since)</td>
<td/>
<td/>
<td/>
<td/>
<td>
<a href="#Task-update" title="Allows modification of an assigned patient existing Task (e.g. to cancel it) or modificiation of a Task assigned to the referral recipient (to accept or reject it or add output links to performed procedures).">SHALL</a>
</td>
<td/>
<td/>
</tr>
</tbody>
</table>
</div>
<h3>General interactions</h3>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Capability Statement</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="-batch"> </a>
<span>batch</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows polling for changes to multiple resource types simultaneously</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/careteam.html">CareTeam</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam">http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="CareTeam-read"> </a>
<span>read</span>
</th>
<td>MAY</td>
<td>
<p>Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="CareTeam-search-type"> </a>
<span>search-type</span>
</th>
<td>MAY</td>
<td>
<p>Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/condition.html">Condition</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Condition-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a Condition that is the requester or performer of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="Condition-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>category</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering to only SDOH-related conditions</p>
</td>
</tr>
<tr>
<th>clinical-status</th>
<td>SHOULD</td>
<td>token</td>
<td>
<p>Allows filtering to only active conditions</p>
</td>
</tr>
<tr>
<th>code</th>
<td>SHOULD</td>
<td>token</td>
<td>
<p>Allows filtering to only specific SDOH conditions or sets of conditions</p>
</td>
</tr>
<tr>
<th>patient</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific</p>
</td>
</tr>
<tr>
<th>verification-status</th>
<td>SHOULD</td>
<td>token</td>
<td>
<p>Allows filtering to exclude refuted or entered-in-error conditions</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/consent.html">Consent</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Consent-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="Consent-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: Consent:source-reference:DocumentReference</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>source-reference</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows including the document that contains the PDF or similar representation of a paper consent</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/device.html">Device</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/StructureDefinition/Device">http://hl7.org/fhir/StructureDefinition/Device</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Device-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="Device-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/documentreference.html">DocumentReference</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference">http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="DocumentReference-create"> </a>
<span>create</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the app to record a new PDF (e.g. a completed form)</p>
</td>
</tr>
<tr>
<th>
<a name="DocumentReference-update"> </a>
<span>update</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to revise a previously stored PDF</p>
</td>
</tr>
<tr>
<th>
<a name="DocumentReference-read"> </a>
<span>read</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.</p>
</td>
</tr>
<tr>
<th>
<a name="DocumentReference-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/goal.html">Goal</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Goal-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a goal referenced by a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="Goal-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved Goals in the event they are updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>achievement-status</th>
<td>SHOULD</td>
<td>token</td>
<td>
<p>Allows filtering to only include unmet goals</p>
</td>
</tr>
<tr>
<th>category</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering to only include SDOH-related goals</p>
</td>
</tr>
<tr>
<th>lifecycle-status</th>
<td>SHOULD</td>
<td>token</td>
<td>
<p>Allows filtering to only include active goals</p>
</td>
</tr>
<tr>
<th>patient</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific</p>
</td>
</tr>
<tr>
<th>target-date</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering based on when a particular goal is desired to be achieved</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/healthcareservice.html">HealthcareService</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="HealthcareService-read"> </a>
<span>read</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the system to retrieve a HealthcareService referenced by a Task.</p>
</td>
</tr>
<tr>
<th>
<a name="HealthcareService-search-type"> </a>
<span>search-type</span>
</th>
<td>MAY</td>
<td>
<p>Allows the monitoring of previously-retrieved HealthcareServices.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>location</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows retrieval of the phyical site(s) associated with a HealthService</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/location.html">Location</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Location-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a Location that is an available location for a service.</p>
</td>
</tr>
<tr>
<th>
<a name="Location-search-type"> </a>
<span>search-type</span>
</th>
<td>MAY</td>
<td>
<p>Allows the monitoring of previously-retrieved Locations that are the intended locations for services.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Practitioner-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="Practitioner-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/practitionerrole.html">PractitionerRole</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="PractitionerRole-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="PractitionerRole-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: PractitionerRole:organization PractitionerRole:practitioner</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>organization</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows doing an _include on Organization when retrieving the PractitionerRole</p>
</td>
</tr>
<tr>
<th>practitioner</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows doing an _include on Practitioner when retrieving the PractitionerRole</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extract">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extract</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Questionnaire-search-type"> </a>
<span>search-type</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the referral source to search for questionnaires relevant to a patient context.</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-populate"> </a>
<span>$populate</span>
</th>
<td>MAY</td>
<td>
<p>Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>url</th>
<td>SHALL</td>
<td>uri</td>
<td>
<p>Allows retrieving Questionnaires based on its canonical URL</p>
</td>
</tr>
<tr>
<th>version</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving a specific version of a Questionnaire</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="QuestionnaireResponse-create"> </a>
<span>create</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the creation of QuestionnaireResponses in response to Tasks.</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-update"> </a>
<span>update</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows the revision of 'in progress' QuestionnaireResponses.</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-read"> </a>
<span>read</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the retrieval of QuestionnaireResponses linked to a pointed to as supporting information by a ServiceRequest or as outputs of a Task.</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows checking for updates in previously retrieved QuestionnaireResponses.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>author</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows filtering QuestionnaireResponses previously created/edited by a particular individual</p>
</td>
</tr>
<tr>
<th>authored</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for QuestionnaireResponses by when they were created/last edited</p>
</td>
</tr>
<tr>
<th>patient</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific</p>
</td>
</tr>
<tr>
<th>questionnaire</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows retrieving QuestionnaireResponses that have been completed against a specified form</p>
</td>
</tr>
<tr>
<th>status</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving QuestionnaireResponses that are complete (or incomplete)</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/relatedperson.html">RelatedPerson</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/StructureDefinition/RelatedPerson">http://hl7.org/fhir/StructureDefinition/RelatedPerson</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="RelatedPerson-read"> </a>
<span>read</span>
</th>
<td>MAY</td>
<td>
<p>Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.</p>
</td>
</tr>
<tr>
<th>
<a name="RelatedPerson-search-type"> </a>
<span>search-type</span>
</th>
<td>MAY</td>
<td>
<p>Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/servicerequest.html">ServiceRequest</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="ServiceRequest-read"> </a>
<span>read</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows client systems to retrieve the ServiceRequest pointed to by a Task.</p>
</td>
</tr>
<tr>
<th>
<a name="ServiceRequest-search-type"> </a>
<span>search-type</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: HealthCareService:location ServiceRequest:supporting-info ServiceRequest:pertains-to-goal ServiceRequest:patient ServiceRequest:requester ServiceRequest:performer PractitionerRole:practitioner PractitionerRole:organization</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>category</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering to only retrieve ServiceRequests that are SDOH-related</p>
</td>
</tr>
<tr>
<th>code</th>
<td>SHOULD</td>
<td>token</td>
<td>
<p>Allows filtering to retrieve ServiceRequests for specific types of services</p>
</td>
</tr>
<tr>
<th>intent</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.</p>
</td>
</tr>
<tr>
<th>occurrence</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided</p>
</td>
</tr>
<tr>
<th>patient</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific</p>
</td>
</tr>
<tr>
<th>performer</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows filtering to retrieve only ServiceRequests that designate a specific performer</p>
</td>
</tr>
<tr>
<th>requester</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows filtering to retrieve only ServiceRequests created by a specific practitioner</p>
</td>
</tr>
<tr>
<th>status</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering to retrieve only active ServiceRequests</p>
</td>
</tr>
<tr>
<th>supporting-info</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/task.html">Task</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient</a>
</li>
<li>
<a href="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Versioning support: versioned-update</p>
<p>Reference policy: literal</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Task-update"> </a>
<span>update</span>
</th>
<td>SHALL</td>
<td>
<p>Allows modification of an assigned patient existing Task (e.g. to cancel it) or modificiation of a Task assigned to the referral recipient (to accept or reject it or add output links to performed procedures).</p>
</td>
</tr>
<tr>
<th>
<a name="Task-read"> </a>
<span>read</span>
</th>
<td>MAY</td>
<td>
<p>Allows retrieval of a Task that was previously accessed.</p>
</td>
</tr>
<tr>
<th>
<a name="Task-search-type"> </a>
<span>search-type</span>
</th>
<td>SHALL</td>
<td>
<p>Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: Task:output</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Conformance</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>_id</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates</p>
</td>
</tr>
<tr>
<th>_lastUpdated</th>
<td>SHOULD</td>
<td>date</td>
<td>
<p>Allows filtering for only records that have changed since last query</p>
</td>
</tr>
<tr>
<th>code</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables.</p>
</td>
</tr>
<tr>
<th>owner</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)</p>
</td>
</tr>
<tr>
<th>patient</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.)</p>
</td>
</tr>
<tr>
<th>requester</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system</p>
</td>
</tr>
<tr>
<th>status</th>
<td>SHALL</td>
<td>token</td>
<td>
<p>Allows filtering to only active or completed tasks</p>
</td>
</tr>
<tr>
<th>focus</th>
<td>SHALL</td>
<td>reference</td>
<td>
<p>Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest</p>
</td>
</tr>
<tr>
<th>output</th>
<td>SHOULD</td>
<td>reference</td>
<td>
<p>Allows for the 'output' of a Task to be included when retrieving a Task</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</text>
<url
value="http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-PatientApp"/>
<version value="1.1.0"/>
<name value="SDOHCC_PatientApp"/>
<title value="SDOHCC Patient Application"/>
<status value="draft"/>
<date value="2021-06"/>
<publisher value="HL7 International - Patient Care WG"/>
<contact>
<name value="HL7 International - Patient Care"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/patientcare"/>
</telecom>
</contact>
<description
value="This resource describes the required and desired behavior of systems acting as apps for patients and care-givers who need to monitor progress on SDOH referrals and may need to take actions such as filling out forms, booking appointments, etc."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
<text value="United States of America"/>
</jurisdiction>
<purpose
value="These systems will not expose their own FHIR interfaces, but will monitor information available from other FHIR servers - be it [[CapabilityStatement-SDOHCC-ReferralSource.html|referral sources]], [[CapabilityStatement-SDOHCC-CoordinationPlatform.html|coordination platforms]] or [[CapabilityStatement-SDOHCC-ReferralRecipient.html|referral recipients]]. They will primarily monitor and update Task resources as well as the resources referenced by those Tasks."/>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<rest>
<mode value="client"/>
<documentation
value="Patient apps query for data relevant to the current patient, post updates as appropriate and occasionally create new resources, such as QuestionnaireResponses"/>
<security>
<service>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
<code value="SMART-on-FHIR"/>
</coding>
</service>
<description
value="Implementations must meet the general privacy & security requirements documented in [[privacy_and_security.html|this implementation guide]]."/>
</security>
<resource>
<type value="CareTeam"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"/>
<documentation
value="For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific team of people. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
</resource>
<resource>
<type value="Condition"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition"/>
<documentation
value="For referral sources that receive referrals from upstream systems, used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a Condition that is the requester or performer of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-category"/>
<type value="token"/>
<documentation value="Allows filtering to only SDOH-related conditions"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="clinical-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-clinical-status"/>
<type value="token"/>
<documentation value="Allows filtering to only active conditions"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="code"/>
<definition value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation
value="Allows filtering to only specific SDOH conditions or sets of conditions"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="verification-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-verification-status"/>
<type value="token"/>
<documentation
value="Allows filtering to exclude refuted or entered-in-error conditions"/>
</searchParam>
</resource>
<resource>
<type value="Consent"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent"/>
<documentation
value="Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest."/>
</interaction>
<referencePolicy value="literal"/>
<searchInclude value="Consent:source-reference:DocumentReference">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="source-reference"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Consent-source-reference"/>
<type value="reference"/>
<documentation
value="Allows including the document that contains the PDF or similar representation of a paper consent"/>
</searchParam>
</resource>
<resource>
<type value="Device"/>
<supportedProfile value="http://hl7.org/fhir/StructureDefinition/Device"/>
<documentation
value="Used to retrieve the requester or intended performer of an SDOH ServiceRequest. Note: Conformance expectations for this resource are lower because Device requesters and performers are expected to be uncommon in most SDOH uses"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
</resource>
<resource>
<type value="DocumentReference"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"/>
<documentation
value="Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Allows the app to record a new PDF (e.g. a completed form)"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="update"/>
<documentation
value="Allows the system to revise a previously stored PDF"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a PDF or similar content referenced by a Consent or Task."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
</resource>
<resource>
<type value="Goal"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal"/>
<documentation value="Used to access goals related to an SDOH referral"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a goal referenced by a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved Goals in the event they are updated."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="achievement-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Goal-achievement-status"/>
<type value="token"/>
<documentation value="Allows filtering to only include unmet goals"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="category"/>
<definition value="http://hl7.org/fhir/SearchParameter/Goal-category"/>
<type value="token"/>
<documentation
value="Allows filtering to only include SDOH-related goals"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="lifecycle-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status"/>
<type value="token"/>
<documentation value="Allows filtering to only include active goals"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="target-date"/>
<definition value="http://hl7.org/fhir/SearchParameter/Goal-target-date"/>
<type value="date"/>
<documentation
value="Allows filtering based on when a particular goal is desired to be achieved"/>
</searchParam>
</resource>
<resource>
<type value="HealthcareService"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService"/>
<documentation
value="Allows patient apps to retrieve information about who should be contacted (to book an appointment or for other reasons)"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a HealthcareService referenced by a Task."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved HealthcareServices."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="location"/>
<definition
value="http://hl7.org/fhir/SearchParameter/HealthcareService-location"/>
<type value="reference"/>
<documentation
value="Allows retrieval of the phyical site(s) associated with a HealthService"/>
</searchParam>
</resource>
<resource>
<type value="Location"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location"/>
<documentation
value="Used to access information about the potential sites at which a requested service might be performed. Allows a patient to evaluate the suitability of a proposed activity or service."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a Location that is an available location for a service."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved Locations that are the intended locations for services."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
</resource>
<resource>
<type value="Practitioner"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/>
<documentation
value="Used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
</resource>
<resource>
<type value="PractitionerRole"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"/>
<documentation
value="Used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests."/>
</interaction>
<referencePolicy value="literal"/>
<searchInclude value="PractitionerRole:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:practitioner">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="organization"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-organization"/>
<type value="reference"/>
<documentation
value="Allows doing an _include on Organization when retrieving the PractitionerRole"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="practitioner"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner"/>
<type value="reference"/>
<documentation
value="Allows doing an _include on Practitioner when retrieving the PractitionerRole"/>
</searchParam>
</resource>
<resource>
<type value="Questionnaire"/>
<supportedProfile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extract"/>
<documentation
value="Used to retrieve SDOH-related Questionnaires to be filled out by a patient or representative. Also allows retrieving Questionnaires associated with existing QuestionnaireResponses for editing by SMART-on-FHIR apps."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the referral source to search for questionnaires relevant to a patient context."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-url"/>
<type value="uri"/>
<documentation
value="Allows retrieving Questionnaires based on its canonical URL"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-version"/>
<type value="token"/>
<documentation
value="Allows retrieving a specific version of a Questionnaire"/>
</searchParam>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="populate"/>
<definition
value="http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate"/>
<documentation
value="Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere"/>
</operation>
</resource>
<resource>
<type value="QuestionnaireResponse"/>
<supportedProfile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse"/>
<documentation
value="Used to allow QuestionnaireResponses to be created and updated by a patient or caregiver and work-in-progress responses to be retrieved"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Allows the creation of QuestionnaireResponses in response to Tasks."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="update"/>
<documentation
value="Allows the revision of 'in progress' QuestionnaireResponses."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows the retrieval of QuestionnaireResponses linked to a pointed to as supporting information by a ServiceRequest or as outputs of a Task."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows checking for updates in previously retrieved QuestionnaireResponses."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="author"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-author"/>
<type value="reference"/>
<documentation
value="Allows filtering QuestionnaireResponses previously created/edited by a particular individual"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="authored"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored"/>
<type value="date"/>
<documentation
value="Allows filtering for QuestionnaireResponses by when they were created/last edited"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient"/>
<type value="reference"/>
<documentation
value="Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="questionnaire"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire"/>
<type value="reference"/>
<documentation
value="Allows retrieving QuestionnaireResponses that have been completed against a specified form"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status"/>
<type value="token"/>
<documentation
value="Allows retrieving QuestionnaireResponses that are complete (or incomplete)"/>
</searchParam>
</resource>
<resource>
<type value="RelatedPerson"/>
<supportedProfile
value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
<documentation
value="Used to access information about the requester or intended performer of a ServiceRequest or Task when they are someone with a personal relationship to the Patient. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests."/>
</interaction>
<referencePolicy value="literal"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
</resource>
<resource>
<type value="ServiceRequest"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest"/>
<documentation
value="For referral sources that receive referrals from upstream systems, used to retrieve an order for SDOH-related services"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Allows client systems to retrieve the ServiceRequest pointed to by a Task."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling."/>
</interaction>
<referencePolicy value="literal"/>
<searchInclude value="HealthCareService:location">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchInclude value="ServiceRequest:supporting-info">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="ServiceRequest:pertains-to-goal">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="ServiceRequest:patient">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="ServiceRequest:requester">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="ServiceRequest:performer">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:practitioner">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ServiceRequest-category"/>
<type value="token"/>
<documentation
value="Allows filtering to only retrieve ServiceRequests that are SDOH-related"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="code"/>
<definition value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation
value="Allows filtering to retrieve ServiceRequests for specific types of services"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="intent"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ServiceRequest-intent"/>
<type value="token"/>
<documentation
value="Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="occurrence"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence"/>
<type value="date"/>
<documentation
value="Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="performer"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ServiceRequest-performer"/>
<type value="reference"/>
<documentation
value="Allows filtering to retrieve only ServiceRequests that designate a specific performer"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="requester"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ServiceRequest-requester"/>
<type value="reference"/>
<documentation
value="Allows filtering to retrieve only ServiceRequests created by a specific practitioner"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ServiceRequest-status"/>
<type value="token"/>
<documentation
value="Allows filtering to retrieve only active ServiceRequests"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="supporting-info"/>
<definition
value="http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/ServiceRequest-supporting-info"/>
<type value="reference"/>
<documentation
value="Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent"/>
</searchParam>
</resource>
<resource>
<type value="Task"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient"/>
<supportedProfile
value="http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement"/>
<documentation
value="Allows the patient or caregiver to monitor and update for Task assigned by referral sources or coordination platforms. Also allows the update and monitoring of tasks assigned to patients and caregivers."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="update"/>
<documentation
value="Allows modification of an assigned patient existing Task (e.g. to cancel it) or modificiation of a Task assigned to the referral recipient (to accept or reject it or add output links to performed procedures)."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Allows retrieval of a Task that was previously accessed."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query."/>
</interaction>
<versioning value="versioned-update"/>
<conditionalRead value="modified-since"/>
<referencePolicy value="literal"/>
<searchInclude value="Task:output"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="code"/>
<definition value="http://hl7.org/fhir/SearchParameter/Task-code"/>
<type value="token"/>
<documentation
value="Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="owner"/>
<definition value="http://hl7.org/fhir/SearchParameter/Task-owner"/>
<type value="reference"/>
<documentation
value="Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition value="http://hl7.org/fhir/SearchParameter/Task-patient"/>
<type value="reference"/>
<documentation
value="Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.)"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="requester"/>
<definition value="http://hl7.org/fhir/SearchParameter/Task-requester"/>
<type value="reference"/>
<documentation
value="Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition value="http://hl7.org/fhir/SearchParameter/Task-status"/>
<type value="token"/>
<documentation
value="Allows filtering to only active or completed tasks"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="focus"/>
<definition value="http://hl7.org/fhir/SearchParameter/Task-focus"/>
<type value="reference"/>
<documentation
value="Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="output"/>
<definition
value="http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference"/>
<type value="reference"/>
<documentation
value="Allows for the 'output' of a Task to be included when retrieving a Task"/>
</searchParam>
</resource>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="batch"/>
<documentation
value="Allows polling for changes to multiple resource types simultaneously"/>
</interaction>
</rest>
</CapabilityStatement>
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.sdoh-clinicalcare#1.1.0 based on FHIR 4.0.1. Generated 2021-12-07
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change