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

This page is part of the SDOH Clinical Care for Multiple Domains (v2.2.0: STU 2.2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: SDOHCC Patient Application

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-PatientApp Version: 2.2.0
Standards status: Trial-use Computable Name: SDOHCC_PatientApp

This resource describes the required and desired behavior of systems acting as apps for patients and care-givers who need to monitor progress on SDOH referrals and may need to take actions such as filling out forms, booking appointments, etc.

These systems will not expose their own FHIR interfaces, but will monitor information available from other FHIR servers - be it referral sources, coordination platforms or referral recipients. They will primarily monitor and update Task resources as well as the resources referenced by those Tasks.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement SDOHCC-PatientApp

SDOHCC Patient Application

  • 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

Mode: client

Patient apps query for data relevant to the current patient, post updates as appropriate and occasionally create new resources, such as QuestionnaireResponses

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
ObservationSupported Profiles
  SDOHCC Observation Assessment
  SDOHCC Observation Screening Response
yy_id, _lastUpdated, category, code, patient
ConsentSupported Profiles
  SDOHCC Consent
yy_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
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
PractitionerSupported Profiles
  US Core Practitioner Profile
yy_id, _lastUpdated
PractitionerRoleSupported Profiles
  US Core PractitionerRole Profile
yy_id, _lastUpdated, organization, practitionerPractitionerRole:organization, PractitionerRole:practitioner
QuestionnaireSupported Profiles
  Extractable Questionnaire - StructureMap
yurl, 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
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
TaskSupported Profiles
  SDOHCC Task For Patient
  SDOHCC Task For Referral Management
yyy_id, _lastUpdated, code, owner, patient, requester, status, focus, outputTask:output

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 Observation

Core FHIR Resource
Observation
Reference Policy
literal
Interaction summary
  • SHALLsupport read, search-type.

Documentation

Allows patients and caregivers to see observations recorded by their care providers, including those referenced by other resources

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 to only SDOH-related observations

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 been created or changed since last query

SHOULDcodetoken

Allows filtering to only specific SDOH observation types

 

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
  • SHALLsupport create, read.
  • SHOULDsupport update, 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
  • SHALLsupport read.
  • MAYsupport search-type.

Documentation

Allows patient apps to retrieve information about who should be contacted (to book an appointment or for other reasons)

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 Practitioner

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

Documentation

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

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 Questionnaire

Core FHIR Resource
Questionnaire
Reference Policy
literal
Interaction summary
  • SHALLsupport 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

 
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
  • SHALLsupport create, read.
  • SHOULDsupport update, search-type.

Documentation

Used to allow QuestionnaireResponses to be created and updated by a patient or caregiver and work-in-progress responses to be retrieved

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 access information about the requester or intended performer of a ServiceRequest or Task 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: SHALL Task

Core FHIR Resource
Task
Reference Policy
literal
Interaction summary
  • SHALLsupport update, search-type.
  • MAYsupport read.

Documentation

Allows the patient or caregiver to monitor and update for Task assigned by referral sources or coordination platforms. Also allows the update and monitoring of tasks assigned to patients and caregivers.

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