SDOH Clinical Care
2.2.0 - STU 2.2 United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. 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: 2.2.0
Standards status: Trial-use 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.

Because systems that originate requests for service may sometimes also be recipients of requests for service, the requirements include ‘SHOULD’ expectations to also accept and process requests from other systems. The referral source may either interact directly with a Referral Recipient or will interact through an intermediary Coordination Platform. Responsibilities of Referral Sources include capturing information from a patient in the form of QuestionnaireResponses, Observations, Conditions and Goals as well as creating the ServiceRequest instances that refer patients for needed services and the Tasks that initiate fulfillment of those referrals.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement SDOHCC-ReferralSource

SDOHCC Referral Source

  • Implementation Guide Version: 2.2.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • 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
  • SHOULDSupports the batchinteraction 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 TypeProfileRSUCSearches_include_revincludeOperations
CareTeamSupported Profiles
  US Core CareTeam Profile
yy_id, _lastUpdated
ConditionSupported Profiles
  SDOHCC Condition
yy_id, _lastUpdated, category, clinical-status, code, patient, verification-status
ConsentSupported Profiles
  SDOHCC Consent
yy_id, _lastUpdated, source-referenceConsent:source-reference:DocumentReference
DeviceSupported Profiles
  Device
yy_id, _lastUpdated
DocumentReferenceSupported Profiles
  US Core DocumentReference Profile
yy_id, _lastUpdated
GoalSupported Profiles
  SDOHCC Goal
yy_id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date
HealthcareServiceSupported Profiles
  SDOHCC Healthcare Service
yy_id, _lastUpdated, location
LocationSupported Profiles
  SDOHCC Location
yy_id, _lastUpdated
ObservationSupported 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
yy_id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status
OrganizationSupported Profiles
  US Core Organization Profile
yy_id, _lastUpdated
PatientSupported Profiles
  US Core Patient Profile
yy_id, _lastUpdated
PractitionerSupported Profiles
  US Core Practitioner Profile
yy_id, _lastUpdated
PractitionerRoleSupported Profiles
  US Core PractitionerRole Profile
yy_id, _lastUpdated, organization, practitionerPractitionerRole:organization, PractitionerRole:practitioner
ProcedureSupported Profiles
  SDOHCC Procedure
yy_id, _lastUpdated, based-on, category, code, date, patient, performer, status
QuestionnaireSupported Profiles
  Extractable Questionnaire - StructureMap
ycode, context-type-value, identifier, publisher, status, subject-type, title, url, version$populate
QuestionnaireResponseSupported Profiles
  SDC Questionnaire Response
yy_id, _lastUpdated, author, authored, patient, questionnaire, status
RelatedPersonSupported Profiles
  RelatedPerson
yy_id, _lastUpdated
ServiceRequestSupported Profiles
  SDOHCC ServiceRequest
yy_id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-infoHealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization
SubscriptionSupported Profiles
  Backported R5 Subscription
yy$status, $topic-list
TaskSupported Profiles
  SDOHCC Task For Patient
  SDOHCC Task For Referral Management
yyyy_id, _lastUpdated, code, owner, patient, requester, status, focus, outputTask:focus, Task:output, HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization

Resource Conformance: SHALL CareTeam
Core FHIR Resource
CareTeam
Reference Policy
literal
Interaction summary
  • MAYsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Condition
Core FHIR Resource
Condition
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering to only SDOH-related conditions

SHALLpatientreference

Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDclinical-statustoken

Allows filtering to only active conditions

SHOULDcodetoken

Allows filtering to only specific SDOH conditions or sets of conditions

SHOULDverification-statustoken

Allows filtering to exclude refuted or entered-in-error conditions

 
Resource Conformance: SHALL Consent
Core FHIR Resource
Consent
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDsource-referencereference

Allows including the document that contains the PDF or similar representation of a paper consent

 
Resource Conformance: SHALL Device
Core FHIR Resource
Device
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL DocumentReference
Core FHIR Resource
DocumentReference
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Goal
Core FHIR Resource
Goal
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

Documentation

Used to access goals related to an SDOH referral

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering to only include SDOH-related goals

SHALLpatientreference

Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDachievement-statustoken

Allows filtering to only include unmet goals

SHOULDlifecycle-statustoken

Allows filtering to only include active goals

SHOULDtarget-datedate

Allows filtering based on when a particular goal is desired to be achieved

 
Resource Conformance: SHALL HealthcareService
Core FHIR Resource
HealthcareService
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLlocationreference

Allows retrieval of the phyical site(s) associated with a HealthService

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Location
Core FHIR Resource
Location
Reference Policy
literal
Interaction summary
  • SHOULDsupport read.
  • MAYsupport search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Observation
Core FHIR Resource
Observation
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering for only SDOH-related observations

SHALLpatientreference

Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcodetoken

Allows filtering for specific types of observations

SHOULDdatedate

Allows filtering for observations that held in a particular time period

SHOULDderived-fromreference

Allows filtering for observations derived from a particular QuestionnaireResponse

SHOULDstatustoken

Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)

MAYcode-value-conceptcomposite

Allows filtering for observations that have a specific coded value answer for a specified observation type

 
Resource Conformance: SHALL Organization
Core FHIR Resource
Organization
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Patient
Core FHIR Resource
Patient
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Practitioner
Core FHIR Resource
Practitioner
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL PractitionerRole
Core FHIR Resource
PractitionerRole
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDorganizationreference

Allows doing an _include on Organization when retrieving the PractitionerRole

SHOULDpractitionerreference

Allows doing an _include on Practitioner when retrieving the PractitionerRole

 
Resource Conformance: SHALL Procedure
Core FHIR Resource
Procedure
Reference Policy
literal
Interaction summary
  • SHALLsupport read.
  • SHOULDsupport search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLbased-onreference

Allows filtering for procedures resulting from a particular service request

SHALLcategorytoken

Allows filtering for procedures that are SDOH-related

SHALLpatientreference

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

SHALLperformerreference

Allows filtering for procedures based on who delivered the procedure.

SHALLstatustoken

Allows filtering for procedures that are complete or in progress

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcodetoken

Allows filtering for procedures based on the specific service delivered

SHOULDdatedate

Allows filtering for procedures based on when they were delivered

 
Resource Conformance: SHALL Questionnaire
Core FHIR Resource
Questionnaire
Reference Policy
literal
Interaction summary
  • SHOULDsupport search-type.

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
ConformanceParameterTypeDocumentation
SHALLurluri

Allows retrieving Questionnaires based on its canonical URL

SHALLversiontoken

Allows retrieving a specific version of a Questionnaire

SHOULDcodetoken

Allows filtering for questionnaires associated with particular LOINC or similar codes

SHOULDcontext-type-valuecomposite

Allows filtering for procedures that are SDOH-related

SHOULDidentifiertoken

Allows retrieving Questionnaires with a known identifier

SHOULDpublisherstring

Allows retrieving Questionnaires based on who is responsible for them

SHOULDstatustoken

Allows retrieving Questionnaires that are active (and not draft or required)

SHOULDsubject-typetoken

Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc.

SHOULDtitlestring

Allows retrieving Questionnaires based on the name of the form

 
Extended Operations
ConformanceOperationDocumentation
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: SHALL QuestionnaireResponse
Core FHIR Resource
QuestionnaireResponse
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

Documentation

Used to allow QuestionnaireResponses referenced by a ServiceRequest or Task

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLauthorreference

Allows filtering QuestionnaireResponses previously created/edited by a particular individual

SHALLpatientreference

Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific

SHALLquestionnairereference

Allows retrieving QuestionnaireResponses that have been completed against a specified form

SHALLstatustoken

Allows retrieving QuestionnaireResponses that are complete (or incomplete)

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDauthoreddate

Allows filtering for QuestionnaireResponses by when they were created/last edited

 
Resource Conformance: SHALL RelatedPerson
Core FHIR Resource
RelatedPerson
Reference Policy
literal
Interaction summary
  • MAYsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL ServiceRequest
Core FHIR Resource
ServiceRequest
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering to only retrieve ServiceRequests that are SDOH-related

SHALLintenttoken

Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.

SHALLpatientreference

Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific

SHALLstatustoken

Allows filtering to retrieve only active ServiceRequests

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcodetoken

Allows filtering to retrieve ServiceRequests for specific types of services

SHOULDoccurrencedate

Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided

SHOULDperformerreference

Allows filtering to retrieve only ServiceRequests that designate a specific performer

SHOULDrequesterreference

Allows filtering to retrieve only ServiceRequests created by a specific practitioner

SHOULDsupporting-inforeference

Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent

 
Resource Conformance: SHOULD Subscription
Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • SHOULDsupport create.
  • MAYsupport update.

Documentation

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

Extended Operations
ConformanceOperationDocumentation
SHOULD$status

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

MAY$topic-list

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.

Resource Conformance: SHALL Task
Core FHIR Resource
Task
Reference Policy
literal
Interaction summary
  • SHALLsupport create, update, read.
  • SHOULDsupport search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcodetoken

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.

SHALLpatientreference

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

SHALLrequesterreference

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

SHALLstatustoken

Allows filtering to only active or completed tasks

SHALLfocusreference

Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDownerreference

Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)

SHOULDoutputreference

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
  • SHOULDSupports the batchinteraction 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 TypeProfileRSUCSearches_include_revincludeOperations
CareTeamSupported Profiles
  US Core CareTeam Profile
yy_id, _lastUpdated
ConditionSupported Profiles
  SDOHCC Condition
yyyy_id, _lastUpdated, category, clinical-status, code, patient, verification-status
ConsentSupported Profiles
  SDOHCC Consent
yyyy_id, _lastUpdated, source-referenceConsent:source-reference:DocumentReference
DeviceSupported Profiles
  Device
yy_id, _lastUpdated
DocumentReferenceSupported Profiles
  US Core DocumentReference Profile
yyyy_id, _lastUpdated
GoalSupported Profiles
  SDOHCC Goal
yyyy_id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date
GroupSupported Profiles
  SDOHCC Group
yy_id, _lastUpdated, characteristic-value, code, managing-entity, memberGroup:member
HealthcareServiceSupported Profiles
  SDOHCC Healthcare Service
yy_id, _lastUpdated, location
LocationSupported Profiles
  SDOHCC Location
yy_id, _lastUpdated
ObservationSupported Profiles
  SDOHCC Observation Assessment
  SDOHCC Observation Screening Response
yyyy_id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status
OrganizationSupported Profiles
  US Core Organization Profile
yy_id, _lastUpdated
PatientSupported Profiles
  US Core Patient Profile
yy_id, _lastUpdated
PractitionerSupported Profiles
  US Core Practitioner Profile
yy_id, _lastUpdated
PractitionerRoleSupported Profiles
  US Core PractitionerRole Profile
yy_id, _lastUpdated, organization, practitionerPractitionerRole:organization, PractitionerRole:practitioner
ProcedureSupported Profiles
  SDOHCC Procedure
yyyy_id, _lastUpdated, based-on, category, code, date, patient, performer, status
QuestionnaireSupported Profiles
  Extractable Questionnaire - StructureMap
ycode, context-type-value, identifier, publisher, status, subject-type, title, url, version$populate
QuestionnaireResponseSupported Profiles
  SDC Questionnaire Response
yyyy_id, _lastUpdated, author, authored, patient, questionnaire, status
RelatedPersonSupported Profiles
  RelatedPerson
yy_id, _lastUpdated
ServiceRequestSupported Profiles
  SDOHCC ServiceRequest
yyyy_id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-infoHealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization
SubscriptionSupported Profiles
  Backported R5 Subscription
yy$status, $topic-list
TaskSupported Profiles
  SDOHCC Task For Patient
  SDOHCC Task For Referral Management
yyyy_id, _lastUpdated, code, owner, patient, requester, status, focus, outputTask:focus, Task:output, HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization

Resource Conformance: SHALL CareTeam
Core FHIR Resource
CareTeam
Reference Policy
literal
Interaction summary
  • MAYsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Condition
Core FHIR Resource
Condition
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.
  • MAYsupport create, update.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering to only SDOH-related conditions

SHALLpatientreference

Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDclinical-statustoken

Allows filtering to only active conditions

SHOULDcodetoken

Allows filtering to only specific SDOH conditions or sets of conditions

SHOULDverification-statustoken

Allows filtering to exclude refuted or entered-in-error conditions

 
Resource Conformance: SHALL Consent
Core FHIR Resource
Consent
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.
  • MAYsupport create, update.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLsource-referencereference

Allows including the document that contains the PDF or similar representation of a paper consent

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Device
Core FHIR Resource
Device
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL DocumentReference
Core FHIR Resource
DocumentReference
Reference Policy
literal
Interaction summary
  • SHALLsupport create, read, search-type.
  • SHOULDsupport update.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Goal
Core FHIR Resource
Goal
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.
  • MAYsupport create, update.

Documentation

Used to allow access to goals related to an SDOH referral

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering to only include SDOH-related goals

SHALLpatientreference

Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDachievement-statustoken

Allows filtering to only include unmet goals

SHOULDlifecycle-statustoken

Allows filtering to only include active goals

SHOULDtarget-datedate

Allows filtering based on when a particular goal is desired to be achieved

 
Resource Conformance: SHALL Group
Core FHIR Resource
Group
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Group records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcodetoken

Allows filtering based on the type of group

SHALLmemberreference

Allows performing an _include to retrieve the members of the group

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcharacteristic-valuecomposite

Allows filtering based on the insurer or plan associated with the group

SHOULDmanaging-entityreference

Allows filtering based on who is maintaining the group

 
Resource Conformance: SHALL HealthcareService
Core FHIR Resource
HealthcareService
Reference Policy
literal
Interaction summary
  • SHOULDsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLlocationreference

Allows retrieval of the phyical site(s) associated with a HealthService

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Location
Core FHIR Resource
Location
Reference Policy
literal
Interaction summary
  • SHOULDsupport read.
  • MAYsupport search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Observation
Core FHIR Resource
Observation
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.
  • MAYsupport create, update.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering for only SDOH-related observations

SHALLpatientreference

Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific

SHALLstatustoken

Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcodetoken

Allows filtering for specific types of observations

SHOULDdatedate

Allows filtering for observations that held in a particular time period

SHOULDderived-fromreference

Allows filtering for observations derived from a particular QuestionnaireResponse

MAYcode-value-conceptcomposite

Allows filtering for observations that have a specific coded value answer for a specified observation type

 
Resource Conformance: SHALL Organization
Core FHIR Resource
Organization
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Patient
Core FHIR Resource
Patient
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL Practitioner
Core FHIR Resource
Practitioner
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL PractitionerRole
Core FHIR Resource
PractitionerRole
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDorganizationreference

Allows doing an _include on Organization when retrieving the PractitionerRole

SHOULDpractitionerreference

Allows doing an _include on Practitioner when retrieving the PractitionerRole

 
Resource Conformance: SHALL Procedure
Core FHIR Resource
Procedure
Reference Policy
literal
Interaction summary
  • SHALLsupport create, update, read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLbased-onreference

Allows filtering for procedures resulting from a particular service request

SHALLcategorytoken

Allows filtering for procedures that are SDOH-related

SHALLpatientreference

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

SHALLperformerreference

Allows filtering for procedures based on who delivered the procedure.

SHALLstatustoken

Allows filtering for procedures that are complete or in progress

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcodetoken

Allows filtering for procedures based on the specific service delivered

SHOULDdatedate

Allows filtering for procedures based on when they were delivered

 
Resource Conformance: SHALL Questionnaire
Core FHIR Resource
Questionnaire
Reference Policy
literal
Interaction summary
  • MAYsupport search-type.

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
ConformanceParameterTypeDocumentation
SHALLurluri

Allows retrieving Questionnaires based on its canonical URL

SHALLversiontoken

Allows retrieving a specific version of a Questionnaire

SHOULDcodetoken

Allows filtering for questionnaires associated with particular LOINC or similar codes

SHOULDcontext-type-valuecomposite

Allows filtering for procedures that are SDOH-related

SHOULDidentifiertoken

Allows retrieving Questionnaires with a known identifier

SHOULDpublisherstring

Allows retrieving Questionnaires based on who is responsible for them

SHOULDstatustoken

Allows retrieving Questionnaires that are active (and not draft or required)

SHOULDsubject-typetoken

Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc.

SHOULDtitlestring

Allows retrieving Questionnaires based on the name of the form

 
Extended Operations
ConformanceOperationDocumentation
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: SHALL QuestionnaireResponse
Core FHIR Resource
QuestionnaireResponse
Reference Policy
literal
Interaction summary
  • SHOULDsupport create, update, read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLauthorreference

Allows filtering QuestionnaireResponses previously created/edited by a particular individual

SHALLpatientreference

Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific

SHALLquestionnairereference

Allows retrieving QuestionnaireResponses that have been completed against a specified form

SHALLstatustoken

Allows retrieving QuestionnaireResponses that are complete (or incomplete)

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDauthoreddate

Allows filtering for QuestionnaireResponses by when they were created/last edited

 
Resource Conformance: SHALL RelatedPerson
Core FHIR Resource
RelatedPerson
Reference Policy
literal
Interaction summary
  • MAYsupport read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

 
Resource Conformance: SHALL ServiceRequest
Core FHIR Resource
ServiceRequest
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.
  • MAYsupport create, update.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcategorytoken

Allows filtering to only retrieve ServiceRequests that are SDOH-related

SHALLintenttoken

Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.

SHALLpatientreference

Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific

SHALLstatustoken

Allows filtering to retrieve only active ServiceRequests

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDcodetoken

Allows filtering to retrieve ServiceRequests for specific types of services

SHOULDoccurrencedate

Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided

SHOULDperformerreference

Allows filtering to retrieve only ServiceRequests that designate a specific performer

SHOULDrequesterreference

Allows filtering to retrieve only ServiceRequests created by a specific practitioner

SHOULDsupporting-inforeference

Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent

 
Resource Conformance: SHOULD Subscription
Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • SHOULDsupport create.
  • MAYsupport update.

Documentation

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

Extended Operations
ConformanceOperationDocumentation
SHOULD$status

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

MAY$topic-list

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.

Resource Conformance: SHALL Task
Core FHIR Resource
Task
Reference Policy
literal
Interaction summary
  • SHALLsupport create, update, read, search-type.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates

SHALLcodetoken

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.

SHALLpatientreference

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

SHALLrequesterreference

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

SHALLstatustoken

Allows filtering to only active or completed tasks

SHALLfocusreference

Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

SHOULDownerreference

Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)

SHOULDoutputreference

Allows for the 'output' of a Task to be included when retrieving a Task