SDOH Clinical Care
2.0.0 - STU 2
US
SDOH Clinical Care
2.0.0 - STU 2
US
This page is part of the SDOH Clinical Care for Multiple Domains (v2.0.0: STU 2) 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-ReferralRecipient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>SDOHCC Referral Recipient</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient Published: 2021-06 (draft)</p>\n <p>This resource describes the required and desired behavior of systems acting as SDOH clinical care 'referral recipients'. These are typically community-based organizations that can provide services such as food bank access, housing remediation, etc.</p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>xml, json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST client behavior</h2>\n <p>The 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>\n <p>\n <b>Security:</b>\n </p>SMART-on-FHIR<br/><p>Implementations must meet the general privacy & security requirements documented in <a href=\"privacy_and_security.html\">this implementation guide</a>.</p><h3>Resource summary</h3><div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n <th>Operations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>CareTeam</th>\n <td>\n <a href=\"#CareTeam-search-type\" title=\"Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.\">MAY</a>\n </td>\n <td>\n <a href=\"#CareTeam-read\" title=\"Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.\">MAY</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Condition</th>\n <td>\n <a href=\"#Condition-search-type\" title=\"Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Condition-read\" title=\"Allows the system to retrieve a Condition that is the reason for a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Consent</th>\n <td>\n <a href=\"#Consent-search-type\" title=\"Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Consent-read\" title=\"Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Device</th>\n <td>\n <a href=\"#Device-search-type\" title=\"Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Device-read\" title=\"Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.\">SHOULD</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>DocumentReference</th>\n <td>\n <a href=\"#DocumentReference-search-type\" title=\"Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#DocumentReference-read\" title=\"Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Goal</th>\n <td>\n <a href=\"#Goal-search-type\" title=\"Allows the monitoring of previously-retrieved Goals in the event they are updated.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Goal-read\" title=\"Allows the system to retrieve a goal referenced by a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>HealthcareService</th>\n <td>\n <a href=\"#HealthcareService-search-type\" title=\"Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#HealthcareService-read\" title=\"Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.\">SHOULD</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Location</th>\n <td>\n <a href=\"#Location-search-type\" title=\"Allows the monitoring of previously-retrieved Locations that are the intended locations for services.\">MAY</a>\n </td>\n <td>\n <a href=\"#Location-read\" title=\"Allows the system to retrieve a Location that is an available location for a service.\">SHOULD</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Observation</th>\n <td>\n <a href=\"#Observation-search-type\" title=\"Allows the monitoring of previously-retrieved Observations for updates/corrections.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Observation-read\" title=\"Allows the system to retrieve an Observation referenced by a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Organization</th>\n <td>\n <a href=\"#Organization-search-type\" title=\"Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Organization-read\" title=\"Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Patient</th>\n <td>\n <a href=\"#Patient-search-type\" title=\"Allows the monitoring of previously-retrieved Patients.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Patient-read\" title=\"Allows the system to retrieve the Patient that is the subject of a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Practitioner</th>\n <td>\n <a href=\"#Practitioner-search-type\" title=\"Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Practitioner-read\" title=\"Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>PractitionerRole</th>\n <td>\n <a href=\"#PractitionerRole-search-type\" title=\"Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#PractitionerRole-read\" title=\"Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Procedure</th>\n <td>\n <a href=\"#Procedure-search-type\" title=\"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.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Procedure-read\" title=\"Allows the referral recipient to retrieve procedures referenced by Tasks previously posted.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td>\n <a href=\"#Procedure-create\" title=\"Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.\">SHALL</a>\n </td>\n <td>\n <a href=\"#Procedure-update\" title=\"Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.\">SHALL</a>\n </td>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>RelatedPerson</th>\n <td>\n <a href=\"#RelatedPerson-search-type\" title=\"Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.\">MAY</a>\n </td>\n <td>\n <a href=\"#RelatedPerson-read\" title=\"Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.\">MAY</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>ServiceRequest</th>\n <td>\n <a href=\"#ServiceRequest-search-type\" title=\"Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#ServiceRequest-read\" title=\"Allows client systems to retrieve the ServiceRequest pointed to by a Task.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Subscription</th>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td>\n <a href=\"#Subscription-create\" title=\"Necessary if using subscriptions to monitor updates to the Task\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Subscription-update\" title=\"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\">MAY</a>\n </td>\n <td/>\n <td>$status: <a href=\"#Subscription-status\" title=\"Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors\">SHOULD</a><br/>$topic-list: <a href=\"#Subscription-topic-list\" title=\"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.\">MAY</a></td>\n </tr>\n </tbody>\n </table>\n </div><h3>General interactions</h3><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Capability Statement</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"-batch\"> </a>\n <span>batch</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows polling for changes to multiple resource types simultaneously</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/careteam.html\">CareTeam</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"CareTeam-read\"> </a>\n <span>read</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"CareTeam-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/condition.html\">Condition</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Condition-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve a Condition that is the reason for a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Condition-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>category</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only SDOH-related conditions</p>\n </td>\n </tr>\n <tr>\n <th>clinical-status</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only active conditions</p>\n </td>\n </tr>\n <tr>\n <th>code</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only specific SDOH conditions or sets of conditions</p>\n </td>\n </tr>\n <tr>\n <th>patient</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific</p>\n </td>\n </tr>\n <tr>\n <th>verification-status</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering to exclude refuted or entered-in-error conditions</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/consent.html\">Consent</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Consent-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Consent-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><p>Supported Includes: Consent:source-reference:DocumentReference</p><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>source-reference</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows including the document that contains the PDF or similar representation of a paper consent</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/device.html\">Device</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/StructureDefinition/Device\">http://hl7.org/fhir/StructureDefinition/Device</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Device-read\"> </a>\n <span>read</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Device-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"DocumentReference-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"DocumentReference-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/goal.html\">Goal</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Goal-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve a goal referenced by a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Goal-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Goals in the event they are updated.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>achievement-status</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only include unmet goals</p>\n </td>\n </tr>\n <tr>\n <th>category</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only include SDOH-related goals</p>\n </td>\n </tr>\n <tr>\n <th>lifecycle-status</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only include active goals</p>\n </td>\n </tr>\n <tr>\n <th>patient</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific</p>\n </td>\n </tr>\n <tr>\n <th>target-date</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering based on when a particular goal is desired to be achieved</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/healthcareservice.html\">HealthcareService</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"HealthcareService-read\"> </a>\n <span>read</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"HealthcareService-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>location</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows retrieval of the phyical site(s) associated with a HealthService</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/location.html\">Location</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Location-read\"> </a>\n <span>read</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the system to retrieve a Location that is an available location for a service.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Location-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Locations that are the intended locations for services.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment</a> SHALL</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse</a> SHALL</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB</a> MAY</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB</a> MAY</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity</a> MAY</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic</a> MAY</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns</a> MAY</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender</a> MAY</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation</a> MAY</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Observation-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve an Observation referenced by a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Observation-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Observations for updates/corrections.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>category</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering for only SDOH-related observations</p>\n </td>\n </tr>\n <tr>\n <th>code</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering for specific types of observations</p>\n </td>\n </tr>\n <tr>\n <th>code-value-concept</th>\n <td>MAY</td>\n <td>composite</td>\n <td>\n <p>Allows filtering for observations that have a specific coded value answer for a specified observation type</p>\n </td>\n </tr>\n <tr>\n <th>date</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for observations that held in a particular time period</p>\n </td>\n </tr>\n <tr>\n <th>derived-from</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows filtering for observations derived from a particular QuestionnaireResponse</p>\n </td>\n </tr>\n <tr>\n <th>patient</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific</p>\n </td>\n </tr>\n <tr>\n <th>status</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Organization-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Organization-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Patient-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve the Patient that is the subject of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Patient-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Patients.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Practitioner-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Practitioner-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/practitionerrole.html\">PractitionerRole</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"PractitionerRole-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"PractitionerRole-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><p>Supported Includes: PractitionerRole:organization PractitionerRole:practitioner</p><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>organization</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows doing an _include on Organization when retrieving the PractitionerRole</p>\n </td>\n </tr>\n <tr>\n <th>practitioner</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows doing an _include on Practitioner when retrieving the PractitionerRole</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/procedure.html\">Procedure</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Versioning support: versioned-update</p><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Procedure-create\"> </a>\n <span>create</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Procedure-update\"> </a>\n <span>update</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Procedure-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the referral recipient to retrieve procedures referenced by Tasks previously posted.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Procedure-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <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>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>based-on</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows filtering for procedures resulting from a particular service request</p>\n </td>\n </tr>\n <tr>\n <th>category</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering for procedures that are SDOH-related</p>\n </td>\n </tr>\n <tr>\n <th>code</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering for procedures based on the specific service delivered</p>\n </td>\n </tr>\n <tr>\n <th>date</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for procedures based on when they were delivered</p>\n </td>\n </tr>\n <tr>\n <th>patient</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.</p>\n </td>\n </tr>\n <tr>\n <th>performer</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows filtering for procedures based on who delivered the procedure.</p>\n </td>\n </tr>\n <tr>\n <th>status</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering for procedures that are complete or in progress</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/relatedperson.html\">RelatedPerson</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/StructureDefinition/RelatedPerson\">http://hl7.org/fhir/StructureDefinition/RelatedPerson</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"RelatedPerson-read\"> </a>\n <span>read</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"RelatedPerson-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/servicerequest.html\">ServiceRequest</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"ServiceRequest-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows client systems to retrieve the ServiceRequest pointed to by a Task.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"ServiceRequest-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><p>Supported Includes: HealthCareService:location ServiceRequest:supporting-info ServiceRequest:pertains-to-goal ServiceRequest:patient ServiceRequest:requester ServiceRequest:performer PractitionerRole:practitioner PractitionerRole:organization</p><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>category</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only retrieve ServiceRequests that are SDOH-related</p>\n </td>\n </tr>\n <tr>\n <th>code</th>\n <td>SHOULD</td>\n <td>token</td>\n <td>\n <p>Allows filtering to retrieve ServiceRequests for specific types of services</p>\n </td>\n </tr>\n <tr>\n <th>intent</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.</p>\n </td>\n </tr>\n <tr>\n <th>occurrence</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided</p>\n </td>\n </tr>\n <tr>\n <th>patient</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <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>\n </td>\n </tr>\n <tr>\n <th>performer</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows filtering to retrieve only ServiceRequests that designate a specific performer</p>\n </td>\n </tr>\n <tr>\n <th>requester</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows filtering to retrieve only ServiceRequests created by a specific practitioner</p>\n </td>\n </tr>\n <tr>\n <th>status</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering to retrieve only active ServiceRequests</p>\n </td>\n </tr>\n <tr>\n <th>supporting-info</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\">http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription</a> SHALL</li>\n </ul><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Subscription-create\"> </a>\n <span>create</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Necessary if using subscriptions to monitor updates to the Task</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-update\"> </a>\n <span>update</span>\n </th>\n <td>MAY</td>\n <td>\n <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>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-status\"> </a>\n <span>$status</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-topic-list\"> </a>\n <span>$topic-list</span>\n </th>\n <td>MAY</td>\n <td>\n <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>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h2>REST server behavior</h2><p>The clinical care referral recipient needs to allow SDOH clinical care <a href=\"CapabilityStatement-SDOHCC-ReferralSource.html\">referral sources</a> and <a href=\"CapabilityStatement-SDOHCC-CoordinationPlatform.html\">coordination platforms</a> to have solicited the filling of SDOH-related referrals by this system and also to access Procedures that describe interventions taken by the users of this system.</p><p>\n <b>Security:</b>\n </p>SMART-on-FHIR<br/><p>Implementations must meet the general privacy & security requirements documented in <a href=\"privacy_and_security.html\">this implementation guide</a>.</p><h3>Resource summary</h3><div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n <th>Operations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>DocumentReference</th>\n <td>\n <a href=\"#DocumentReference-search-type\" title=\"Allows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.\">SHALL</a>\n </td>\n <td>\n <a href=\"#DocumentReference-read\" title=\"Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task.\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td>\n <a href=\"#DocumentReference-create\" title=\"Allows the app to record a new PDF (e.g. a completed form)\">SHALL</a>\n </td>\n <td>\n <a href=\"#DocumentReference-update\" title=\"Allows the system to revise a previously stored PDF\">SHOULD</a>\n </td>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Subscription</th>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td>\n <a href=\"#Subscription-create\" title=\"Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Subscription-update\" title=\"Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.\">MAY</a>\n </td>\n <td/>\n <td>$status: <a href=\"#Subscription-status\" title=\"Allows upstream systems to verify their subscription is functioning properly and to check for errors\">SHOULD</a><br/>$topic-list: <a href=\"#Subscription-topic-list\" title=\"Allows upstream systems to discover of what subscription topics this system supports - needed for systems that aren't pre-configured to be aware of what topics are available for use.\">MAY</a></td>\n </tr>\n <tr>\n <th>Task</th>\n <td>\n <a href=\"#Task-search-type\" title=\"Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.\">SHALL</a>\n </td>\n <td>\n <a href=\"#Task-read\" title=\"Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.\">SHALL</a>\n <br/>(conditional read:<br/>modified-since)</td>\n <td/>\n <td/>\n <td/>\n <td>\n <a href=\"#Task-create\" title=\"Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities.\">SHALL</a>\n </td>\n <td>\n <a href=\"#Task-update\" title=\"Allows modification of an existing Task by upstream systems (e.g. to cancel it) or by downstream systems (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.\">SHALL</a>\n </td>\n <td/>\n <td/>\n </tr>\n </tbody>\n </table>\n </div><h3>General interactions</h3><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Capability Statement</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"-batch\"> </a>\n <span>batch</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows other systems to poll for changes to multiple resource types simultaneously</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"DocumentReference-create\"> </a>\n <span>create</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the app to record a new PDF (e.g. a completed form)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"DocumentReference-update\"> </a>\n <span>update</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows the system to revise a previously stored PDF</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"DocumentReference-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"DocumentReference-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription\">http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription</a> SHALL</li>\n </ul><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Subscription-create\"> </a>\n <span>create</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-update\"> </a>\n <span>update</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-status\"> </a>\n <span>$status</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows upstream systems to verify their subscription is functioning properly and to check for errors</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-topic-list\"> </a>\n <span>$topic-list</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows upstream systems to discover of what subscription topics this system supports - needed for systems that aren't pre-configured to be aware of what topics are available for use.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><br/><br/><h3>\n <a href=\"http://hl7.org/fhir/R4/task.html\">Task</a>\n </h3><p>Supported Profile(s) - if resource is supported:</p><ul>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient</a> SHALL</li>\n <li>\n <a href=\"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement\">http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement</a> SHALL</li>\n </ul><h4>Behavior</h4><p>Versioning support: versioned-update</p><p>Reference policy: literal</p><h4>Interactions</h4><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Task-create\"> </a>\n <span>create</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Task-update\"> </a>\n <span>update</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows modification of an existing Task by upstream systems (e.g. to cancel it) or by downstream systems (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>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Task-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Task-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div><h4>Search</h4><p>Supported Includes: Task:output</p><div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Conformance</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>_id</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n </td>\n </tr>\n <tr>\n <th>_lastUpdated</th>\n <td>SHOULD</td>\n <td>date</td>\n <td>\n <p>Allows filtering for only records that have changed since last query</p>\n </td>\n </tr>\n <tr>\n <th>code</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <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>\n </td>\n </tr>\n <tr>\n <th>owner</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)</p>\n </td>\n </tr>\n <tr>\n <th>patient</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <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>\n </td>\n </tr>\n <tr>\n <th>requester</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <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>\n </td>\n </tr>\n <tr>\n <th>status</th>\n <td>SHALL</td>\n <td>token</td>\n <td>\n <p>Allows filtering to only active or completed tasks</p>\n </td>\n </tr>\n <tr>\n <th>focus</th>\n <td>SHALL</td>\n <td>reference</td>\n <td>\n <p>Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest</p>\n </td>\n </tr>\n <tr>\n <th>output</th>\n <td>SHOULD</td>\n <td>reference</td>\n <td>\n <p>Allows for the 'output' of a Task to be included when retrieving a Task</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div></div>"
},
"url" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient",
"version" : "2.0.0",
"name" : "SDOHCC_ReferralRecipient",
"title" : "SDOHCC Referral Recipient",
"status" : "draft",
"date" : "2021-06",
"publisher" : "HL7 International - Patient Care WG",
"contact" : [
{
"name" : "HL7 International - Patient Care",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
}
]
}
],
"description" : "This resource describes the required and desired behavior of systems acting as SDOH clinical care 'referral recipients'. These are typically community-based organizations that can provide services such as food bank access, housing remediation, etc.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
],
"text" : "United States of America"
}
],
"purpose" : "In some cases, a referral recipient might actually further refer the patient to a downstream service provider through non-FHIR means. In such cases, the system is still treated as a 'referral recipient' rather than a [Coordination Platform](CapabilityStatement-SDOHCC-CoordinationPlatform.html) because, from a FHIR interface perspective, the referral process 'stops' with that system. Referral recipients must be able to receive or monitor for Tasks issued by [Referral Sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [Coordination Platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html). They must also be able to respond to access the ServiceRequest representing the referral pointed to by the Task and any relevant information referenced by the referral, update the Task with their acceptance or rejection of the referral, and finally provide information about what interventions were actually performed using the Procedure resource.\\n\\n There are actually two types of referral recipients defined in this implementation guide. This CapabilityStatement describes the expected behavior of more sophisticated service delivery systems that are capable of exposing a FHIR service and persisting Tasks and Procedures in their own environment. A separate set of interface expectations is defined for ['Light' Referral Recipients](CapabilityStatement-SDOHCC-ReferralRecipientLight.html) that are not capable of exposing an endpoint and where the Task and any resulting Procedures must be stored in the requesting system's database.",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "The 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" : "SHALL"
}
],
"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."
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "batch",
"documentation" : "Allows polling for changes to multiple resource types simultaneously"
}
]
},
{
"mode" : "server",
"documentation" : "The clinical care referral recipient needs to allow SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [coordination platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) to have solicited the filling of SDOH-related referrals by this system and also to access Procedures that describe interventions taken by the users of 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" : "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 convey 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" : "create",
"documentation" : "Allows the app to record a new PDF (e.g. a completed form)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows the system to revise a previously stored PDF"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows patient apps to monitor 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" : "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 coordination platforms and referral sources to subscribe to and monitor Tasks created on this system",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc."
}
],
"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" : "Allows upstream systems to verify their 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 upstream systems to discover of what subscription topics this system 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" : "Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests. Also used by downstream referral recipiencts to monitor and update Tasks stored on this system as they respond to requests to fulfill referrals and link in information about actions taken so far",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "Allows modification of an existing Task by upstream systems (e.g. to cancel it) or by downstream systems (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 other systems to poll for changes to multiple resource types simultaneously"
}
]
}
]
}
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.sdoh-clinicalcare#2.0.0 based on FHIR 4.0.1. Generated 2022-11-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change