SDOHCC Coordination Platform

• Official URL:http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-CoordinationPlatform
• Implementation Guide Version: None
• FHIR Version: 4.0.1
• Intended Use: Requirements
• Supported Formats: XML, JSON
• Published: 2021-06
• Published by: None
• Status: Draft

This resource describes the required and desired behavior of systems acting as SDOH clinical care 'coordination platforms' (CPs).

CPs are intermediaries who take on responsibility for managing SDOH referrals and ensuring they are executed by appropriate service delivery organizations. These systems must respond to referral fulfillment Tasks received from Clinical Care Referral Sources and also the initiation and management of referral fulfillment Tasks subsequently directed out to Referral Recipients. They may also take on some of the diagnostic work, including having patients or care-givers complete questionnaires, extract relevant observations and preliminary findings and work with patients to define goals.

FHIR Client RESTful Capabilities

The clinical care coordinator needs to receive information from and update information in SDOH clinical care referral sources.

Security:

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

Summary of Client Wide Interactions

• SHOULD support the batch^† interaction.

batch^†

Allows polling for changes to multiple resource types simultaneously

RESTful Capabilities by Resource/Profile:

Summary

♦ = SHALL expectation;⋄ = SHOULD expectation;▿ = MAY expectation;

Resource Type	Supported Interactions	Supported Profiles	Supported Searches	Supported _includes	Supported _revincludes	Supported Operations
CareTeam	read▿, search-type▿	US Core CareTeam Profile♦	_id♦, _lastUpdated⋄
Condition	read♦, search-type⋄	SDOHCC Condition♦	_id♦, _lastUpdated⋄, category♦, clinical-status⋄, code⋄, patient♦, verification-status⋄
Consent	read♦, search-type⋄	SDOHCC Consent♦	_id♦, _lastUpdated⋄, source-reference♦	Consent:source-reference:DocumentReference⋄
Device	read⋄, search-type⋄	FHIR Device♦	_id♦, _lastUpdated♦
DocumentReference	read♦, search-type⋄	US Core DocumentReference Profile♦	_id♦, _lastUpdated⋄
Goal	read♦, search-type⋄	SDOHCC Goal♦	_id♦, _lastUpdated⋄, achievement-status⋄, category♦, lifecycle-status⋄, patient♦, target-date⋄
HealthcareService	read⋄, search-type⋄	SDOHCC Healthcare Service♦	_id♦, _lastUpdated⋄, location♦
Location	read⋄, search-type▿	SDOHCC Location♦	_id♦, _lastUpdated⋄
Observation	read♦, search-type⋄	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▿	_id♦, _lastUpdated⋄, category♦, code⋄, code-value-concept▿, date⋄, derived-from⋄, patient♦, status♦
Organization	read♦, search-type⋄	US Core Organization Profile♦	_id♦, _lastUpdated⋄
Patient	read♦, search-type⋄	US Core Patient Profile♦	_id♦, _lastUpdated⋄
Practitioner	read♦, search-type⋄	US Core Practitioner Profile♦	_id♦, _lastUpdated⋄
PractitionerRole	read♦, search-type⋄	US Core PractitionerRole Profile♦	_id♦, _lastUpdated⋄, organization⋄, practitioner⋄	PractitionerRole:organization⋄, PractitionerRole:practitioner⋄
Procedure	create♦, update♦, read♦, search-type⋄	SDOHCC Procedure♦	_id♦, _lastUpdated⋄, based-on♦, category♦, code⋄, date⋄, patient♦, performer♦, status♦
Questionnaire	search-type⋄	Extractable Questionnaire - StructureMap♦	code⋄, context-type-value⋄, identifier⋄, publisher⋄, status⋄, subject-type⋄, title⋄, url♦, version♦			$populate▿
QuestionnaireResponse	read⋄, search-type⋄	SDC Questionnaire Response♦	_id♦, _lastUpdated⋄, author♦, authored⋄, patient♦, questionnaire♦, status♦
RelatedPerson	read▿, search-type▿	FHIR RelatedPerson♦	_id♦, _lastUpdated⋄
ServiceRequest	read♦, search-type⋄	SDOHCC ServiceRequest♦	_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	create⋄, update▿	R4/B Topic-Based Subscription♦				$status⋄, $topic-list▿
Task	create♦, update♦, read♦, search-type⋄	SDOHCC Task For Patient♦, SDOHCC Task For Referral Management♦	_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⋄

CareTeam

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core CareTeam Profile

Reference Policy: literal

Profile Interaction Summary:

• MAY support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client MAY be capable of fetching a CareTeam resource using:GET [base]/CareTeam/[id]
• A Client MAY be capable of fetching resources matching a search query using:GET [base]/CareTeam/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/CareTeam?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/CareTeam?_lastUpdated=[dateTime]

Condition

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDOHCC Condition

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Condition resource using:GET [base]/Condition/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Condition?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Condition?_lastUpdated=[dateTime]
SHALL	category	token	GET [base]/Condition?category=[system]|[code]
SHOULD	clinical-status	token	GET [base]/Condition?clinical-status=[system]|[code]
SHOULD	code	token	GET [base]/Condition?code=[system]|[code]
SHALL	patient	reference	GET [base]/Condition?patient=[type]/[id]
SHOULD	verification-status	token	GET [base]/Condition?verification-status=[system]|[code]

Consent

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDOHCC Consent

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Consent resource using:GET [base]/Consent/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Consent/[id]{?[parameters]{&_format=[mime-type]}}
• A Client SHOULD be capable of supporting the following _includes:
  • Consent:source-reference:DocumentReference - GET [base]/Consent?[parameter=value]&_include=Consent:source-reference:DocumentReference

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Consent?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Consent?_lastUpdated=[dateTime]
SHALL	source-reference	reference	GET [base]/Consent?source-reference=[type]/[id]

Device

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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

Supported Profiles:

• SHALL support:(http://hl7.org/fhir/StructureDefinition/Device)

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a Device resource using:GET [base]/Device/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Device/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Device?_id=[id]
SHALL	_lastUpdated	date	GET [base]/Device?_lastUpdated=[dateTime]

DocumentReference

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core DocumentReference Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a DocumentReference resource using:GET [base]/DocumentReference/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/DocumentReference?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/DocumentReference?_lastUpdated=[dateTime]

Goal

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to access goals related to an SDOH referral

Supported Profiles:

• SHALL support:SDOHCC Goal

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Goal resource using:GET [base]/Goal/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Goal/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Goal?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Goal?_lastUpdated=[dateTime]
SHOULD	achievement-status	token	GET [base]/Goal?achievement-status=[system]|[code]
SHALL	category	token	GET [base]/Goal?category=[system]|[code]
SHOULD	lifecycle-status	token	GET [base]/Goal?lifecycle-status=[system]|[code]
SHALL	patient	reference	GET [base]/Goal?patient=[type]/[id]
SHOULD	target-date	date	GET [base]/Goal?target-date=[target-date]

HealthcareService

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to access information about the intended performer of a ServiceRequest when the performer is a specific service within a larger facility. Note: Conformance expectations for this resource are lower because HealthcareService performers are expected to be uncommon in most SDOH uses. Also used to indicate who a patient or caregiver should contact about a particular service.

Supported Profiles:

• SHALL support:SDOHCC Healthcare Service

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a HealthcareService resource using:GET [base]/HealthcareService/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/HealthcareService/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/HealthcareService?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/HealthcareService?_lastUpdated=[dateTime]
SHALL	location	reference	GET [base]/HealthcareService?location=[type]/[id]

Location

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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.

Supported Profiles:

• SHALL support:SDOHCC Location

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†.
• MAY support search-type^†.

read^†

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

search-type^†

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

ns.n

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a Location resource using:GET [base]/Location/[id]
• A Client MAY be capable of fetching resources matching a search query using:GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Location?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Location?_lastUpdated=[dateTime]

Observation

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral. Also used to access certain SDOH-relevant demographic information.

Supported Profiles:

• SHALL support:SDOHCC Observation Assessment,
• SHALL support:SDOHCC Observation Screening Response,
• MAY support:SDOHCC Observation Ethnicity OMB,
• MAY support:SDOHCC Observation Race OMB,
• MAY support:SDOHCC Observation Gender Identity,
• MAY support:SDOHCC Observation Personal Characteristic,
• MAY support:SDOHCC Observation Personal Pronouns,
• MAY support:SDOHCC Observation Recorded Sex Gender,
• MAY support:SDOHCC Observation Sexual Orientation

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

read^†

Allows the system to retrieve an Observation referenced by a ServiceRequest or associated with the patient.

search-type^†

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

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching an Observation resource using:GET [base]/Observation/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Observation?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Observation?_lastUpdated=[dateTime]
SHALL	category	token	GET [base]/Observation?category=[system]|[code]
SHOULD	code	token	GET [base]/Observation?code=[system]|[code]
SHOULD	date	date	GET [base]/Observation?date=[date]
SHOULD	derived-from	reference	GET [base]/Observation?derived-from=[type]/[id]
SHALL	patient	reference	GET [base]/Observation?patient=[type]/[id]
SHALL	status	token	GET [base]/Observation?status=[system]|[code]

Organization

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core Organization Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching an Organization resource using:GET [base]/Organization/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Organization?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Organization?_lastUpdated=[dateTime]

Patient

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core Patient Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

read^†

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

search-type^†

Allows the monitoring of previously-retrieved Patients.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Patient resource using:GET [base]/Patient/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Patient?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Patient?_lastUpdated=[dateTime]

Practitioner

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core Practitioner Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Practitioner resource using:GET [base]/Practitioner/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Practitioner/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Practitioner?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Practitioner?_lastUpdated=[dateTime]

PractitionerRole

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core PractitionerRole Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a PractitionerRole resource using:GET [base]/PractitionerRole/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}
• A Client SHOULD be capable of supporting the following _includes:
  • PractitionerRole:organization - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:organization
  • PractitionerRole:practitioner - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/PractitionerRole?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/PractitionerRole?_lastUpdated=[dateTime]
SHOULD	organization	reference	GET [base]/PractitionerRole?organization=[type]/[id]
SHOULD	practitioner	reference	GET [base]/PractitionerRole?practitioner=[type]/[id]

Procedure

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDOHCC Procedure

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support create^†, update^†, read^†.
• SHOULD support search-type^†.

create^†

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

update^†

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

read^†

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

search-type^†

Allows the coordination platform 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.

ns.n

Modify Criteria:

• A Client SHALL be capable of posting a Procedure resource using:POST [base]/Procedure/[id]{?_format=[mime-type]}
• A Client SHALL be capable of putting an existing Procedure resource using:PUT [base]/Procedure/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Procedure resource using:GET [base]/Procedure/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Procedure?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Procedure?_lastUpdated=[dateTime]
SHALL	based-on	reference	GET [base]/Procedure?based-on=[type]/[id]
SHALL	category	token	GET [base]/Procedure?category=[system]|[code]
SHOULD	code	token	GET [base]/Procedure?code=[system]|[code]
SHOULD	date	date	GET [base]/Procedure?date=[date]
SHALL	patient	reference	GET [base]/Procedure?patient=[type]/[id]
SHALL	performer	reference	GET [base]/Procedure?performer=[type]/[id]
SHALL	status	token	GET [base]/Procedure?status=[system]|[code]

Questionnaire

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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.

Supported Profiles:

• SHALL support:Extractable Questionnaire - StructureMap

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support search-type^†.

search-type^†

Allows the coordination platform to search for questionnaires relevant to a patient context.

Operation Summary:

• MAY support $populate^†.

$populate^†

Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere

ns.n

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHOULD	code	token	GET [base]/Questionnaire?code=[system]|[code]
SHOULD	context-type-value	composite	GET [base]/Questionnaire?context-type-value=[code]&[value]
SHOULD	identifier	token	GET [base]/Questionnaire?identifier=[system]|[code]
SHOULD	publisher	string	GET [base]/Questionnaire?publisher=[publisher]
SHOULD	status	token	GET [base]/Questionnaire?status=[system]|[code]
SHOULD	subject-type	token	GET [base]/Questionnaire?subject-type=[system]|[code]
SHOULD	title	string	GET [base]/Questionnaire?title=[title]
SHALL	url	uri	GET [base]/Questionnaire?url=[uri]
SHALL	version	token	GET [base]/Questionnaire?version=[system]|[code]

QuestionnaireResponse

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to allow QuestionnaireResponses referenced by a ServiceRequest or Task

Supported Profiles:

• SHALL support:SDC Questionnaire Response

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a QuestionnaireResponse resource using:GET [base]/QuestionnaireResponse/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/QuestionnaireResponse?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/QuestionnaireResponse?_lastUpdated=[dateTime]
SHALL	author	reference	GET [base]/QuestionnaireResponse?author=[type]/[id]
SHOULD	authored	date	GET [base]/QuestionnaireResponse?authored=[authored]
SHALL	patient	reference	GET [base]/QuestionnaireResponse?patient=[type]/[id]
SHALL	questionnaire	reference	GET [base]/QuestionnaireResponse?questionnaire=[type]/[id]
SHALL	status	token	GET [base]/QuestionnaireResponse?status=[system]|[code]

RelatedPerson

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:(http://hl7.org/fhir/StructureDefinition/RelatedPerson)

Reference Policy: literal

Profile Interaction Summary:

• MAY support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client MAY be capable of fetching a RelatedPerson resource using:GET [base]/RelatedPerson/[id]
• A Client MAY be capable of fetching resources matching a search query using:GET [base]/RelatedPerson/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/RelatedPerson?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/RelatedPerson?_lastUpdated=[dateTime]

ServiceRequest

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to retrieve an order for SDOH-related services

Supported Profiles:

• SHALL support:SDOHCC ServiceRequest

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†.
• SHOULD support search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a ServiceRequest resource using:GET [base]/ServiceRequest/[id]
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}
• A Client SHALL be capable of supporting the following _includes:
  • HealthCareService:location - GET [base]/ServiceRequest?[parameter=value]&_include=HealthCareService:location
  • ServiceRequest:supporting-info - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:supporting-info
  • ServiceRequest:pertains-to-goal - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:pertains-to-goal
  • ServiceRequest:patient - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:patient
  • ServiceRequest:requester - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:requester
  • ServiceRequest:performer - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:performer
  • PractitionerRole:practitioner - GET [base]/ServiceRequest?[parameter=value]&_include=PractitionerRole:practitioner
  • PractitionerRole:organization - GET [base]/ServiceRequest?[parameter=value]&_include=PractitionerRole:organization

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/ServiceRequest?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/ServiceRequest?_lastUpdated=[dateTime]
SHALL	category	token	GET [base]/ServiceRequest?category=[system]|[code]
SHOULD	code	token	GET [base]/ServiceRequest?code=[system]|[code]
SHALL	intent	token	GET [base]/ServiceRequest?intent=[system]|[code]
SHOULD	occurrence	date	GET [base]/ServiceRequest?occurrence=[occurrence]
SHALL	patient	reference	GET [base]/ServiceRequest?patient=[type]/[id]
SHOULD	performer	reference	GET [base]/ServiceRequest?performer=[type]/[id]
SHOULD	requester	reference	GET [base]/ServiceRequest?requester=[type]/[id]
SHALL	status	token	GET [base]/ServiceRequest?status=[system]|[code]
SHOULD	supporting-info	reference	GET [base]/ServiceRequest?supporting-info=[type]/[id]

Subscription

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to monitor updates to Tasks on downstream systems

Supported Profiles:

• SHALL support:R4/B Topic-Based Subscription

Profile Interaction Summary:

• SHOULD support create^†.
• MAY support update^†.

create^†

Necessary if using subscriptions to monitor updates to the Task

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

Operation Summary:

• SHOULD support $status^†.
• MAY support $topic-list^†.

$status^†

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

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

ns.n

Modify Criteria:

• A Client SHOULD be capable of posting a Subscription resource using:POST [base]/Subscription/[id]{?_format=[mime-type]}
• A Client MAY be capable of putting an existing Subscription resource using:PUT [base]/Subscription/[id]{?_format=[mime-type]}

Task

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to create Tasks on downstream systems seeking fufillment of ServiceRequests or performance of a patient activity on a coordinating system serving as an intermediary and to retrieve Task updates from a fulfilling system.

Supported Profiles:

• SHALL support:SDOHCC Task For Patient,
• SHALL support:SDOHCC Task For Referral Management

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support create^†, update^†, read^†.
• SHOULD support search-type^†.

create^†

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

update^†

Allows the coordination platform to modify the status of previously created tasks - e.g. to cancel them. 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 the coordination platform to poll a single Task for changes.

search-type^†

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

ns.n

Modify Criteria:

• A Client SHALL be capable of posting a Task resource using:POST [base]/Task/[id]{?_format=[mime-type]}
• A Client SHALL be capable of putting an existing Task resource using:PUT [base]/Task/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Task resource using:GET [base]/Task/[id]
  • A Client (conformance expectation undefined) support conditional read of Task resources only with the If-Modified-Since HTTP Header.
• A Client SHOULD be capable of fetching resources matching a search query using:GET [base]/Task/[id]{?[parameters]{&_format=[mime-type]}}
• A Client SHALL be capable of supporting the following _includes:
  • Task:focus - GET [base]/Task?[parameter=value]&_include=Task:focus
  • Task:output - GET [base]/Task?[parameter=value]&_include=Task:output
  • HealthCareService:location - GET [base]/Task?[parameter=value]&_include=HealthCareService:location
  • ServiceRequest:supporting-info - GET [base]/Task?[parameter=value]&_include=ServiceRequest:supporting-info
  • ServiceRequest:pertains-to-goal - GET [base]/Task?[parameter=value]&_include=ServiceRequest:pertains-to-goal
  • ServiceRequest:patient - GET [base]/Task?[parameter=value]&_include=ServiceRequest:patient
  • ServiceRequest:requester - GET [base]/Task?[parameter=value]&_include=ServiceRequest:requester
  • ServiceRequest:performer - GET [base]/Task?[parameter=value]&_include=ServiceRequest:performer
  • PractitionerRole:practitioner - GET [base]/Task?[parameter=value]&_include=PractitionerRole:practitioner
  • PractitionerRole:organization - GET [base]/Task?[parameter=value]&_include=PractitionerRole:organization

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Task?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Task?_lastUpdated=[dateTime]
SHALL	code	token	GET [base]/Task?code=[system]|[code]
SHOULD	owner	reference	GET [base]/Task?owner=[type]/[id]
SHALL	patient	reference	GET [base]/Task?patient=[type]/[id]
SHALL	requester	reference	GET [base]/Task?requester=[type]/[id]
SHALL	status	token	GET [base]/Task?status=[system]|[code]
SHALL	focus	reference	GET [base]/Task?focus=[type]/[id]
SHOULD	output	reference	GET [base]/Task?output=[type]/[id]

FHIR Server RESTful Capabilities

Coordinating systems and service providers will frequently need to access information from the SDOH clinical care manager.

Security:

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

Summary of Server Wide Interactions

• SHOULD support the batch^† interaction.

batch^†

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

RESTful Capabilities by Resource/Profile:

Summary

♦ = SHALL expectation;⋄ = SHOULD expectation;▿ = MAY expectation;

Resource Type	Supported Interactions	Supported Profiles	Supported Searches	Supported _includes	Supported _revincludes	Supported Operations
CareTeam	read▿, search-type▿	US Core CareTeam Profile♦	_id♦, _lastUpdated⋄
Condition	create▿, update▿, read♦, search-type♦	SDOHCC Condition♦	_id♦, _lastUpdated⋄, category♦, clinical-status⋄, code⋄, patient♦, verification-status⋄
Consent	create▿, update▿, read♦, search-type♦	SDOHCC Consent♦	_id♦, _lastUpdated⋄, source-reference♦	Consent:source-reference:DocumentReference⋄
Device	read⋄, search-type⋄	FHIR Device♦	_id♦, _lastUpdated⋄
DocumentReference	create♦, update⋄, read♦, search-type♦	US Core DocumentReference Profile♦	_id♦, _lastUpdated⋄
Goal	create▿, update▿, read♦, search-type♦	SDOHCC Goal♦	_id♦, _lastUpdated⋄, achievement-status⋄, category♦, lifecycle-status⋄, patient♦, target-date⋄
Group	read♦, search-type♦	SDOHCC Group♦	_id♦, _lastUpdated⋄, characteristic-value⋄, code♦, managing-entity⋄, member♦	Group:member♦
HealthcareService	read⋄, search-type⋄	SDOHCC Healthcare Service♦	_id♦, _lastUpdated⋄, location♦
Location	read⋄, search-type▿	SDOHCC Location♦	_id♦, _lastUpdated⋄
Observation	create▿, update▿, read♦, search-type♦	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▿	_id♦, _lastUpdated⋄, category♦, code⋄, code-value-concept▿, date⋄, derived-from⋄, patient♦, status♦
Organization	read⋄, search-type	US Core Organization Profile♦	_id, _lastUpdated
Patient	read♦, search-type♦	US Core Patient Profile♦	_id♦, _lastUpdated⋄
Practitioner	read♦, search-type♦	US Core Practitioner Profile♦	_id♦, _lastUpdated⋄
PractitionerRole	read♦, search-type♦	US Core PractitionerRole Profile♦	_id♦, _lastUpdated⋄, organization⋄, practitioner⋄	PractitionerRole:organization⋄, PractitionerRole:practitioner⋄
Procedure	create♦, update♦, read♦, search-type♦	SDOHCC Procedure♦	_id♦, _lastUpdated⋄, based-on♦, category♦, code⋄, date⋄, patient♦, performer♦, status♦
Questionnaire	search-type▿	Extractable Questionnaire - StructureMap♦	code⋄, context-type-value⋄, identifier⋄, publisher⋄, status⋄, subject-type⋄, title⋄, url♦, version♦			$populate▿
QuestionnaireResponse	create⋄, update⋄, read⋄, search-type⋄	SDC Questionnaire Response♦	_id♦, _lastUpdated⋄, author♦, authored⋄, patient♦, questionnaire♦, status♦
RelatedPerson	read▿, search-type▿	FHIR RelatedPerson♦	_id♦, _lastUpdated⋄
ServiceRequest	create▿, update▿, read♦, search-type♦	SDOHCC ServiceRequest♦	_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	create⋄, update▿	R4/B Topic-Based Subscription♦				$status⋄, $topic-list▿
Task	create♦, update♦, read♦, search-type♦	SDOHCC Task For Patient♦, SDOHCC Task For Referral Management♦	_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⋄

CareTeam

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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

Supported Profiles:

• SHALL support:US Core CareTeam Profile

Reference Policy: literal

Profile Interaction Summary:

• MAY support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server MAY be capable of returning a CareTeam resource using:GET [base]/CareTeam/[id]
• A Server MAY be capable of returning resources matching a search query using:GET [base]/CareTeam/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/CareTeam?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/CareTeam?_lastUpdated=[dateTime]

Condition

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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

Supported Profiles:

• SHALL support:SDOHCC Condition

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support read^†, search-type^†.
• MAY support create^†, update^†.

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.

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.

ns.n

Modify Criteria:

• A Server MAY be capable of creating a Condition resource using:POST [base]/Condition/[id]{?_format=[mime-type]}
• A Server MAY be capable of updating an existing Condition resource using:PUT [base]/Condition/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Condition resource using:GET [base]/Condition/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Condition?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Condition?_lastUpdated=[dateTime]
SHALL	category	token	GET [base]/Condition?category=[system]|[code]
SHOULD	clinical-status	token	GET [base]/Condition?clinical-status=[system]|[code]
SHOULD	code	token	GET [base]/Condition?code=[system]|[code]
SHALL	patient	reference	GET [base]/Condition?patient=[type]/[id]
SHOULD	verification-status	token	GET [base]/Condition?verification-status=[system]|[code]

Consent

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDOHCC Consent

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support read^†, search-type^†.
• MAY support create^†, update^†.

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.

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.

ns.n

Modify Criteria:

• A Server MAY be capable of creating a Consent resource using:POST [base]/Consent/[id]{?_format=[mime-type]}
• A Server MAY be capable of updating an existing Consent resource using:PUT [base]/Consent/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Consent resource using:GET [base]/Consent/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Consent/[id]{?[parameters]{&_format=[mime-type]}}
• A Server SHOULD be capable of supporting the following _includes:
  • Consent:source-reference:DocumentReference - GET [base]/Consent?[parameter=value]&_include=Consent:source-reference:DocumentReference

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Consent?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Consent?_lastUpdated=[dateTime]
SHALL	source-reference	reference	GET [base]/Consent?source-reference=[type]/[id]

Device

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:(http://hl7.org/fhir/StructureDefinition/Device)

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHOULD be capable of returning a Device resource using:GET [base]/Device/[id]
• A Server SHOULD be capable of returning resources matching a search query using:GET [base]/Device/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Device?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Device?_lastUpdated=[dateTime]

DocumentReference

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core DocumentReference Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support create^†, read^†, search-type^†.
• SHOULD support update^†.

create^†

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

update^†

Allows the system to revise a previously stored PDF

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.

ns.n

Modify Criteria:

• A Server SHALL be capable of creating a DocumentReference resource using:POST [base]/DocumentReference/[id]{?_format=[mime-type]}
• A Server SHOULD be capable of updating an existing DocumentReference resource using:PUT [base]/DocumentReference/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a DocumentReference resource using:GET [base]/DocumentReference/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/DocumentReference?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/DocumentReference?_lastUpdated=[dateTime]

Goal

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to allow access to goals related to an SDOH referral

Supported Profiles:

• SHALL support:SDOHCC Goal

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support read^†, search-type^†.
• MAY support create^†, update^†.

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.

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.

ns.n

Modify Criteria:

• A Server MAY be capable of creating a Goal resource using:POST [base]/Goal/[id]{?_format=[mime-type]}
• A Server MAY be capable of updating an existing Goal resource using:PUT [base]/Goal/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Goal resource using:GET [base]/Goal/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Goal/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Goal?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Goal?_lastUpdated=[dateTime]
SHOULD	achievement-status	token	GET [base]/Goal?achievement-status=[system]|[code]
SHALL	category	token	GET [base]/Goal?category=[system]|[code]
SHOULD	lifecycle-status	token	GET [base]/Goal?lifecycle-status=[system]|[code]
SHALL	patient	reference	GET [base]/Goal?patient=[type]/[id]
SHOULD	target-date	date	GET [base]/Goal?target-date=[target-date]

Group

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDOHCC Group

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Group resource using:GET [base]/Group/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Group/[id]{?[parameters]{&_format=[mime-type]}}
• A Server SHALL be capable of supporting the following _includes:
  • Group:member - GET [base]/Group?[parameter=value]&_include=Group:member

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Group?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Group?_lastUpdated=[dateTime]
SHOULD	characteristic-value	composite	GET [base]/Group?characteristic-value=[code]&[value]
SHALL	code	token	GET [base]/Group?code=[system]|[code]
SHOULD	managing-entity	reference	GET [base]/Group?managing-entity=[type]/[id]
SHALL	member	reference	GET [base]/Group?member=[type]/[id]

HealthcareService

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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.

Supported Profiles:

• SHALL support:SDOHCC Healthcare Service

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHOULD be capable of returning a HealthcareService resource using:GET [base]/HealthcareService/[id]
• A Server SHOULD be capable of returning resources matching a search query using:GET [base]/HealthcareService/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/HealthcareService?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/HealthcareService?_lastUpdated=[dateTime]
SHALL	location	reference	GET [base]/HealthcareService?location=[type]/[id]

Location

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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.

Supported Profiles:

• SHALL support:SDOHCC Location

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†.
• MAY support search-type^†.

read^†

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

search-type^†

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

ns.n

Fetch and Search Criteria:

• A Server SHOULD be capable of returning a Location resource using:GET [base]/Location/[id]
• A Server MAY be capable of returning resources matching a search query using:GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Location?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Location?_lastUpdated=[dateTime]

Observation

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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 as well as certain SDOH-relevant demographic information

Supported Profiles:

• SHALL support:SDOHCC Observation Assessment,
• SHALL support:SDOHCC Observation Screening Response,
• MAY support:SDOHCC Observation Ethnicity OMB,
• MAY support:SDOHCC Observation Race OMB,
• MAY support:SDOHCC Observation Gender Identity,
• MAY support:SDOHCC Observation Personal Characteristic,
• MAY support:SDOHCC Observation Personal Pronouns,
• MAY support:SDOHCC Observation Recorded Sex Gender,
• MAY support:SDOHCC Observation Sexual Orientation

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support read^†, search-type^†.
• MAY support create^†, update^†.

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.

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.

ns.n

Modify Criteria:

• A Server MAY be capable of creating an Observation resource using:POST [base]/Observation/[id]{?_format=[mime-type]}
• A Server MAY be capable of updating an existing Observation resource using:PUT [base]/Observation/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning an Observation resource using:GET [base]/Observation/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Observation?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Observation?_lastUpdated=[dateTime]
SHALL	category	token	GET [base]/Observation?category=[system]|[code]
SHOULD	code	token	GET [base]/Observation?code=[system]|[code]
SHOULD	date	date	GET [base]/Observation?date=[date]
SHOULD	derived-from	reference	GET [base]/Observation?derived-from=[type]/[id]
SHALL	patient	reference	GET [base]/Observation?patient=[type]/[id]
SHALL	status	token	GET [base]/Observation?status=[system]|[code]

Organization

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core Organization Profile

Reference Policy: literal

Profile Interaction Summary:

• SHOULD support read^†.
• search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHOULD be capable of returning an Organization resource using:GET [base]/Organization/[id]
• A Server (conformance expectation undefined) be capable of returning resources matching a search query using:GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
(conformance expectation undefined)	_id	token	GET [base]/Organization?_id=[id]
(conformance expectation undefined)	_lastUpdated	date	GET [base]/Organization?_lastUpdated=[dateTime]

Patient

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core Patient Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Patient resource using:GET [base]/Patient/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Patient?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Patient?_lastUpdated=[dateTime]

Practitioner

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core Practitioner Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Practitioner resource using:GET [base]/Practitioner/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Practitioner/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Practitioner?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Practitioner?_lastUpdated=[dateTime]

PractitionerRole

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:US Core PractitionerRole Profile

Reference Policy: literal

Profile Interaction Summary:

• SHALL support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server SHALL be capable of returning a PractitionerRole resource using:GET [base]/PractitionerRole/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}
• A Server SHOULD be capable of supporting the following _includes:
  • PractitionerRole:organization - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:organization
  • PractitionerRole:practitioner - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/PractitionerRole?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/PractitionerRole?_lastUpdated=[dateTime]
SHOULD	organization	reference	GET [base]/PractitionerRole?organization=[type]/[id]
SHOULD	practitioner	reference	GET [base]/PractitionerRole?practitioner=[type]/[id]

Procedure

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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.

Supported Profiles:

• SHALL support:SDOHCC Procedure

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support create^†, update^†, read^†, search-type^†.

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.

ns.n

Modify Criteria:

• A Server SHALL be capable of creating a Procedure resource using:POST [base]/Procedure/[id]{?_format=[mime-type]}
• A Server SHALL be capable of updating an existing Procedure resource using:PUT [base]/Procedure/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Procedure resource using:GET [base]/Procedure/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Procedure?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Procedure?_lastUpdated=[dateTime]
SHALL	based-on	reference	GET [base]/Procedure?based-on=[type]/[id]
SHALL	category	token	GET [base]/Procedure?category=[system]|[code]
SHOULD	code	token	GET [base]/Procedure?code=[system]|[code]
SHOULD	date	date	GET [base]/Procedure?date=[date]
SHALL	patient	reference	GET [base]/Procedure?patient=[type]/[id]
SHALL	performer	reference	GET [base]/Procedure?performer=[type]/[id]
SHALL	status	token	GET [base]/Procedure?status=[system]|[code]

Questionnaire

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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.

Supported Profiles:

• SHALL support:Extractable Questionnaire - StructureMap

Reference Policy: literal

Profile Interaction Summary:

• MAY support search-type^†.

search-type^†

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

Operation Summary:

• MAY support $populate^†.

$populate^†

Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere

ns.n

Fetch and Search Criteria:

• A Server MAY be capable of returning resources matching a search query using:GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHOULD	code	token	GET [base]/Questionnaire?code=[system]|[code]
SHOULD	context-type-value	composite	GET [base]/Questionnaire?context-type-value=[code]&[value]
SHOULD	identifier	token	GET [base]/Questionnaire?identifier=[system]|[code]
SHOULD	publisher	string	GET [base]/Questionnaire?publisher=[publisher]
SHOULD	status	token	GET [base]/Questionnaire?status=[system]|[code]
SHOULD	subject-type	token	GET [base]/Questionnaire?subject-type=[system]|[code]
SHOULD	title	string	GET [base]/Questionnaire?title=[title]
SHALL	url	uri	GET [base]/Questionnaire?url=[uri]
SHALL	version	token	GET [base]/Questionnaire?version=[system]|[code]

QuestionnaireResponse

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDC Questionnaire Response

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHOULD support create^†, update^†, read^†, search-type^†.

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.

ns.n

Modify Criteria:

• A Server SHOULD be capable of creating a QuestionnaireResponse resource using:POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
• A Server SHOULD be capable of updating an existing QuestionnaireResponse resource using:PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHOULD be capable of returning a QuestionnaireResponse resource using:GET [base]/QuestionnaireResponse/[id]
• A Server SHOULD be capable of returning resources matching a search query using:GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/QuestionnaireResponse?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/QuestionnaireResponse?_lastUpdated=[dateTime]
SHALL	author	reference	GET [base]/QuestionnaireResponse?author=[type]/[id]
SHOULD	authored	date	GET [base]/QuestionnaireResponse?authored=[authored]
SHALL	patient	reference	GET [base]/QuestionnaireResponse?patient=[type]/[id]
SHALL	questionnaire	reference	GET [base]/QuestionnaireResponse?questionnaire=[type]/[id]
SHALL	status	token	GET [base]/QuestionnaireResponse?status=[system]|[code]

RelatedPerson

Conformance Expectation:(conformance expectation undefined)

Resource Specific 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

Supported Profiles:

• SHALL support:(http://hl7.org/fhir/StructureDefinition/RelatedPerson)

Reference Policy: literal

Profile Interaction Summary:

• MAY support read^†, search-type^†.

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.

ns.n

Fetch and Search Criteria:

• A Server MAY be capable of returning a RelatedPerson resource using:GET [base]/RelatedPerson/[id]
• A Server MAY be capable of returning resources matching a search query using:GET [base]/RelatedPerson/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/RelatedPerson?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/RelatedPerson?_lastUpdated=[dateTime]

ServiceRequest

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

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

Supported Profiles:

• SHALL support:SDOHCC ServiceRequest

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support read^†, search-type^†.
• MAY support create^†, update^†.

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.

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.

ns.n

Modify Criteria:

• A Server MAY be capable of creating a ServiceRequest resource using:POST [base]/ServiceRequest/[id]{?_format=[mime-type]}
• A Server MAY be capable of updating an existing ServiceRequest resource using:PUT [base]/ServiceRequest/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a ServiceRequest resource using:GET [base]/ServiceRequest/[id]
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}
• A Server SHALL be capable of supporting the following _includes:
  • HealthCareService:location - GET [base]/ServiceRequest?[parameter=value]&_include=HealthCareService:location
  • ServiceRequest:supporting-info - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:supporting-info
  • ServiceRequest:pertains-to-goal - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:pertains-to-goal
  • ServiceRequest:patient - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:patient
  • ServiceRequest:requester - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:requester
  • ServiceRequest:performer - GET [base]/ServiceRequest?[parameter=value]&_include=ServiceRequest:performer
  • PractitionerRole:practitioner - GET [base]/ServiceRequest?[parameter=value]&_include=PractitionerRole:practitioner
  • PractitionerRole:organization - GET [base]/ServiceRequest?[parameter=value]&_include=PractitionerRole:organization

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/ServiceRequest?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/ServiceRequest?_lastUpdated=[dateTime]
SHALL	category	token	GET [base]/ServiceRequest?category=[system]|[code]
SHOULD	code	token	GET [base]/ServiceRequest?code=[system]|[code]
SHALL	intent	token	GET [base]/ServiceRequest?intent=[system]|[code]
SHOULD	occurrence	date	GET [base]/ServiceRequest?occurrence=[occurrence]
SHALL	patient	reference	GET [base]/ServiceRequest?patient=[type]/[id]
SHOULD	performer	reference	GET [base]/ServiceRequest?performer=[type]/[id]
SHOULD	requester	reference	GET [base]/ServiceRequest?requester=[type]/[id]
SHALL	status	token	GET [base]/ServiceRequest?status=[system]|[code]
SHOULD	supporting-info	reference	GET [base]/ServiceRequest?supporting-info=[type]/[id]

Subscription

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used to allow upstream and occasionally downstream systems to subscribe to and monitor Tasks this system for change

Supported Profiles:

• SHALL support:R4/B Topic-Based Subscription

Profile Interaction Summary:

• SHOULD support create^†.
• MAY support update^†.

create^†

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

update^†

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

Operation Summary:

• SHOULD support $status^†.
• MAY support $topic-list^†.

$status^†

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

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

ns.n

Modify Criteria:

• A Server SHOULD be capable of creating a Subscription resource using:POST [base]/Subscription/[id]{?_format=[mime-type]}
• A Server MAY be capable of updating an existing Subscription resource using:PUT [base]/Subscription/[id]{?_format=[mime-type]}

Task

Conformance Expectation:(conformance expectation undefined)

Resource Specific Documentation:

Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests or performance of activities by patients and care-givers. 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

Supported Profiles:

• SHALL support:SDOHCC Task For Patient,
• SHALL support:SDOHCC Task For Referral Management

Reference Policy: literal

Versioning Policy: versioned-update

Profile Interaction Summary:

• SHALL support create^†, update^†, read^†, search-type^†.

create^†

Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest.

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

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.

ns.n

Modify Criteria:

• A Server SHALL be capable of creating a Task resource using:POST [base]/Task/[id]{?_format=[mime-type]}
• A Server SHALL be capable of updating an existing Task resource using:PUT [base]/Task/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

• A Server SHALL be capable of returning a Task resource using:GET [base]/Task/[id]
  • A Server (conformance expectation undefined) support conditional read of Task resources only with the If-Modified-Since HTTP Header.
• A Server SHALL be capable of returning resources matching a search query using:GET [base]/Task/[id]{?[parameters]{&_format=[mime-type]}}
• A Server SHALL be capable of supporting the following _includes:
  • Task:focus - GET [base]/Task?[parameter=value]&_include=Task:focus
  • Task:output - GET [base]/Task?[parameter=value]&_include=Task:output
  • HealthCareService:location - GET [base]/Task?[parameter=value]&_include=HealthCareService:location
  • ServiceRequest:supporting-info - GET [base]/Task?[parameter=value]&_include=ServiceRequest:supporting-info
  • ServiceRequest:pertains-to-goal - GET [base]/Task?[parameter=value]&_include=ServiceRequest:pertains-to-goal
  • ServiceRequest:patient - GET [base]/Task?[parameter=value]&_include=ServiceRequest:patient
  • ServiceRequest:requester - GET [base]/Task?[parameter=value]&_include=ServiceRequest:requester
  • ServiceRequest:performer - GET [base]/Task?[parameter=value]&_include=ServiceRequest:performer
  • PractitionerRole:practitioner - GET [base]/Task?[parameter=value]&_include=PractitionerRole:practitioner
  • PractitionerRole:organization - GET [base]/Task?[parameter=value]&_include=PractitionerRole:organization

Search Parameter Summary:

Conformance	Parameter	Type	Example
SHALL	_id	token	GET [base]/Task?_id=[id]
SHOULD	_lastUpdated	date	GET [base]/Task?_lastUpdated=[dateTime]
SHALL	code	token	GET [base]/Task?code=[system]|[code]
SHOULD	owner	reference	GET [base]/Task?owner=[type]/[id]
SHALL	patient	reference	GET [base]/Task?patient=[type]/[id]
SHALL	requester	reference	GET [base]/Task?requester=[type]/[id]
SHALL	status	token	GET [base]/Task?status=[system]|[code]
SHALL	focus	reference	GET [base]/Task?focus=[type]/[id]
SHOULD	output	reference	GET [base]/Task?output=[type]/[id]