This page is part of the SDOH Clinical Care for Multiple Domains (v2.1.0: STU 2.1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Draft as of 2021-06 |
{
"resourceType" : "CapabilityStatement",
"id" : "SDOHCC-ReferralRecipientLight",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">SDOHCC Referral Recipient - Light</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipientLight</code></li><li><b>Implementation Guide Version:</b> None</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats: </b>XML, JSON</li><li><b>Published:</b> 2021-06</li><li><b>Published by:</b> None</li><li><b>Status:</b> Draft</li></ul><p>This resource describes the required and desired behavior of systems acting as 'light-weight' SDOH clinical care 'referral recipients'.</p><p>These systems fit into the SDOH care workflow in the same manner as <a href=\"CapabilityStatement-SDOHCC-ReferralRecipient.html\">'regular' Referral Recipients</a>, however they have simpler interface requirements reflecting the inability of the systems to store data locally and/or expose a FHIR service allowing access to that data. 'Light' referral recipients are not expected to expose any FHIR restful services. Instead, they act as clients, querying for tasks on the initiating <a href=\"CapabilityStatement-SDOHCC-ReferralSource.html\">Referral Sources</a> or <a href=\"CapabilityStatement-SDOHCC-CoordinationPlatform.html\">Coordination Platforms</a> and creating any resulting Procedure records within the server they received the request from.</p> <!-- REST Behavior --><h3 id=\"behavior\">FHIR Client RESTful Capabilities</h3><p>The light clinical care referral recipient needs to access information from and update information in SDOH clinical care <a href=\"CapabilityStatement-SDOHCC-ReferralSource.html\">referral sources</a> and/or <a href=\"CapabilityStatement-SDOHCC-CoordinationPlatform.html\">coordination platforms</a> that have solicited the filling of SDOH-related referrals by this system</p><p id=\"security\"><strong>Security:</strong></p><p>Implementations must meet the general privacy & security requirements documented in <a href=\"privacy_and_security.html\">this implementation guide</a>.</p><p><strong>Summary of Client Wide Interactions</strong></p><ul><li><strong>SHOULD</strong> support the <code>batch</code><sup>†</sup> interaction.</li></ul><blockquote>batch<sup>†</sup><p>Allows polling for changes to multiple resource types simultaneously</p></blockquote><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p><p><i>♦ = <b>SHALL</b> expectation</i>;<i>⋄ = <b>SHOULD</b> expectation</i>;<i>▿ = <b>MAY</b> expectation</i>;</p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Interactions</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#careteam\"><span style=\"white-space: nowrap;\">CareTeam</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"MAY\"><sup>▿</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam\">US Core CareTeam Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#condition\"><span style=\"white-space: nowrap;\">Condition</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition\">SDOHCC Condition</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">category<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">clinical-status<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">code<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">verification-status<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#consent\"><span style=\"white-space: nowrap;\">Consent</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent\">SDOHCC Consent</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">source-reference<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td>Consent:source-reference:DocumentReference<span title=\"SHOULD\"><sup>⋄</sup></span></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#device\"><span style=\"white-space: nowrap;\">Device</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/StructureDefinition/Device\">FHIR Device</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#documentreference\"><span style=\"white-space: nowrap;\">DocumentReference</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">US Core DocumentReference Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#goal\"><span style=\"white-space: nowrap;\">Goal</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal\">SDOHCC Goal</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">achievement-status<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">category<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">lifecycle-status<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">target-date<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#healthcareservice\"><span style=\"white-space: nowrap;\">HealthcareService</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService\">SDOHCC Healthcare Service</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">location<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#location\"><span style=\"white-space: nowrap;\">Location</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"MAY\"><sup>▿</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location\">SDOHCC Location</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#observation\"><span style=\"white-space: nowrap;\">Observation</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment\">SDOHCC Observation Assessment</a><span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse\">SDOHCC Observation Screening Response</a><span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB\">SDOHCC Observation Ethnicity OMB</a><span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB\">SDOHCC Observation Race OMB</a><span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity\">SDOHCC Observation Gender Identity</a><span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic\">SDOHCC Observation Personal Characteristic</a><span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns\">SDOHCC Observation Personal Pronouns</a><span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender\">SDOHCC Observation Recorded Sex Gender</a><span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation\">SDOHCC Observation Sexual Orientation</a><span title=\"MAY\"><sup>▿</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">category<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">code<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">code-value-concept<span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\">date<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">derived-from<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">status<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#organization\"><span style=\"white-space: nowrap;\">Organization</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization\">US Core Organization Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#patient\"><span style=\"white-space: nowrap;\">Patient</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient\">US Core Patient Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#practitioner\"><span style=\"white-space: nowrap;\">Practitioner</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner\">US Core Practitioner Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#practitionerrole\"><span style=\"white-space: nowrap;\">PractitionerRole</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole\">US Core PractitionerRole Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">organization<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">practitioner<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td>PractitionerRole:organization<span title=\"SHOULD\"><sup>⋄</sup></span>, PractitionerRole:practitioner<span title=\"SHOULD\"><sup>⋄</sup></span></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#procedure\"><span style=\"white-space: nowrap;\">Procedure</span></a></td><td><span style=\"white-space: nowrap;\">create<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">update<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure\">SDOHCC Procedure</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">based-on<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">category<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">code<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">date<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">performer<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">status<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#relatedperson\"><span style=\"white-space: nowrap;\">RelatedPerson</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"MAY\"><sup>▿</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"MAY\"><sup>▿</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/StructureDefinition/RelatedPerson\">FHIR RelatedPerson</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#servicerequest\"><span style=\"white-space: nowrap;\">ServiceRequest</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest\">SDOHCC ServiceRequest</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">category<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">code<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">intent<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">occurrence<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">performer<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">requester<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">status<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">supporting-info<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td>HealthCareService:location<span title=\"SHALL\"><sup>♦</sup></span>, ServiceRequest:supporting-info<span title=\"SHOULD\"><sup>⋄</sup></span>, ServiceRequest:pertains-to-goal<span title=\"SHOULD\"><sup>⋄</sup></span>, ServiceRequest:patient<span title=\"SHOULD\"><sup>⋄</sup></span>, ServiceRequest:requester<span title=\"SHOULD\"><sup>⋄</sup></span>, ServiceRequest:performer<span title=\"SHOULD\"><sup>⋄</sup></span>, PractitionerRole:practitioner<span title=\"SHOULD\"><sup>⋄</sup></span>, PractitionerRole:organization<span title=\"SHOULD\"><sup>⋄</sup></span></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#subscription\"><span style=\"white-space: nowrap;\">Subscription</span></a></td><td><span style=\"white-space: nowrap;\">create<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">update<span title=\"MAY\"><sup>▿</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\">R4/B Topic-Based Subscription</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td><span style=\"white-space: nowrap;\">$status<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">$topic-list<span title=\"MAY\"><sup>▿</sup></span></span></td></tr><tr><td><a href=\"#task\"><span style=\"white-space: nowrap;\">Task</span></a></td><td><span style=\"white-space: nowrap;\">create<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">update<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">search-type<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient\">SDOHCC Task For Patient</a><span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement\">SDOHCC Task For Referral Management</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">_lastUpdated<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">code<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">owner<span title=\"SHOULD\"><sup>⋄</sup></span>, </span><span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">requester<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">status<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">focus<span title=\"SHALL\"><sup>♦</sup></span>, </span><span style=\"white-space: nowrap;\">output<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported _includes --><td>Task:output</td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr></tbody></table> <!-- Resource Details --><h4 id=\"careteam\" class=\"no_toc\">CareTeam</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>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</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam\">US Core CareTeam Profile</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support <code>read</code><sup>†</sup>, <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>MAY</strong> be capable of fetching a CareTeam resource using:<code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]</code></li><li>A Client <strong>MAY</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/CareTeam?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/CareTeam?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"condition\" class=\"no_toc\">Condition</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>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</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition\">SDOHCC Condition</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a Condition that is the reason for a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Condition resource using:<code class=\"highlighter-rouge\">GET [base]/Condition/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?clinical-status=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">verification-status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?verification-status=[system]|[code]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a> (token):<p>Allows filtering to only SDOH-related conditions</p></li><li><a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a> (token):<p>Allows filtering to only active conditions</p></li><li><a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a> (token):<p>Allows filtering to only specific SDOH conditions or sets of conditions</p></li><li><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a> (reference):<p>Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific</p></li><li><a href=\"http://hl7.org/fhir/R4/condition.html#search\">verification-status</a> (token):<p>Allows filtering to exclude refuted or entered-in-error conditions</p></li></ul></div><h4 id=\"consent\" class=\"no_toc\">Consent</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent\">SDOHCC Consent</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Consent resource using:<code class=\"highlighter-rouge\">GET [base]/Consent/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Consent/[id]{?[parameters]{&_format=[mime-type]}}</code></li><li>A Client <strong>SHOULD</strong> be capable of supporting the following _includes:<ul><li>Consent:source-reference:DocumentReference - <code class=\"highlighter-rouge\">GET [base]/Consent?[parameter=value]&_include=Consent:source-reference:DocumentReference</code></li></ul></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Consent?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Consent?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/consent.html#search\">source-reference</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Consent?source-reference=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/consent.html#search\">source-reference</a> (reference):<p>Allows including the document that contains the PDF or similar representation of a paper consent</p></li></ul></div><h4 id=\"device\" class=\"no_toc\">Device</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>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</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/StructureDefinition/Device\">(http://hl7.org/fhir/StructureDefinition/Device)</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code><sup>†</sup>, <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHOULD</strong> be capable of fetching a Device resource using:<code class=\"highlighter-rouge\">GET [base]/Device/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Device/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Device?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Device?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"documentreference\" class=\"no_toc\">DocumentReference</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">US Core DocumentReference Profile</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a DocumentReference resource using:<code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"goal\" class=\"no_toc\">Goal</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>Used to access goals related to an SDOH referral</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal\">SDOHCC Goal</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a goal referenced by a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Goals in the event they are updated.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Goal resource using:<code class=\"highlighter-rouge\">GET [base]/Goal/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Goal/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">achievement-status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?achievement-status=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">lifecycle-status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?lifecycle-status=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?patient=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">target-date</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Goal?target-date=[target-date]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/goal.html#search\">achievement-status</a> (token):<p>Allows filtering to only include unmet goals</p></li><li><a href=\"http://hl7.org/fhir/R4/goal.html#search\">category</a> (token):<p>Allows filtering to only include SDOH-related goals</p></li><li><a href=\"http://hl7.org/fhir/R4/goal.html#search\">lifecycle-status</a> (token):<p>Allows filtering to only include active goals</p></li><li><a href=\"http://hl7.org/fhir/R4/goal.html#search\">patient</a> (reference):<p>Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific</p></li><li><a href=\"http://hl7.org/fhir/R4/goal.html#search\">target-date</a> (date):<p>Allows filtering based on when a particular goal is desired to be achieved</p></li></ul></div><h4 id=\"healthcareservice\" class=\"no_toc\">HealthcareService</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>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 service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service.</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService\">SDOHCC Healthcare Service</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code><sup>†</sup>, <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHOULD</strong> be capable of fetching a HealthcareService resource using:<code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/healthcareservice.html#search\">location</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?location=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/healthcareservice.html#search\">location</a> (reference):<p>Allows retrieval of the phyical site(s) associated with a HealthService</p></li></ul></div><h4 id=\"location\" class=\"no_toc\">Location</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>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.</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location\">SDOHCC Location</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code><sup>†</sup>.</li><li><strong>MAY</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a Location that is an available location for a service.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Locations that are the intended locations for services.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHOULD</strong> be capable of fetching a Location resource using:<code class=\"highlighter-rouge\">GET [base]/Location/[id]</code></li><li>A Client <strong>MAY</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Location?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Location?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"observation\" class=\"no_toc\">Observation</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral as well as certain SDOH-relevant demographic information</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment\">SDOHCC Observation Assessment</a>,</li><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse\">SDOHCC Observation Screening Response</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB\">SDOHCC Observation Ethnicity OMB</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB\">SDOHCC Observation Race OMB</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity\">SDOHCC Observation Gender Identity</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic\">SDOHCC Observation Personal Characteristic</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns\">SDOHCC Observation Personal Pronouns</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender\">SDOHCC Observation Recorded Sex Gender</a>,</li><li><strong>MAY</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation\">SDOHCC Observation Sexual Orientation</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve an Observation referenced by a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Observations for updates/corrections.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching an Observation resource using:<code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?code=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?date=[date]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">derived-from</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?derived-from=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Observation?status=[system]|[code]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a> (token):<p>Allows filtering for only SDOH-related observations</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a> (token):<p>Allows filtering for specific types of observations</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code-value-concept</a> (composite):<p>Allows filtering for observations that have a specific coded value answer for a specified observation type</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a> (date):<p>Allows filtering for observations that held in a particular time period</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">derived-from</a> (reference):<p>Allows filtering for observations derived from a particular QuestionnaireResponse</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a> (reference):<p>Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific</p></li><li><a href=\"http://hl7.org/fhir/R4/observation.html#search\">status</a> (token):<p>Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)</p></li></ul></div><h4 id=\"organization\" class=\"no_toc\">Organization</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to access information about an Organization that is the requester or intended performer of a ServiceRequest</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization\">US Core Organization Profile</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching an Organization resource using:<code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"patient\" class=\"no_toc\">Patient</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to access information about the Patient that is the subject a ServiceRequest</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient\">US Core Patient Profile</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve the Patient that is the subject of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Patients.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Patient resource using:<code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"practitioner\" class=\"no_toc\">Practitioner</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner\">US Core Practitioner Profile</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Practitioner resource using:<code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"practitionerrole\" class=\"no_toc\">PractitionerRole</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole\">US Core PractitionerRole Profile</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a PractitionerRole resource using:<code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}</code></li><li>A Client <strong>SHOULD</strong> be capable of supporting the following _includes:<ul><li>PractitionerRole:organization - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:organization</code></li><li>PractitionerRole:practitioner - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner</code></li></ul></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">organization</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?organization=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">practitioner</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?practitioner=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">organization</a> (reference):<p>Allows doing an _include on Organization when retrieving the PractitionerRole</p></li><li><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">practitioner</a> (reference):<p>Allows doing an _include on Practitioner when retrieving the PractitionerRole</p></li></ul></div><h4 id=\"procedure\" class=\"no_toc\">Procedure</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>Used to record information about actions that have been performed as a result of a referral</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure\">SDOHCC Procedure</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Versioning Policy: <code>versioned-update</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>create</code><sup>†</sup>, <code>update</code><sup>†</sup>, <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>create<sup>†</sup></p><p>Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.</p></blockquote><blockquote><p>update<sup>†</sup></p><p>Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.</p></blockquote><blockquote><p>read<sup>†</sup></p><p>Allows the referral recipient to retrieve procedures referenced by Tasks previously posted.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the referral recipient to check if others have updated (e.g. added comments) to procedures previously posted and/or to find previously submitted procedures so they can be rendered to a user.</p></blockquote>ns.n<p>Modify Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of posting a Procedure resource using:<code class=\"highlighter-rouge\">POST [base]/Procedure/[id]{?_format=[mime-type]}</code></li><li>A Client <strong>SHALL</strong> be capable of putting an existing Procedure resource using:<code class=\"highlighter-rouge\">PUT [base]/Procedure/[id]{?_format=[mime-type]}</code></li></ul><p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Procedure resource using:<code class=\"highlighter-rouge\">GET [base]/Procedure/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">based-on</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?based-on=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?code=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">date</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?date=[date]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?patient=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">performer</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?performer=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?status=[system]|[code]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">based-on</a> (reference):<p>Allows filtering for procedures resulting from a particular service request</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">category</a> (token):<p>Allows filtering for procedures that are SDOH-related</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">code</a> (token):<p>Allows filtering for procedures based on the specific service delivered</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">date</a> (date):<p>Allows filtering for procedures based on when they were delivered</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">patient</a> (reference):<p>Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">performer</a> (reference):<p>Allows filtering for procedures based on who delivered the procedure.</p></li><li><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">status</a> (token):<p>Allows filtering for procedures that are complete or in progress</p></li></ul></div><h4 id=\"relatedperson\" class=\"no_toc\">RelatedPerson</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to access information about the requester or intended performer of a ServiceRequest 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</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/StructureDefinition/RelatedPerson\">(http://hl7.org/fhir/StructureDefinition/RelatedPerson)</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support <code>read</code><sup>†</sup>, <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>MAY</strong> be capable of fetching a RelatedPerson resource using:<code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]</code></li><li>A Client <strong>MAY</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/RelatedPerson?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/RelatedPerson?_lastUpdated=[dateTime]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li></ul></div><h4 id=\"servicerequest\" class=\"no_toc\">ServiceRequest</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>For referral sources that receive referrals from upstream systems, used to retrieve an order for SDOH-related services</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest\">SDOHCC ServiceRequest</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>read<sup>†</sup></p><p>Allows client systems to retrieve the ServiceRequest pointed to by a Task.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.</p></blockquote>ns.n<p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a ServiceRequest resource using:<code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code></li><li>A Client <strong>SHOULD</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}</code></li><li>A Client <strong>SHALL</strong> be capable of supporting the following _includes:<ul><li>HealthCareService:location - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=HealthCareService:location</code></li><li>ServiceRequest:supporting-info - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:supporting-info</code></li><li>ServiceRequest:pertains-to-goal - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:pertains-to-goal</code></li><li>ServiceRequest:patient - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:patient</code></li><li>ServiceRequest:requester - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:requester</code></li><li>ServiceRequest:performer - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:performer</code></li><li>PractitionerRole:practitioner - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=PractitionerRole:practitioner</code></li><li>PractitionerRole:organization - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_include=PractitionerRole:organization</code></li></ul></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">intent</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?intent=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">occurrence</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?occurrence=[occurrence]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">performer</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?performer=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">requester</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?requester=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?status=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">supporting-info</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?supporting-info=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">category</a> (token):<p>Allows filtering to only retrieve ServiceRequests that are SDOH-related</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">code</a> (token):<p>Allows filtering to retrieve ServiceRequests for specific types of services</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">intent</a> (token):<p>Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">occurrence</a> (date):<p>Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">patient</a> (reference):<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></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">performer</a> (reference):<p>Allows filtering to retrieve only ServiceRequests that designate a specific performer</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">requester</a> (reference):<p>Allows filtering to retrieve only ServiceRequests created by a specific practitioner</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">status</a> (token):<p>Allows filtering to retrieve only active ServiceRequests</p></li><li><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">supporting-info</a> (reference):<p>Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent</p></li></ul></div><h4 id=\"subscription\" class=\"no_toc\">Subscription</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>Used to allow upstream systems to subscribe to and monitor Tasks stored on this system for change</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\">R4/B Topic-Based Subscription</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>create</code><sup>†</sup>.</li><li><strong>MAY</strong> support <code>update</code><sup>†</sup>.</li></ul><blockquote><p>create<sup>†</sup></p><p>Necessary if using subscriptions to monitor updates to the Task</p></blockquote><blockquote><p>update<sup>†</sup></p><p>Needed to allow the requester to update a subscription - to adjust delivery target, to add additional tasks to monitor (if subscribing by id) typically to cancel a request for fulfillment</p></blockquote><p>Operation Summary:</p><ul><li><strong>SHOULD</strong> support <code>$status</code><sup>†</sup>.</li><li><strong>MAY</strong> support <code>$topic-list</code><sup>†</sup>.</li></ul><blockquote><p>$status<sup>†</sup></p><p>Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors</p></blockquote><blockquote><p>$topic-list<sup>†</sup></p><p>Allows discovery of what subscription topics the systems supports - needed for systems that aren't pre-configured to be aware of what topics are available for use.</p></blockquote>ns.n<p>Modify Criteria:</p><ul><li>A Client <strong>SHOULD</strong> be capable of posting a Subscription resource using:<code class=\"highlighter-rouge\">POST [base]/Subscription/[id]{?_format=[mime-type]}</code></li><li>A Client <strong>MAY</strong> be capable of putting an existing Subscription resource using:<code class=\"highlighter-rouge\">PUT [base]/Subscription/[id]{?_format=[mime-type]}</code></li></ul><h4 id=\"task\" class=\"no_toc\">Task</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Resource Specific Documentation:</p><blockquote><p>Allows the referral recipient to create and monitor for Tasks assigned by referral sources or coordination platforms. Also allows the creation and monitoring of tasks assigned to patients and caregivers.</p></blockquote><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient\">SDOHCC Task For Patient</a>,</li><li><strong>SHALL</strong> support:<a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement\">SDOHCC Task For Referral Management</a></li></ul><p>Reference Policy: <code>literal</code></p><p>Versioning Policy: <code>versioned-update</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>update</code><sup>†</sup>, <code>read</code><sup>†</sup>, <code>search-type</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>create</code><sup>†</sup>.</li></ul><blockquote><p>create<sup>†</sup></p><p>Allows referral recipients to request actions of patients and caregivers</p></blockquote><blockquote><p>update<sup>†</sup></p><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). ReferralRecipients can freely modify any Tasks they have created (though they should consider the impact of doing so on downstream recipients or the patient). However, if they are not the creator, they SHALL only modify tasks they are the 'owner' of and then, only modify Task.status, Task.statusReason, and Task.outputs are possible, and then only for Tasks where the owner is the patient.</p></blockquote><blockquote><p>read<sup>†</sup></p><p>Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.</p></blockquote><blockquote><p>search-type<sup>†</sup></p><p>Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.</p></blockquote>ns.n<p>Modify Criteria:</p><ul><li>A Client <strong>SHOULD</strong> be capable of posting a Task resource using:<code class=\"highlighter-rouge\">POST [base]/Task/[id]{?_format=[mime-type]}</code></li><li>A Client <strong>SHALL</strong> be capable of putting an existing Task resource using:<code class=\"highlighter-rouge\">PUT [base]/Task/[id]{?_format=[mime-type]}</code></li></ul><p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Task resource using:<code class=\"highlighter-rouge\">GET [base]/Task/[id]</code><ul><li>A Client <strong>(conformance expectation undefined)</strong> support conditional read of Task resources only with the If-Modified-Since HTTP Header.</li></ul></li><li>A Client <strong>SHALL</strong> be capable of fetching resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Task/[id]{?[parameters]{&_format=[mime-type]}}</code></li><li>A Client <strong>(conformance expectation undefined)</strong> be capable of supporting the following _includes:<ul><li>Task:output - <code class=\"highlighter-rouge\">GET [base]/Task?[parameter=value]&_include=Task:output</code></li></ul></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Task?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Task?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Task?code=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">owner</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Task?owner=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Task?patient=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">requester</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Task?requester=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">status</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Task?status=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">focus</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Task?focus=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">output</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Task?output=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/search.html#id\">_id</a> (token):<p>Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates</p></li><li><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">_lastUpdated</a> (date):<p>Allows filtering for only records that have changed since last query</p></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">code</a> (token):<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></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">owner</a> (reference):<p>Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)</p></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">patient</a> (reference):<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></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">requester</a> (reference):<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></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">status</a> (token):<p>Allows filtering to only active or completed tasks</p></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">focus</a> (reference):<p>Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest</p></li><li><a href=\"http://hl7.org/fhir/R4/task.html#search\">output</a> (reference):<p>Allows for the 'output' of a Task to be included when retrieving a Task</p></li></ul></div></div>"
},
"url" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipientLight",
"version" : "2.1.0",
"name" : "SDOHCC_ReferralRecipientLight",
"title" : "SDOHCC Referral Recipient - Light",
"status" : "draft",
"date" : "2021-06",
"publisher" : "HL7 International Patient Care WG",
"contact" : [
{
"name" : "HL7 International Patient Care WG",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
},
{
"system" : "email",
"value" : "patientcare@lists.hl7.org"
}
]
}
],
"description" : "This resource describes the required and desired behavior of systems acting as 'light-weight' SDOH clinical care 'referral recipients'.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"purpose" : "These systems fit into the SDOH care workflow in the same manner as ['regular' Referral Recipients](CapabilityStatement-SDOHCC-ReferralRecipient.html), however they have simpler interface requirements reflecting the inability of the systems to store data locally and/or expose a FHIR service allowing access to that data. 'Light' referral recipients are not expected to expose any FHIR restful services. Instead, they act as clients, querying for tasks on the initiating [Referral Sources](CapabilityStatement-SDOHCC-ReferralSource.html) or [Coordination Platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) and creating any resulting Procedure records within the server they received the request from.",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "The light clinical care referral recipient needs to access information from and update information in SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html) and/or [coordination platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) that have solicited the filling of SDOH-related referrals by this system",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR"
}
]
}
],
"description" : "Implementations must meet the general privacy & security requirements documented in [this implementation guide](privacy_and_security.html)."
},
"resource" : [
{
"type" : "CareTeam",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "MAY"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Condition",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Condition that is the reason for a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
"type" : "token",
"documentation" : "Allows filtering to only SDOH-related conditions"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type" : "token",
"documentation" : "Allows filtering to only active conditions"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering to only specific SDOH conditions or sets of conditions"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "verification-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
"type" : "token",
"documentation" : "Allows filtering to exclude refuted or entered-in-error conditions"
}
]
},
{
"type" : "Consent",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest."
}
],
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"Consent:source-reference:DocumentReference"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "source-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-source-reference",
"type" : "reference",
"documentation" : "Allows including the document that contains the PDF or similar representation of a paper consent"
}
]
},
{
"type" : "Device",
"supportedProfile" : [
"http://hl7.org/fhir/StructureDefinition/Device"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a PDF or similar content referenced by a Consent or Task."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Goal",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to access goals related to an SDOH referral",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a goal referenced by a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Goals in the event they are updated."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "achievement-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-achievement-status",
"type" : "token",
"documentation" : "Allows filtering to only include unmet goals"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-category",
"type" : "token",
"documentation" : "Allows filtering to only include SDOH-related goals"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "lifecycle-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"type" : "token",
"documentation" : "Allows filtering to only include active goals"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "target-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"type" : "date",
"documentation" : "Allows filtering based on when a particular goal is desired to be achieved"
}
]
},
{
"type" : "HealthcareService",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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 service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-location",
"type" : "reference",
"documentation" : "Allows retrieval of the phyical site(s) associated with a HealthService"
}
]
},
{
"type" : "Location",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Location that is an available location for a service."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Locations that are the intended locations for services."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral as well as certain SDOH-relevant demographic information",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve an Observation referenced by a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Observations for updates/corrections."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"documentation" : "Allows filtering for only SDOH-related observations"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering for specific types of observations"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-code-value-concept",
"type" : "composite",
"documentation" : "Allows filtering for observations that have a specific coded value answer for a specified observation type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Allows filtering for observations that held in a particular time period"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-derived-from",
"type" : "reference",
"documentation" : "Allows filtering for observations derived from a particular QuestionnaireResponse"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)"
}
]
},
{
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about an Organization that is the requester or intended performer of a ServiceRequest",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about the Patient that is the subject a ServiceRequest",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve the Patient that is the subject of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Patients."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Practitioner",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, 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" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "PractitionerRole",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, 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" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-organization",
"type" : "reference",
"documentation" : "Allows doing an _include on Organization when retrieving the PractitionerRole"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
"type" : "reference",
"documentation" : "Allows doing an _include on Practitioner when retrieving the PractitionerRole"
}
]
},
{
"type" : "Procedure",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to record information about actions that have been performed as a result of a referral",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows the system to write records of procedures done in response to a referral on the system that asked for the referral."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "Allows the system to update records of procedures done in response to a referral on the system that asked for the referral."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the referral recipient to retrieve procedures referenced by Tasks previously posted."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the referral recipient to check if others have updated (e.g. added comments) to procedures previously posted and/or to find previously submitted procedures so they can be rendered to a user."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-based-on",
"type" : "reference",
"documentation" : "Allows filtering for procedures resulting from a particular service request"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-category",
"type" : "token",
"documentation" : "Allows filtering for procedures that are SDOH-related"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering for procedures based on the specific service delivered"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Allows filtering for procedures based on when they were delivered"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-performer",
"type" : "reference",
"documentation" : "Allows filtering for procedures based on who delivered the procedure."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-status",
"type" : "token",
"documentation" : "Allows filtering for procedures that are complete or in progress"
}
]
},
{
"type" : "RelatedPerson",
"supportedProfile" : [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about the requester or intended performer of a ServiceRequest 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" : "MAY"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "ServiceRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "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" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows client systems to retrieve the ServiceRequest pointed to by a Task."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling."
}
],
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"HealthCareService:location",
"ServiceRequest:supporting-info",
"ServiceRequest:pertains-to-goal",
"ServiceRequest:patient",
"ServiceRequest:requester",
"ServiceRequest:performer",
"PractitionerRole:practitioner",
"PractitionerRole:organization"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-category",
"type" : "token",
"documentation" : "Allows filtering to only retrieve ServiceRequests that are SDOH-related"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering to retrieve ServiceRequests for specific types of services"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-intent",
"type" : "token",
"documentation" : "Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "occurrence",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence",
"type" : "date",
"documentation" : "Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"type" : "reference",
"documentation" : "Allows filtering to retrieve only ServiceRequests that designate a specific performer"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-requester",
"type" : "reference",
"documentation" : "Allows filtering to retrieve only ServiceRequests created by a specific practitioner"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"type" : "token",
"documentation" : "Allows filtering to retrieve only active ServiceRequests"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "supporting-info",
"definition" : "http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/ServiceRequest-supporting-info",
"type" : "reference",
"documentation" : "Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent"
}
]
},
{
"type" : "Subscription",
"supportedProfile" : [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to allow upstream systems to subscribe to and monitor Tasks stored on this system for change",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Necessary if using subscriptions to monitor updates to the Task"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Needed to allow the requester to update a subscription - to adjust delivery target, to add additional tasks to monitor (if subscribing by id) typically to cancel a request for fulfillment"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/Backport-subscription-status",
"documentation" : "Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "topic-list",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/Backport-subscriptiontopic-list",
"documentation" : "Allows discovery of what subscription topics the systems supports - needed for systems that aren't pre-configured to be aware of what topics are available for use."
}
]
},
{
"type" : "Task",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows the referral recipient to create and monitor for Tasks assigned by referral sources or coordination platforms. Also allows the creation and monitoring of tasks assigned to patients and caregivers.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows referral recipients to request actions of patients and caregivers"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "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). ReferralRecipients can freely modify any Tasks they have created (though they should consider the impact of doing so on downstream recipients or the patient). However, if they are not the creator, they SHALL only modify tasks they are the 'owner' of and then, only modify Task.status, Task.statusReason, and Task.outputs are possible, and then only for Tasks where the owner is the patient."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query."
}
],
"versioning" : "versioned-update",
"conditionalRead" : "modified-since",
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"Task:output"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-code",
"type" : "token",
"documentation" : "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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "owner",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-owner",
"type" : "reference",
"documentation" : "Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-patient",
"type" : "reference",
"documentation" : "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.)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-requester",
"type" : "reference",
"documentation" : "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"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-status",
"type" : "token",
"documentation" : "Allows filtering to only active or completed tasks"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-focus",
"type" : "reference",
"documentation" : "Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "output",
"definition" : "http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference",
"type" : "reference",
"documentation" : "Allows for the 'output' of a Task to be included when retrieving a Task"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "batch",
"documentation" : "Allows polling for changes to multiple resource types simultaneously"
}
]
}
]
}
IG © 2021+ HL7 International Patient Care WG. Package hl7.fhir.us.sdoh-clinicalcare#2.1.0 based on FHIR 4.0.1. Generated 2023-07-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change