This page is part of the SDOH Clinical Care for Multiple Domains (v1.1.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
Raw OpenAPI-Swagger Definition file | Download
(Requirements Definition Capability Statement)
Canonical URL: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient Published: 2021-06 (draft)
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.
FHIR Version: | 4.0.1 |
---|---|
Supported formats: | xml, json |
The clinical care referral recipient needs to access information from and update information in SDOH clinical care referral sources and/or coordination platforms that have solicited the filling of SDOH-related referrals by this system
Security:
SMART-on-FHIRImplementations must meet the general privacy & security requirements documented in this implementation guide.
Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete | Operations |
---|---|---|---|---|---|---|---|---|---|
CareTeam | MAY | MAY | |||||||
Condition | SHOULD | SHALL | |||||||
Consent | SHOULD | SHALL | |||||||
Device | SHOULD | SHOULD | |||||||
DocumentReference | SHOULD | SHALL | |||||||
Goal | SHOULD | SHALL | |||||||
HealthcareService | SHOULD | SHOULD | |||||||
Location | MAY | SHOULD | |||||||
Observation | SHOULD | SHALL | |||||||
Organization | SHOULD | SHALL | |||||||
Patient | SHOULD | SHALL | |||||||
Practitioner | SHOULD | SHALL | |||||||
PractitionerRole | SHOULD | SHALL | |||||||
RelatedPerson | MAY | MAY | |||||||
ServiceRequest | SHOULD | SHALL | |||||||
Subscription | SHOULD | MAY | $status: SHOULD
$topic-list: MAY |
Name | Capability Statement | Description |
---|---|---|
batch | SHOULD |
Allows polling for changes to multiple resource types simultaneously |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
category | SHALL | token |
Allows filtering to only SDOH-related conditions |
clinical-status | SHOULD | token |
Allows filtering to only active conditions |
code | SHOULD | token |
Allows filtering to only specific SDOH conditions or sets of conditions |
patient | SHALL | reference |
Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific |
verification-status | SHOULD | token |
Allows filtering to exclude refuted or entered-in-error conditions |
Supported Profile(s):
Reference policy: literal
Supported Includes: Consent:source-reference:DocumentReference
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
source-reference | SHALL | reference |
Allows including the document that contains the PDF or similar representation of a paper consent |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
achievement-status | SHOULD | token |
Allows filtering to only include unmet goals |
category | SHALL | token |
Allows filtering to only include SDOH-related goals |
lifecycle-status | SHOULD | token |
Allows filtering to only include active goals |
patient | SHALL | reference |
Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific |
target-date | SHOULD | date |
Allows filtering based on when a particular goal is desired to be achieved |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
location | SHALL | reference |
Allows retrieval of the phyical site(s) associated with a HealthService |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
category | SHALL | token |
Allows filtering for only SDOH-related observations |
code | SHOULD | token |
Allows filtering for specific types of observations |
code-value-concept | MAY | composite |
Allows filtering for observations that have a specific coded value answer for a specified observation type |
date | SHOULD | date |
Allows filtering for observations that held in a particular time period |
derived-from | SHOULD | reference |
Allows filtering for observations derived from a particular QuestionnaireResponse |
patient | SHALL | reference |
Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific |
status | SHALL | token |
Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error) |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Name | Conformance | Description |
---|---|---|
read | SHALL |
Allows the system to retrieve the Patient that is the subject of a ServiceRequest. |
search-type | SHOULD |
Allows the monitoring of previously-retrieved Patients. |
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Supported Includes: PractitionerRole:organization PractitionerRole:practitioner
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
organization | SHOULD | reference |
Allows doing an _include on Organization when retrieving the PractitionerRole |
practitioner | SHOULD | reference |
Allows doing an _include on Practitioner when retrieving the PractitionerRole |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Reference policy: literal
Supported Includes: HealthCareService:location ServiceRequest:supporting-info ServiceRequest:pertains-to-goal ServiceRequest:patient ServiceRequest:requester ServiceRequest:performer PractitionerRole:practitioner PractitionerRole:organization
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
category | SHALL | token |
Allows filtering to only retrieve ServiceRequests that are SDOH-related |
code | SHOULD | token |
Allows filtering to retrieve ServiceRequests for specific types of services |
intent | SHALL | token |
Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc. |
occurrence | SHOULD | date |
Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided |
patient | SHALL | reference |
Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific |
performer | SHOULD | reference |
Allows filtering to retrieve only ServiceRequests that designate a specific performer |
requester | SHOULD | reference |
Allows filtering to retrieve only ServiceRequests created by a specific practitioner |
status | SHALL | token |
Allows filtering to retrieve only active ServiceRequests |
supporting-info | SHOULD | reference |
Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent |
Supported Profile(s):
The clinical care referral recipient needs to allow SDOH clinical care referral sources and coordination platforms 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:
SMART-on-FHIRImplementations must meet the general privacy & security requirements documented in this implementation guide.
Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete | Operations |
---|---|---|---|---|---|---|---|---|---|
DocumentReference | SHALL | SHALL | SHALL | SHOULD | |||||
Subscription | SHOULD | MAY | $status: SHOULD
$topic-list: MAY |
||||||
Task | SHALL |
SHALL
(conditional read: modified-since) |
SHALL | SHALL |
Name | Capability Statement | Description |
---|---|---|
batch | SHOULD |
Allows other systems to poll for changes to multiple resource types simultaneously |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
Supported Profile(s):
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Supported Includes: Task:output
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query |
code | SHALL | token |
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. |
owner | SHOULD | reference |
Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned) |
patient | SHALL | reference |
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.) |
requester | SHALL | reference |
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 |
status | SHALL | token |
Allows filtering to only active or completed tasks |
focus | SHALL | reference |
Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest |
output | SHOULD | reference |
Allows for the 'output' of a Task to be included when retrieving a Task |