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

CapabilityStatement: SDOHCC Referral Recipient Capability Statement

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient Version: 2.0.0
Draft as of 2021-06 Computable Name: SDOHCC_ReferralRecipient

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.

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 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 and Coordination Platforms. 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 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.

Raw OpenAPI-Swagger Definition file | Download

SDOHCC Referral Recipient

(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.

General

FHIR Version: 4.0.1
Supported formats: xml, json

REST client behavior

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-FHIR

Implementations must meet the general privacy & security requirements documented in this implementation guide.

Resource summary

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
Procedure SHOULD SHALL SHALL SHALL
RelatedPerson MAY MAY
ServiceRequest SHOULD SHALL
Subscription SHOULD MAY $status: SHOULD
$topic-list: MAY

General interactions

Name Capability Statement Description
  batch SHOULD

Allows polling for changes to multiple resource types simultaneously



CareTeam

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read MAY

Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.

  search-type MAY

Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.

Search

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



Condition

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve a Condition that is the reason for a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.

Search

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



Consent

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.

Search

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



Device

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHOULD

Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.

Search

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



DocumentReference

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.

  search-type SHOULD

Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.

Search

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



Goal

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve a goal referenced by a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Goals in the event they are updated.

Search

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



HealthcareService

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHOULD

Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.

Search

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



Location

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHOULD

Allows the system to retrieve a Location that is an available location for a service.

  search-type MAY

Allows the monitoring of previously-retrieved Locations that are the intended locations for services.

Search

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



Observation

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve an Observation referenced by a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Observations for updates/corrections.

Search

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)



Organization

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.

Search

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



Patient

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

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.

Search

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



Practitioner

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.

Search

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



PractitionerRole

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.

  search-type SHOULD

Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.

Search

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



Procedure

Supported Profile(s) - if resource is supported:

Behavior

Versioning support: versioned-update

Reference policy: literal

Interactions

Name Conformance Description
  create SHALL

Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.

  update SHALL

Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.

  read SHALL

Allows the referral recipient to retrieve procedures referenced by Tasks previously posted.

  search-type SHOULD

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.

Search

Parameter Conformance Type Definition & Chaining
_id SHALL token

Allows retrieving known Procedure 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

based-on SHALL reference

Allows filtering for procedures resulting from a particular service request

category SHALL token

Allows filtering for procedures that are SDOH-related

code SHOULD token

Allows filtering for procedures based on the specific service delivered

date SHOULD date

Allows filtering for procedures based on when they were delivered

patient SHALL reference

Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.

performer SHALL reference

Allows filtering for procedures based on who delivered the procedure.

status SHALL token

Allows filtering for procedures that are complete or in progress



RelatedPerson

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read MAY

Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.

  search-type MAY

Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.

Search

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



ServiceRequest

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  read SHALL

Allows client systems to retrieve the ServiceRequest pointed to by a Task.

  search-type SHOULD

Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.

Search

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



Subscription

Supported Profile(s) - if resource is supported:

Interactions

Name Conformance Description
  create SHOULD

Necessary if using subscriptions to monitor updates to the Task

  update MAY

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

  $status SHOULD

Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors

  $topic-list MAY

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.

REST server behavior

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-FHIR

Implementations must meet the general privacy & security requirements documented in this implementation guide.

Resource summary

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

General interactions

Name Capability Statement Description
  batch SHOULD

Allows other systems to poll for changes to multiple resource types simultaneously



DocumentReference

Supported Profile(s) - if resource is supported:

Behavior

Reference policy: literal

Interactions

Name Conformance Description
  create SHALL

Allows the app to record a new PDF (e.g. a completed form)

  update SHOULD

Allows the system to revise a previously stored PDF

  read SHALL

Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task.

  search-type SHALL

Allows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.

Search

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



Subscription

Supported Profile(s) - if resource is supported:

Interactions

Name Conformance Description
  create SHOULD

Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)

  update MAY

Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.

  $status SHOULD

Allows upstream systems to verify their subscription is functioning properly and to check for errors

  $topic-list MAY

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.



Task

Supported Profile(s) - if resource is supported:

Behavior

Versioning support: versioned-update

Reference policy: literal

Interactions

Name Conformance Description
  create SHALL

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.

  update SHALL

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.

  read SHALL

Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.

  search-type SHALL

Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.

Search

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