SDOH Clinical Care
3.0.0-ballot - STU 3 Ballot

SDOH Clinical Care - Downloaded Version 3.0.0-ballot See the Directory of published versions

## CapabilityStatement: SDOHCC Referral Source Capability Statement

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralSource | Version: 3.0.0-ballot
Standards status: Trial-use Active as of 2021-06 | Maturity Level: 2 | Computable Name: SDOHCC_ReferralSource

This resource describes the required and desired behavior of systems acting as SDOH clinical care 'referral sources'. These are typically EHR or Payer systems that initiate the process of identifying patients with SDOH needs and requesting appropriate services.

Raw OpenAPI-Swagger Definition file | Download

Language: en

## SDOHCC Referral Source

- Implementation Guide Version: 3.0.0-ballot
- FHIR Version: 4.0.1
- Supported Formats: `xml`, `json`
- Published on: 2021-06
- Published by: HL7 International / Patient Care

> Note to Implementers: FHIR Capabilities

> Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

## FHIR RESTful Capabilities

### REST Configuration: 1

#### Mode: `client`

The referral source needs to receive information about procedures done in response to referrals. They SHOULD also be able to receive information from upstream systems in cases where they are referred to themselves.

Security
Enable CORS: no
Security services supported: `SMART-on-FHIR`

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

Summary of System-wide Interactions

- SHOULD support the `batch`interaction described as follows:

  Allows polling for changes to multiple resource types simultaneously

#### Capabilities by Resource/Profile

##### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
CareTeam | Supported Profiles US Core CareTeam Profileversion: 7.0.0) | y? | y? |  |  | _id, _lastUpdated |  |  |
Condition | Supported Profiles SDOHCC Condition | Y | Y |  |  | _id, _lastUpdated, category, clinical-status, code, patient, verification-status |  |  |
Consent | Supported Profiles SDOHCC Consent | Y | Y |  |  | _id, _lastUpdated, source-reference | `Consent:source-reference:DocumentReference` |  |
Device | Supported Profiles Device | Y | Y |  |  | _id, _lastUpdated |  |  |
DocumentReference | Supported Profiles US Core DocumentReference Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
Goal | Supported Profiles SDOHCC Goal | Y | Y |  |  | _id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date |  |  |
HealthcareService | Supported Profiles SDOHCC Healthcare Service | Y | Y |  |  | _id, _lastUpdated, location |  |  |
Location | Supported Profiles SDOHCC Location | Y | y? |  |  | _id, _lastUpdated |  |  |
Observation | Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response SDOHCC Observation Ethnicity OMB SDOHCC Observation Race OMB SDOHCC Observation Gender Identity SDOHCC Observation Personal Characteristic SDOHCC Observation Personal Pronouns SDOHCC Observation Recorded Sex Gender SDOHCC Observation Sexual Orientation | Y | Y |  |  | _id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status |  |  |
Organization | Supported Profiles US Core Organization Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
Patient | Supported Profiles US Core Patient Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
Practitioner | Supported Profiles US Core Practitioner Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
PractitionerRole | Supported Profiles SDOHCC PractitionerRole | Y | Y |  |  | _id, _lastUpdated, organization, practitioner | `PractitionerRole:organization`, `PractitionerRole:practitioner` |  |
Procedure | Supported Profiles SDOHCC Procedure | Y | Y |  |  | _id, _lastUpdated, based-on, category, code, date, patient, performer, status |  |  |
Questionnaire | Supported Profiles Extractable Questionnaire - StructureMap |  | Y |  |  | code, context-type-value, identifier, publisher, status, subject-type, title, url, version |  |  | `$populate`
QuestionnaireResponse | Supported Profiles SDC Questionnaire Response | Y | Y |  |  | _id, _lastUpdated, author, authored, patient, questionnaire, status |  |  |
RelatedPerson | Supported Profiles RelatedPerson | y? | y? |  |  | _id, _lastUpdated |  |  |
ServiceRequest | Supported Profiles SDOHCC ServiceRequest | Y | Y |  |  | _id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-info | `HealthCareService:location`, `ServiceRequest:supporting-info`, `ServiceRequest:pertains-to-goal`, `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:performer`, `PractitionerRole:practitioner`, `PractitionerRole:organization` |  |
Subscription | Supported Profiles R4/B Topic-Based Subscription |  |  | y? | Y |  |  |  | `$status`
Task | Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management | Y | Y | Y | Y | _id, _lastUpdated, code, owner, patient, requester, status, focus, output | `Task:focus`, `Task:output`, `HealthCareService:location`, `ServiceRequest:supporting-info`, `ServiceRequest:pertains-to-goal`, `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:performer`, `PractitionerRole:practitioner`, `PractitionerRole:organization` |  |

##### Resource Conformance: SHALLCareTeam

Core FHIR Resource
CareTeam
Reference Policy
`literal`
Interaction summary

- MAY support
  `read`

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

  `search-type`

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

Supported Profiles

US Core CareTeam Profileversion: 7.0.0)

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLCondition

Core FHIR Resource
Condition
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC Condition

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering to only SDOH-related conditions
SHALL | patient | `reference` | Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | clinical-status | `token` | Allows filtering to only active conditions
SHOULD | code | `token` | Allows filtering to only specific SDOH conditions or sets of conditions
SHOULD | verification-status | `token` | Allows filtering to exclude refuted or entered-in-error conditions

##### Resource Conformance: SHALLConsent

Core FHIR Resource
Consent
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC Consent

Documentation

> Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | source-reference | `reference` | Allows including the document that contains the PDF or similar representation of a paper consent

##### Resource Conformance: SHALLDevice

Core FHIR Resource
Device
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

Device

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLDocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

US Core DocumentReference Profileversion: 7.0.0)

Documentation

> Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLGoal

Core FHIR Resource
Goal
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC Goal

Documentation

> Used to access goals related to an SDOH referral

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering to only include SDOH-related goals
SHALL | patient | `reference` | Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | achievement-status | `token` | Allows filtering to only include unmet goals
SHOULD | lifecycle-status | `token` | Allows filtering to only include active goals
SHOULD | target-date | `date` | Allows filtering based on when a particular goal is desired to be achieved

##### Resource Conformance: SHALLHealthcareService

Core FHIR Resource
HealthcareService
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC Healthcare Service

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.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | location | `reference` | Allows retrieval of the phyical site(s) associated with a HealthService
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLLocation

Core FHIR Resource
Location
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

- MAY support
  `search-type`

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

Supported Profiles

SDOHCC Location

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.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLObservation

Core FHIR Resource
Observation
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC Observation Assessment
SDOHCC Observation Screening Response
SDOHCC Observation Ethnicity OMB
SDOHCC Observation Race OMB
SDOHCC Observation Gender Identity
SDOHCC Observation Personal Characteristic
SDOHCC Observation Personal Pronouns
SDOHCC Observation Recorded Sex Gender
SDOHCC Observation Sexual Orientation

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. Also used to share certain SDOH-relevant demographic information.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering for only SDOH-related observations
SHALL | patient | `reference` | Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | code | `token` | Allows filtering for specific types of observations
SHOULD | date | `date` | Allows filtering for observations that held in a particular time period
SHOULD | derived-from | `reference` | Allows filtering for observations derived from a particular QuestionnaireResponse
SHOULD | status | `token` | Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)
MAY | code-value-concept | `composite` | Allows filtering for observations that have a specific coded value answer for a specified observation type

##### Resource Conformance: SHALLOrganization

Core FHIR Resource
Organization
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

US Core Organization Profileversion: 7.0.0)

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLPatient

Core FHIR Resource
Patient
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

  Allows the system to retrieve the Patient that is the subject of a ServiceRequest.

  `search-type`

  Allows the monitoring of previously-retrieved Patients.

Supported Profiles

US Core Patient Profileversion: 7.0.0)

Documentation

> For referral sources that receive referrals from upstream systems, used to access information about the Patient that is the subject a ServiceRequest

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLPractitioner

Core FHIR Resource
Practitioner
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

US Core Practitioner Profileversion: 7.0.0)

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLPractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC PractitionerRole

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | organization | `reference` | Allows doing an _include on Organization when retrieving the PractitionerRole
SHOULD | practitioner | `reference` | Allows doing an _include on Practitioner when retrieving the PractitionerRole

##### Resource Conformance: SHALLProcedure

Core FHIR Resource
Procedure
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows the referral source to retrieve procedures referenced by Tasks from more sophisticated 'delivery' systems that store their data on their own system rather than using the referral source as a persistence layer.

- SHOULD support
  `search-type`

  Allows the referral source to check for updates on Procedures after they've already been received or to look for procedures that haven't yet been linked as outputs to the Tasks that initiated the work.

Supported Profiles

SDOHCC Procedure

Documentation

> Used to access information from downstream systems about actions that have been performed as a result of a referral

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | based-on | `reference` | Allows filtering for procedures resulting from a particular service request
SHALL | category | `token` | Allows filtering for procedures that are SDOH-related
SHALL | patient | `reference` | Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.
SHALL | performer | `reference` | Allows filtering for procedures based on who delivered the procedure.
SHALL | status | `token` | Allows filtering for procedures that are complete or in progress
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | code | `token` | Allows filtering for procedures based on the specific service delivered
SHOULD | date | `date` | Allows filtering for procedures based on when they were delivered

##### Resource Conformance: SHALLQuestionnaire

Core FHIR Resource
Questionnaire
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `search-type`

  Allows the referral source to search for questionnaires relevant to a patient context.

Supported Profiles

Extractable Questionnaire - StructureMap

Documentation

> Used to retrieve SDOH-related Questionnaires to be filled out by a patient or representative. Also allows retrieving Questionnaires associated with existing QuestionnaireResponses for editing by SMART-on-FHIR apps.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | url | `uri` | Allows retrieving Questionnaires based on its canonical URL
SHALL | version | `token` | Allows retrieving a specific version of a Questionnaire
SHOULD | code | `token` | Allows filtering for questionnaires associated with particular LOINC or similar codes
SHOULD | context-type-value | `composite` | Allows filtering for procedures that are SDOH-related
SHOULD | identifier | `token` | Allows retrieving Questionnaires with a known identifier
SHOULD | publisher | `string` | Allows retrieving Questionnaires based on who is responsible for them
SHOULD | status | `token` | Allows retrieving Questionnaires that are active (and not draft or required)
SHOULD | subject-type | `token` | Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc.
SHOULD | title | `string` | Allows retrieving Questionnaires based on the name of the form

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
MAY | $populate | Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere

##### Resource Conformance: SHALLQuestionnaireResponse

Core FHIR Resource
QuestionnaireResponse
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

  Allows the retrieval of QuestionnaireResponses pointed to as supporting information by a ServiceRequest or as output of a Task.

  `search-type`

  Allows checking for updates in previously retrieved QuestionnaireResponses.

Supported Profiles

SDC Questionnaire Response

Documentation

> Used to allow QuestionnaireResponses referenced by a ServiceRequest or Task

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | author | `reference` | Allows filtering QuestionnaireResponses previously created/edited by a particular individual
SHALL | patient | `reference` | Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific
SHALL | questionnaire | `reference` | Allows retrieving QuestionnaireResponses that have been completed against a specified form
SHALL | status | `token` | Allows retrieving QuestionnaireResponses that are complete (or incomplete)
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | authored | `date` | Allows filtering for QuestionnaireResponses by when they were created/last edited

##### Resource Conformance: SHALLRelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
`literal`
Interaction summary

- MAY support
  `read`

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

  `search-type`

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

Supported Profiles

RelatedPerson

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC ServiceRequest

Documentation

> For referral sources that receive referrals from upstream systems, used to retrieve an order for SDOH-related services

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering to only retrieve ServiceRequests that are SDOH-related
SHALL | intent | `token` | Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.
SHALL | patient | `reference` | Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific
SHALL | status | `token` | Allows filtering to retrieve only active ServiceRequests
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | code | `token` | Allows filtering to retrieve ServiceRequests for specific types of services
SHOULD | occurrence | `date` | Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided
SHOULD | performer | `reference` | Allows filtering to retrieve only ServiceRequests that designate a specific performer
SHOULD | requester | `reference` | Allows filtering to retrieve only ServiceRequests created by a specific practitioner
SHOULD | supporting-info | `reference` | Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent

##### Resource Conformance: SHOULDSubscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary

- SHOULD support
  `create`

  Necessary if using subscriptions to monitor updates to the Task

- MAY support
  `update`

  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

Supported Profiles

R4/B Topic-Based Subscription

Documentation

> When tasks have been created on upstream systems, used to access information about updates to those Tasks

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHOULD | $status | Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors

##### Resource Conformance: SHALLTask

Core FHIR Resource
Task
Reference Policy
`literal`
Interaction summary

- SHALL support
  `create`

  Allows the referral source to create tasks on a delivery system (or downstream coordination system).

  `update`

  Allows the referral source to modify the status of previously created tasks - e.g. to cancel them.

  `read`

  Allows the referral source to poll a single Task for changes.

- SHOULD support
  `search-type`

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

Supported Profiles

SDOHCC Task For Patient
SDOHCC Task For Referral Management

Documentation

> Used to create Tasks on downstream systems seeking fufillment of ServiceRequests on a coordinating system serving as an intermediary and to retrieve Task updates from a fulfilling system. Also used to create tasks soliciting information from patients.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | code | `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.
SHALL | patient | `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.)
SHALL | requester | `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
SHALL | status | `token` | Allows filtering to only active or completed tasks
SHALL | focus | `reference` | Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | owner | `reference` | Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)
SHOULD | output | `reference` | Allows for the 'output' of a Task to be included when retrieving a Task

### REST Configuration: 2

#### Mode: `server`

Referral sources must make both the referral and all information referenced by it available to downstream coordination platforms and referral recipient systems and - depending on the capabilities of the receivers - may also need to make the Tasks themselves available for query and support writing of procedures in situations where the recipient is a 'light' referral recipient that doesn't have local persistence or FHIR server capabilities.

Security
Enable CORS: no
Security services supported: `SMART-on-FHIR`

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

Summary of System-wide Interactions

- SHOULD support the `batch`interaction described as follows:

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

#### Capabilities by Resource/Profile

##### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
CareTeam | Supported Profiles US Core CareTeam Profileversion: 7.0.0) | y? | y? |  |  | _id, _lastUpdated |  |  |
Condition | Supported Profiles SDOHCC Condition | Y | Y | y? | y? | _id, _lastUpdated, category, clinical-status, code, patient, verification-status |  |  |
Consent | Supported Profiles SDOHCC Consent | Y | Y | y? | y? | _id, _lastUpdated, source-reference | `Consent:source-reference:DocumentReference` |  |
Device | Supported Profiles Device | Y | Y |  |  | _id, _lastUpdated |  |  |
DocumentReference | Supported Profiles US Core DocumentReference Profileversion: 7.0.0) | Y | Y | Y | Y | _id, _lastUpdated |  |  |
Goal | Supported Profiles SDOHCC Goal | Y | Y | y? | y? | _id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date |  |  |
Group | Supported Profiles SDOHCC Group | Y | Y |  |  | _id, _lastUpdated, characteristic-value, code, managing-entity, member | `Group:member` |  |
HealthcareService | Supported Profiles SDOHCC Healthcare Service | Y | Y |  |  | _id, _lastUpdated, location |  |  |
Location | Supported Profiles SDOHCC Location | Y | y? |  |  | _id, _lastUpdated |  |  |
Observation | Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response | Y | Y | y? | y? | _id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status |  |  |
Organization | Supported Profiles US Core Organization Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
Patient | Supported Profiles US Core Patient Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
Practitioner | Supported Profiles US Core Practitioner Profileversion: 7.0.0) | Y | Y |  |  | _id, _lastUpdated |  |  |
PractitionerRole | Supported Profiles SDOHCC PractitionerRole | Y | Y |  |  | _id, _lastUpdated, organization, practitioner | `PractitionerRole:organization`, `PractitionerRole:practitioner` |  |
Procedure | Supported Profiles SDOHCC Procedure | Y | Y | Y | Y | _id, _lastUpdated, based-on, category, code, date, patient, performer, status |  |  |
Questionnaire | Supported Profiles Extractable Questionnaire - StructureMap |  | y? |  |  | code, context-type-value, identifier, publisher, status, subject-type, title, url, version |  |  | `$populate`
QuestionnaireResponse | Supported Profiles SDC Questionnaire Response | Y | Y | Y | Y | _id, _lastUpdated, author, authored, patient, questionnaire, status |  |  |
RelatedPerson | Supported Profiles RelatedPerson | y? | y? |  |  | _id, _lastUpdated |  |  |
ServiceRequest | Supported Profiles SDOHCC ServiceRequest | Y | Y | y? | y? | _id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-info | `HealthCareService:location`, `ServiceRequest:supporting-info`, `ServiceRequest:pertains-to-goal`, `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:performer`, `PractitionerRole:practitioner`, `PractitionerRole:organization` |  |
Subscription | Supported Profiles R4/B Topic-Based Subscription |  |  | y? | Y |  |  |  | `$status`
Task | Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management | Y | Y | Y | Y | _id, _lastUpdated, code, owner, patient, requester, status, focus, output | `Task:focus`, `Task:output`, `HealthCareService:location`, `ServiceRequest:supporting-info`, `ServiceRequest:pertains-to-goal`, `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:performer`, `PractitionerRole:practitioner`, `PractitionerRole:organization` |  |

##### Resource Conformance: SHALLCareTeam

Core FHIR Resource
CareTeam
Reference Policy
`literal`
Interaction summary

- MAY support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a CareTeam that is the intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved CareTeams that are the intended performer of ServiceRequests.

Supported Profiles

US Core CareTeam Profileversion: 7.0.0)

Documentation

> Used to allow downstream systems to access to information about the intended performer of a ServiceRequest when the performer is a specific team of people

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLCondition

Core FHIR Resource
Condition
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a Condition that is the requester or performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Conditions that are referenced by ServiceRequests.

- MAY support
  `create`

  Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `update`

  Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

Supported Profiles

SDOHCC Condition

Documentation

> Used to allow downstream systems to access to information about a patient's SDOH-related conditions, particularly those that are the reason for a referral

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering to only SDOH-related conditions
SHALL | patient | `reference` | Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | clinical-status | `token` | Allows filtering to only active conditions
SHOULD | code | `token` | Allows filtering to only specific SDOH conditions or sets of conditions
SHOULD | verification-status | `token` | Allows filtering to exclude refuted or entered-in-error conditions

##### Resource Conformance: SHALLConsent

Core FHIR Resource
Consent
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Consents related to ServiceRequests of interest.

- MAY support
  `create`

  Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `update`

  Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

Supported Profiles

SDOHCC Consent

Documentation

> Used to allow access to the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | source-reference | `reference` | Allows including the document that contains the PDF or similar representation of a paper consent
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLDevice

Core FHIR Resource
Device
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a Device that is the requester or intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Devices that are the requester or intended performer of ServiceRequests.

Supported Profiles

Device

Documentation

> Used to allow retrieval of the requester or intended performer of an SDOH ServiceRequest

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLDocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
`literal`
Interaction summary

- SHALL support
  `create`

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

  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a PDF or similar content referenced by a Consent or Task.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.

- SHOULD support
  `update`

  Allows the system to revise a previously stored PDF

Supported Profiles

US Core DocumentReference Profileversion: 7.0.0)

Documentation

> Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLGoal

Core FHIR Resource
Goal
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a goal referenced by a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Goals in the event they are updated.

- MAY support
  `create`

  Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `update`

  Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

Supported Profiles

SDOHCC Goal

Documentation

> Used to allow access to goals related to an SDOH referral

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering to only include SDOH-related goals
SHALL | patient | `reference` | Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | achievement-status | `token` | Allows filtering to only include unmet goals
SHOULD | lifecycle-status | `token` | Allows filtering to only include active goals
SHOULD | target-date | `date` | Allows filtering based on when a particular goal is desired to be achieved

##### Resource Conformance: SHALLGroup

Core FHIR Resource
Group
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows a payer or other oversight agency to a Group whose identity is already known (e.g. for polling).

  `search-type`

  Allows a payer or oversight agency to search for groups of interest to allow monitoring of what patients are under care/management for SDOH issues.

Supported Profiles

SDOHCC Group

Documentation

> Exposes information about which patients associated with a particular payor coverage type currently have SDOH concerns under management

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Group records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | code | `token` | Allows filtering based on the type of group
SHALL | member | `reference` | Allows performing an _include to retrieve the members of the group
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | characteristic-value | `composite` | Allows filtering based on the insurer or plan associated with the group
SHOULD | managing-entity | `reference` | Allows filtering based on who is maintaining the group

##### Resource Conformance: SHALLHealthcareService

Core FHIR Resource
HealthcareService
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a HealthcareService that is the intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.

Supported Profiles

SDOHCC Healthcare Service

Documentation

> Used to allow downstream systems to access to 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.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | location | `reference` | Allows retrieval of the phyical site(s) associated with a HealthService
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLLocation

Core FHIR Resource
Location
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `read`

  Allows other systems to retrieve a Location that is an available location for a service.

- MAY support
  `search-type`

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

Supported Profiles

SDOHCC Location

Documentation

> Used to expose 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.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLObservation

Core FHIR Resource
Observation
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve an Observation referenced by a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Observations for updates/corrections.

- MAY support
  `create`

  Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `update`

  Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

Supported Profiles

SDOHCC Observation Assessment
SDOHCC Observation Screening Response

Documentation

> Used to allow downstream systems to access to information about SDOH-related observations for a patient - particularly those that are reasons for a referral

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering for only SDOH-related observations
SHALL | patient | `reference` | Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific
SHALL | status | `token` | Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | code | `token` | Allows filtering for specific types of observations
SHOULD | date | `date` | Allows filtering for observations that held in a particular time period
SHOULD | derived-from | `reference` | Allows filtering for observations derived from a particular QuestionnaireResponse
MAY | code-value-concept | `composite` | Allows filtering for observations that have a specific coded value answer for a specified observation type

##### Resource Conformance: SHALLOrganization

Core FHIR Resource
Organization
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve an Organization that is the requester or intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.

Supported Profiles

US Core Organization Profileversion: 7.0.0)

Documentation

> Used to allow downstream systems to access to information about an Organization that is the requester or intended performer of a ServiceRequest

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLPatient

Core FHIR Resource
Patient
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve the Patient that is the subject of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Patients.

Supported Profiles

US Core Patient Profileversion: 7.0.0)

Documentation

> Used to allow downstream systems to access to information about the Patient that is the subject a ServiceRequest

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLPractitioner

Core FHIR Resource
Practitioner
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.

Supported Profiles

US Core Practitioner Profileversion: 7.0.0)

Documentation

> Used to allow downstream systems to access to information about an Practitioner that is the requester or intended performer of a ServiceRequest

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLPractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.

Supported Profiles

SDOHCC PractitionerRole

Documentation

> Used to allow downstream systems to access to information about an PractitionerRole that is the requester or intended performer of a ServiceRequest

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | organization | `reference` | Allows doing an _include on Organization when retrieving the PractitionerRole
SHOULD | practitioner | `reference` | Allows doing an _include on Practitioner when retrieving the PractitionerRole

##### Resource Conformance: SHALLProcedure

Core FHIR Resource
Procedure
Reference Policy
`literal`
Interaction summary

- SHALL support
  `create`

  Allows downstream coordination platforms and referral recipients to write records of procedures done in response to a referral in situations where they can't store the procedure on their own local system.

  `update`

  Allows downstream coordination platforms and referral recipients to update records of procedures done - e.g. changing status, adding notes.

  `read`

  Allows upstream systems to retrieve procedures referenced by Tasks.

  `search-type`

  Allows upstream systems to check for updates on Procedures after they've already been received or to look for procedures that haven't yet been linked as outputs to the Tasks that initiated the work.

Supported Profiles

SDOHCC Procedure

Documentation

> Used to allow downstream coordination platforms and referral recipients to provide information about actions that have been performed as a result of a referral as well as to allow upstream systems to access that information.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | based-on | `reference` | Allows filtering for procedures resulting from a particular service request
SHALL | category | `token` | Allows filtering for procedures that are SDOH-related
SHALL | patient | `reference` | Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.
SHALL | performer | `reference` | Allows filtering for procedures based on who delivered the procedure.
SHALL | status | `token` | Allows filtering for procedures that are complete or in progress
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | code | `token` | Allows filtering for procedures based on the specific service delivered
SHOULD | date | `date` | Allows filtering for procedures based on when they were delivered

##### Resource Conformance: SHALLQuestionnaire

Core FHIR Resource
Questionnaire
Reference Policy
`literal`
Interaction summary

- MAY support
  `search-type`

  Allows SMART apps or downstream systems to search for questionnaires relevant to a patient context.

Supported Profiles

Extractable Questionnaire - StructureMap

Documentation

> Used to allow retrieval of SDOH-related Questionnaires to be filled out by a patient or representative. Also allows retrieving Questionnaires associated with existing QuestionnaireResponses for editing by SMART-on-FHIR apps.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | url | `uri` | Allows retrieving Questionnaires based on its canonical URL
SHALL | version | `token` | Allows retrieving a specific version of a Questionnaire
SHOULD | code | `token` | Allows filtering for questionnaires associated with particular LOINC or similar codes
SHOULD | context-type-value | `composite` | Allows filtering for procedures that are SDOH-related
SHOULD | identifier | `token` | Allows retrieving Questionnaires with a known identifier
SHOULD | publisher | `string` | Allows retrieving Questionnaires based on who is responsible for them
SHOULD | status | `token` | Allows retrieving Questionnaires that are active (and not draft or required)
SHOULD | subject-type | `token` | Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc.
SHOULD | title | `string` | Allows retrieving Questionnaires based on the name of the form

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
MAY | $populate | Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere

##### Resource Conformance: SHALLQuestionnaireResponse

Core FHIR Resource
QuestionnaireResponse
Reference Policy
`literal`
Interaction summary

- SHOULD support
  `create`

  Allows questionnaire responses to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `update`

  Allows questionnaire responses to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `read`

  Allows the retrieval of QuestionnaireResponses to use as a starting point for new responses or to continue editing.

  `search-type`

  Allows checking for updates in previously retrieved QuestionnaireResponses.

Supported Profiles

SDC Questionnaire Response

Documentation

> Used to allow SMART apps to cread, update and retrieve QuestionnaireResponses relevant to SDOH care

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | author | `reference` | Allows filtering QuestionnaireResponses previously created/edited by a particular individual
SHALL | patient | `reference` | Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific
SHALL | questionnaire | `reference` | Allows retrieving QuestionnaireResponses that have been completed against a specified form
SHALL | status | `token` | Allows retrieving QuestionnaireResponses that are complete (or incomplete)
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | authored | `date` | Allows filtering for QuestionnaireResponses by when they were created/last edited

##### Resource Conformance: SHALLRelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
`literal`
Interaction summary

- MAY support
  `read`

  Allows downstream coordination platforms or referral recipients to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.

  `search-type`

  Allows downstream coordination platforms or referral recipients to monitor previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.

Supported Profiles

RelatedPerson

Documentation

> Used to allow downstream systems to access to information about the requester or intended performer of a ServiceRequest when they are someone with a personal relationship to the Patient

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

##### Resource Conformance: SHALLServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
`literal`
Interaction summary

- SHALL support
  `read`

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

  `search-type`

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

- MAY support
  `create`

  Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

  `update`

  Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface.

Supported Profiles

SDOHCC ServiceRequest

Documentation

> Used to allow retrieval of an order for SDOH-related services

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | category | `token` | Allows filtering to only retrieve ServiceRequests that are SDOH-related
SHALL | intent | `token` | Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.
SHALL | patient | `reference` | Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific
SHALL | status | `token` | Allows filtering to retrieve only active ServiceRequests
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | code | `token` | Allows filtering to retrieve ServiceRequests for specific types of services
SHOULD | occurrence | `date` | Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided
SHOULD | performer | `reference` | Allows filtering to retrieve only ServiceRequests that designate a specific performer
SHOULD | requester | `reference` | Allows filtering to retrieve only ServiceRequests created by a specific practitioner
SHOULD | supporting-info | `reference` | Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent

##### Resource Conformance: SHOULDSubscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary

- SHOULD support
  `create`

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

- MAY support
  `update`

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

Supported Profiles

R4/B Topic-Based Subscription

Documentation

> Used to allow downstream (and occasionally upstream) systems to subscribe to and monitor changes to Tasks stored on this system

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHOULD | $status | Allows upstream systems to verify their subscription is functioning properly and to check for errors

##### Resource Conformance: SHALLTask

Core FHIR Resource
Task
Reference Policy
`literal`
Interaction summary

- SHALL support
  `create`

  Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or an action to be performed by a patient or caregiver.

  `update`

  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). Servers SHALL enforce appropriate permissions on systems with respect to updates. Specifically, only authors of a Task have authority to update all aspects of the Task. (Systems MAY limit what changes can be made to tasks that have been accepted or completed.) Assigned task owners may change the status, statusReason and outputs. Users who are neither the author or owner of a Task cannot make changes to it.

  `read`

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

  `search-type`

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

Supported Profiles

SDOHCC Task For Patient
SDOHCC Task For Referral Management

Documentation

> Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests or for actions to be performed by a patient. Also used by downstream referral recipients 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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates
SHALL | code | `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.
SHALL | patient | `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.)
SHALL | requester | `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
SHALL | status | `token` | Allows filtering to only active or completed tasks
SHALL | focus | `reference` | Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query
SHOULD | owner | `reference` | Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)
SHOULD | output | `reference` | Allows for the 'output' of a Task to be included when retrieving a Task