Generated Narrative: CapabilityStatement SDOHCC-CoordinationPlatform SDOHCC Coordination Platform Implementation Guide Version: 3.0.0-ballot FHIR Version: 4.0.1 Supported Formats: xml, json Published on: 2021-06 Published by: HL7 International / Patient Care Note to Implementers: FHIR Capabilities Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case. FHIR RESTful Capabilities REST Configuration: 1 Mode: client The clinical care coordinator needs to receive information from and update information in SDOH clinical care referral sources. Security Enable CORS: no Security services supported: SMART-on-FHIR Implementations must meet the general privacy & security requirements documented in this implementation guide. Summary of System-wide Interactions SHOULD support the 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 Type Profile R S U C Searches _include _revinclude Operations CareTeam Supported Profiles US Core CareTeam Profileversion: 7.0.0) y? y? _id, _lastUpdated Condition Supported Profiles SDOHCC Condition Y Y _id, _lastUpdated, category, clinical-status, code, patient, verification-status Consent Supported Profiles SDOHCC Consent Y Y _id, _lastUpdated, source-reference Consent:source-reference:DocumentReference Device Supported Profiles Device Y Y _id, _lastUpdated DocumentReference Supported Profiles US Core DocumentReference Profileversion: 7.0.0) Y Y _id, _lastUpdated Goal Supported Profiles SDOHCC Goal Y Y _id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date HealthcareService Supported Profiles SDOHCC Healthcare Service Y Y _id, _lastUpdated, location Location Supported Profiles SDOHCC Location Y y? _id, _lastUpdated Observation Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response SDOHCC Observation Ethnicity OMB SDOHCC Observation Race OMB SDOHCC Observation Gender Identity SDOHCC Observation Personal Characteristic SDOHCC Observation Personal Pronouns SDOHCC Observation Recorded Sex Gender SDOHCC Observation Sexual Orientation Y Y _id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status Organization Supported Profiles US Core Organization Profileversion: 7.0.0) Y Y _id, _lastUpdated Patient Supported Profiles US Core Patient Profileversion: 7.0.0) Y Y _id, _lastUpdated Practitioner Supported Profiles US Core Practitioner Profileversion: 7.0.0) Y Y _id, _lastUpdated PractitionerRole Supported Profiles SDOHCC PractitionerRole Y Y _id, _lastUpdated, organization, practitioner PractitionerRole:organization, PractitionerRole:practitioner Procedure Supported Profiles SDOHCC Procedure Y Y Y Y _id, _lastUpdated, based-on, category, code, date, patient, performer, status Questionnaire Supported Profiles Extractable Questionnaire - StructureMap Y code, context-type-value, identifier, publisher, status, subject-type, title, url, version $populate QuestionnaireResponse Supported Profiles SDC Questionnaire Response Y Y _id, _lastUpdated, author, authored, patient, questionnaire, status RelatedPerson Supported Profiles RelatedPerson y? y? _id, _lastUpdated ServiceRequest Supported Profiles SDOHCC ServiceRequest Y Y _id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-info HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization Subscription Supported Profiles http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription y? Y $status Task Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management Y Y Y Y _id, _lastUpdated, code, owner, patient, requester, status, focus, output Task:focus, Task:output, HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization Resource Conformance: SHALL CareTeam Core FHIR Resource CareTeam Reference Policy literal Interaction summary MAY support read Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest. search-type Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests. Supported Profiles US Core CareTeam Profileversion: 7.0.0) Documentation Used to access information about the intended performer of a ServiceRequest when the performer is a specific team of people. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Condition Core FHIR Resource Condition Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve a Condition that is the reason for a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests. Supported Profiles SDOHCC Condition Documentation Used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering to only SDOH-related conditions SHALL patient reference Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD clinical-status token Allows filtering to only active conditions SHOULD code token Allows filtering to only specific SDOH conditions or sets of conditions SHOULD verification-status token Allows filtering to exclude refuted or entered-in-error conditions Resource Conformance: SHALL Consent Core FHIR Resource Consent Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest. Supported Profiles SDOHCC Consent Documentation Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates SHALL source-reference reference Allows including the document that contains the PDF or similar representation of a paper consent SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Device Core FHIR Resource Device Reference Policy literal Interaction summary SHOULD support read Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest. search-type Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests. Supported Profiles Device Documentation Used to retrieve the requester or intended performer of an SDOH ServiceRequest. Note: Conformance expectations for this resource are lower because Device requesters and performers are expected to be uncommon in most SDOH uses Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates SHALL _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL DocumentReference Core FHIR Resource DocumentReference Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve a PDF or similar content referenced by a Consent or Task. SHOULD support search-type Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated. Supported Profiles US Core DocumentReference Profileversion: 7.0.0) Documentation Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Goal Core FHIR Resource Goal Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve a goal referenced by a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved Goals in the event they are updated. Supported Profiles SDOHCC Goal Documentation Used to access goals related to an SDOH referral Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering to only include SDOH-related goals SHALL patient reference Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD achievement-status token Allows filtering to only include unmet goals SHOULD lifecycle-status token Allows filtering to only include active goals SHOULD target-date date Allows filtering based on when a particular goal is desired to be achieved Resource Conformance: SHALL HealthcareService Core FHIR Resource HealthcareService Reference Policy literal Interaction summary SHOULD support read Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest. search-type Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests. Supported Profiles SDOHCC Healthcare Service Documentation 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. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates SHALL location reference Allows retrieval of the phyical site(s) associated with a HealthService SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Location Core FHIR Resource Location Reference Policy literal Interaction summary SHOULD support read Allows the system to retrieve a Location that is an available location for a service. MAY support search-type Allows the monitoring of previously-retrieved Locations that are the intended locations for services. Supported Profiles SDOHCC Location Documentation Used to access information about the potential sites at which a requested service might be performed. Allows a patient to evaluate the suitability of a proposed activity or service. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Observation Core FHIR Resource Observation Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve an Observation referenced by a ServiceRequest or associated with the patient. SHOULD support search-type Allows the monitoring of previously-retrieved Observations for updates/corrections. Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response SDOHCC Observation Ethnicity OMB SDOHCC Observation Race OMB SDOHCC Observation Gender Identity SDOHCC Observation Personal Characteristic SDOHCC Observation Personal Pronouns SDOHCC Observation Recorded Sex Gender SDOHCC Observation Sexual Orientation Documentation 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. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering for only SDOH-related observations SHALL patient reference Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific SHALL status token Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error) SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD code token Allows filtering for specific types of observations SHOULD date date Allows filtering for observations that held in a particular time period SHOULD derived-from reference Allows filtering for observations derived from a particular QuestionnaireResponse MAY code-value-concept composite Allows filtering for observations that have a specific coded value answer for a specified observation type Resource Conformance: SHALL Organization Core FHIR Resource Organization Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests. Supported Profiles US Core Organization Profileversion: 7.0.0) Documentation Used to access information about an Organization that is the requester or intended performer of a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Patient Core FHIR Resource Patient Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve the Patient that is the subject of a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved Patients. Supported Profiles US Core Patient Profileversion: 7.0.0) Documentation Used to access information about the Patient that is the subject a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Practitioner Core FHIR Resource Practitioner Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests. Supported Profiles US Core Practitioner Profileversion: 7.0.0) Documentation Used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL PractitionerRole Core FHIR Resource PractitionerRole Reference Policy literal Interaction summary SHALL support read Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest. SHOULD support search-type Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests. Supported Profiles SDOHCC PractitionerRole Documentation Used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD organization reference Allows doing an _include on Organization when retrieving the PractitionerRole SHOULD practitioner reference Allows doing an _include on Practitioner when retrieving the PractitionerRole Resource Conformance: SHALL Procedure Core FHIR Resource Procedure Reference Policy literal Interaction summary SHALL support 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. SHOULD support 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. Supported Profiles SDOHCC Procedure Documentation Used to access information about actions that have been performed as a result of a referral Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Proceddure records - and more specifically, retrieving more than one in a single call to poll for updates SHALL based-on reference Allows filtering for procedures resulting from a particular service request SHALL category token Allows filtering for procedures that are SDOH-related SHALL patient reference Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific. SHALL performer reference Allows filtering for procedures based on who delivered the procedure. SHALL status token Allows filtering for procedures that are complete or in progress SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD code token Allows filtering for procedures based on the specific service delivered SHOULD date date Allows filtering for procedures based on when they were delivered Resource Conformance: SHALL Questionnaire Core FHIR Resource Questionnaire Reference Policy literal Interaction summary SHOULD support search-type Allows the coordination platform to search for questionnaires relevant to a patient context. Supported Profiles Extractable Questionnaire - StructureMap Documentation Used to retrieve SDOH-related Questionnaires to be filled out by a patient or representative. Also allows retrieving Questionnaires associated with existing QuestionnaireResponses for editing by SMART-on-FHIR apps. Search Parameters Conformance Parameter Type Documentation SHALL url uri Allows retrieving Questionnaires based on its canonical URL SHALL version token Allows retrieving a specific version of a Questionnaire SHOULD code token Allows filtering for questionnaires associated with particular LOINC or similar codes SHOULD context-type-value composite Allows filtering for procedures that are SDOH-related SHOULD identifier token Allows retrieving Questionnaires with a known identifier SHOULD publisher string Allows retrieving Questionnaires based on who is responsible for them SHOULD status token Allows retrieving Questionnaires that are active (and not draft or required) SHOULD subject-type token Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc. SHOULD title string Allows retrieving Questionnaires based on the name of the form Extended Operations Conformance Operation Documentation MAY $populate Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere Resource Conformance: SHALL QuestionnaireResponse Core FHIR Resource QuestionnaireResponse Reference Policy literal Interaction summary SHOULD support read Allows the retrieval of QuestionnaireResponses pointed to as supporting information by a ServiceRequest or as output of a Task. search-type Allows checking for updates in previously retrieved QuestionnaireResponses. Supported Profiles SDC Questionnaire Response Documentation Used to allow QuestionnaireResponses referenced by a ServiceRequest or Task Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates SHALL author reference Allows filtering QuestionnaireResponses previously created/edited by a particular individual SHALL patient reference Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific SHALL questionnaire reference Allows retrieving QuestionnaireResponses that have been completed against a specified form SHALL status token Allows retrieving QuestionnaireResponses that are complete (or incomplete) SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD authored date Allows filtering for QuestionnaireResponses by when they were created/last edited Resource Conformance: SHALL RelatedPerson Core FHIR Resource RelatedPerson Reference Policy literal Interaction summary MAY support read Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest. search-type Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests. Supported Profiles RelatedPerson Documentation Used to access information about the requester or intended performer of a ServiceRequest when they are someone with a personal relationship to the Patient. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL ServiceRequest Core FHIR Resource ServiceRequest Reference Policy literal Interaction summary SHALL support read Allows client systems to retrieve the ServiceRequest pointed to by a Task. SHOULD support search-type Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling. Supported Profiles SDOHCC ServiceRequest Documentation Used to retrieve an order for SDOH-related services Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering to only retrieve ServiceRequests that are SDOH-related SHALL intent token Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc. SHALL patient reference Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific SHALL status token Allows filtering to retrieve only active ServiceRequests SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD code token Allows filtering to retrieve ServiceRequests for specific types of services SHOULD occurrence date Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided SHOULD performer reference Allows filtering to retrieve only ServiceRequests that designate a specific performer SHOULD requester reference Allows filtering to retrieve only ServiceRequests created by a specific practitioner SHOULD supporting-info reference Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent Resource Conformance: SHOULD Subscription Core FHIR Resource Subscription Reference Policy Interaction summary SHOULD support create Necessary if using subscriptions to monitor updates to the Task MAY support update Needed to allow the requester to update a subscription - to adjust delivery target, to add additional tasks to monitor (if subscribing by id) typically to cancel a request for fulfillment Supported Profiles http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription Documentation Used to monitor updates to Tasks on downstream systems Extended Operations Conformance Operation Documentation SHOULD $status Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors Resource Conformance: SHALL Task Core FHIR Resource Task Reference Policy literal Interaction summary SHALL support 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. SHOULD support search-type Allows the coordination platform to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query. Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management Documentation Used to create Tasks on downstream systems seeking fufillment of ServiceRequests or performance of a patient activity on a coordinating system serving as an intermediary and to retrieve Task updates from a fulfilling system. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates SHALL code token Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables. SHALL patient reference Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.) SHALL requester reference Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system SHALL status token Allows filtering to only active or completed tasks SHALL focus reference Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD owner reference Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned) SHOULD output reference Allows for the 'output' of a Task to be included when retrieving a Task REST Configuration: 2 Mode: server Coordinating systems and service providers will frequently need to access information from the SDOH clinical care manager. Security Enable CORS: no Security services supported: SMART-on-FHIR Implementations must meet the general privacy & security requirements documented in this implementation guide. Summary of System-wide Interactions SHOULD support the batchinteraction described as follows: Allows other systems to poll for changes to multiple resource types simultaneously Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R S U C Searches _include _revinclude Operations CareTeam Supported Profiles US Core CareTeam Profileversion: 7.0.0) y? y? _id, _lastUpdated Condition Supported Profiles SDOHCC Condition Y Y y? y? _id, _lastUpdated, category, clinical-status, code, patient, verification-status Consent Supported Profiles SDOHCC Consent Y Y y? y? _id, _lastUpdated, source-reference Consent:source-reference:DocumentReference Device Supported Profiles Device Y Y _id, _lastUpdated DocumentReference Supported Profiles US Core DocumentReference Profileversion: 7.0.0) Y Y Y Y _id, _lastUpdated Goal Supported Profiles SDOHCC Goal Y Y y? y? _id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date Group Supported Profiles SDOHCC Group Y Y _id, _lastUpdated, characteristic-value, code, managing-entity, member Group:member HealthcareService Supported Profiles SDOHCC Healthcare Service Y Y _id, _lastUpdated, location Location Supported Profiles SDOHCC Location Y y? _id, _lastUpdated Observation Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response SDOHCC Observation Ethnicity OMB SDOHCC Observation Race OMB SDOHCC Observation Gender Identity SDOHCC Observation Personal Characteristic SDOHCC Observation Personal Pronouns SDOHCC Observation Recorded Sex Gender SDOHCC Observation Sexual Orientation Y Y y? y? _id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status Organization Supported Profiles US Core Organization Profileversion: 7.0.0) Y y _id, _lastUpdated Patient Supported Profiles US Core Patient Profileversion: 7.0.0) Y Y _id, _lastUpdated Practitioner Supported Profiles US Core Practitioner Profileversion: 7.0.0) Y Y _id, _lastUpdated PractitionerRole Supported Profiles SDOHCC PractitionerRole Y Y _id, _lastUpdated, organization, practitioner PractitionerRole:organization, PractitionerRole:practitioner Procedure Supported Profiles SDOHCC Procedure Y Y Y Y _id, _lastUpdated, based-on, category, code, date, patient, performer, status Questionnaire Supported Profiles Extractable Questionnaire - StructureMap y? code, context-type-value, identifier, publisher, status, subject-type, title, url, version $populate QuestionnaireResponse Supported Profiles SDC Questionnaire Response Y Y Y Y _id, _lastUpdated, author, authored, patient, questionnaire, status RelatedPerson Supported Profiles RelatedPerson y? y? _id, _lastUpdated ServiceRequest Supported Profiles SDOHCC ServiceRequest Y Y y? y? _id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-info HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization Subscription Supported Profiles http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription y? Y $status Task Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management Y Y Y Y _id, _lastUpdated, code, owner, patient, requester, status, focus, output Task:focus, Task:output, HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization Resource Conformance: SHALL CareTeam Core FHIR Resource CareTeam Reference Policy literal Interaction summary MAY support read Allows downstream coordination platforms or referral recipients to retrieve a CareTeam that is the intended performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved CareTeams that are the intended performer of ServiceRequests. Supported Profiles US Core CareTeam Profileversion: 7.0.0) Documentation Used to allow downstream systems to access to information about the intended performer of a ServiceRequest when the performer is a specific team of people Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Condition Core FHIR Resource Condition Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve a Condition that is the requester or performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Conditions that are referenced by ServiceRequests. MAY support create Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. update Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. Supported Profiles SDOHCC Condition Documentation Used to allow downstream systems to access to information about a patient's SDOH-related conditions, particularly those that are the reason for a referral Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering to only SDOH-related conditions SHALL patient reference Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD clinical-status token Allows filtering to only active conditions SHOULD code token Allows filtering to only specific SDOH conditions or sets of conditions SHOULD verification-status token Allows filtering to exclude refuted or entered-in-error conditions Resource Conformance: SHALL Consent Core FHIR Resource Consent Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Consents related to ServiceRequests of interest. MAY support create Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. update Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. Supported Profiles SDOHCC Consent Documentation Used to allow access to the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates SHALL source-reference reference Allows including the document that contains the PDF or similar representation of a paper consent SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Device Core FHIR Resource Device Reference Policy literal Interaction summary SHOULD support read Allows downstream coordination platforms or referral recipients to retrieve a Device that is the requester or intended performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Devices that are the requester or intended performer of ServiceRequests. Supported Profiles Device Documentation Used to allow retrieval of the requester or intended performer of an SDOH ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL DocumentReference Core FHIR Resource DocumentReference Reference Policy literal Interaction summary SHALL support create Allows the app to record a new PDF (e.g. a completed form) read Allows downstream coordination platforms or referral recipients to retrieve a PDF or similar content referenced by a Consent or Task. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated. SHOULD support update Allows the system to revise a previously stored PDF Supported Profiles US Core DocumentReference Profileversion: 7.0.0) Documentation Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Goal Core FHIR Resource Goal Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve a goal referenced by a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Goals in the event they are updated. MAY support create Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. update Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. Supported Profiles SDOHCC Goal Documentation Used to allow access to goals related to an SDOH referral Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering to only include SDOH-related goals SHALL patient reference Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD achievement-status token Allows filtering to only include unmet goals SHOULD lifecycle-status token Allows filtering to only include active goals SHOULD target-date date Allows filtering based on when a particular goal is desired to be achieved Resource Conformance: SHALL Group Core FHIR Resource Group Reference Policy literal Interaction summary SHALL support read Allows a payer or other oversight agency to a Group whose identity is already known (e.g. for polling). search-type Allows a payer or oversight agency to search for groups of interest to allow monitoring of what patients are under care/management for SDOH issues. Supported Profiles SDOHCC Group Documentation Exposes information about which patients associated with a particular payor coverage type currently have SDOH concerns under management Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Group records - and more specifically, retrieving more than one in a single call to poll for updates SHALL code token Allows filtering based on the type of group SHALL member reference Allows performing an _include to retrieve the members of the group SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD characteristic-value composite Allows filtering based on the insurer or plan associated with the group SHOULD managing-entity reference Allows filtering based on who is maintaining the group Resource Conformance: SHALL HealthcareService Core FHIR Resource HealthcareService Reference Policy literal Interaction summary SHOULD support read Allows downstream coordination platforms or referral recipients to retrieve a HealthcareService that is the intended performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved HealthcareServices that are the intended performer of ServiceRequests. Supported Profiles SDOHCC Healthcare Service Documentation Used to allow downstream systems to access to information about the intended performer of a ServiceRequest when the performer is a specific service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates SHALL location reference Allows retrieval of the phyical site(s) associated with a HealthService SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Location Core FHIR Resource Location Reference Policy literal Interaction summary SHOULD support read Allows other systems to retrieve a Location that is an available location for a service. MAY support search-type Allows the monitoring of previously-retrieved Locations that are the intended locations for services. Supported Profiles SDOHCC Location Documentation Used to expose information about the potential sites at which a requested service might be performed. Allows a patient to evaluate the suitability of a proposed activity or service. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Observation Core FHIR Resource Observation Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve an Observation referenced by a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Observations for updates/corrections. MAY support create Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. update Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response SDOHCC Observation Ethnicity OMB SDOHCC Observation Race OMB SDOHCC Observation Gender Identity SDOHCC Observation Personal Characteristic SDOHCC Observation Personal Pronouns SDOHCC Observation Recorded Sex Gender SDOHCC Observation Sexual Orientation Documentation 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 Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering for only SDOH-related observations SHALL patient reference Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific SHALL status token Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error) SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD code token Allows filtering for specific types of observations SHOULD date date Allows filtering for observations that held in a particular time period SHOULD derived-from reference Allows filtering for observations derived from a particular QuestionnaireResponse MAY code-value-concept composite Allows filtering for observations that have a specific coded value answer for a specified observation type Resource Conformance: SHOULD Organization Core FHIR Resource Organization Reference Policy literal Interaction summary SHOULD support read Allows downstream coordination platforms or referral recipients to retrieve an Organization that is the requester or intended performer of a ServiceRequest. Supports search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Organizations that are the requester or intended performer of ServiceRequests. Supported Profiles US Core Organization Profileversion: 7.0.0) Documentation Used to allow downstream systems to access to information about an Organization that is the requester or intended performer of a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates SHALL _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Patient Core FHIR Resource Patient Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve the Patient that is the subject of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Patients. Supported Profiles US Core Patient Profileversion: 7.0.0) Documentation Used to allow downstream systems to access to information about the Patient that is the subject a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL Practitioner Core FHIR Resource Practitioner Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests. Supported Profiles US Core Practitioner Profileversion: 7.0.0) Documentation Used to allow downstream systems to access to information about an Practitioner that is the requester or intended performer of a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL PractitionerRole Core FHIR Resource PractitionerRole Reference Policy literal Interaction summary SHALL support read Allows downstream coordination platforms or referral recipients to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests. Supported Profiles SDOHCC PractitionerRole Documentation Used to allow downstream systems to access to information about an PractitionerRole that is the requester or intended performer of a ServiceRequest Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD organization reference Allows doing an _include on Organization when retrieving the PractitionerRole SHOULD practitioner reference Allows doing an _include on Practitioner when retrieving the PractitionerRole Resource Conformance: SHALL Procedure Core FHIR Resource Procedure Reference Policy literal Interaction summary SHALL support create Allows downstream coordination platforms and referral recipients to write records of procedures done in response to a referral in situations where they can't store the procedure on their own local system. update Allows downstream coordination platforms and referral recipients to update records of procedures done - e.g. changing status, adding notes. read Allows upstream systems to retrieve procedures referenced by Tasks. search-type Allows upstream systems to check for updates on Procedures after they've already been received or to look for procedures that haven't yet been linked as outputs to the Tasks that initiated the work. Supported Profiles SDOHCC Procedure Documentation Used to allow downstream coordination platforms and referral recipients to provide information about actions that have been performed as a result of a referral as well as to allow upstream systems to access that information. Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates SHALL based-on reference Allows filtering for procedures resulting from a particular service request SHALL category token Allows filtering for procedures that are SDOH-related SHALL patient reference Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific. SHALL performer reference Allows filtering for procedures based on who delivered the procedure. SHALL status token Allows filtering for procedures that are complete or in progress SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD code token Allows filtering for procedures based on the specific service delivered SHOULD date date Allows filtering for procedures based on when they were delivered Resource Conformance: SHALL Questionnaire Core FHIR Resource Questionnaire Reference Policy literal Interaction summary MAY support search-type Allows SMART apps or downstream systems to search for questionnaires relevant to a patient context. Supported Profiles Extractable Questionnaire - StructureMap Documentation Used to allow retrieval of SDOH-related Questionnaires to be filled out by a patient or representative. Also allows retrieving Questionnaires associated with existing QuestionnaireResponses for editing by SMART-on-FHIR apps. Search Parameters Conformance Parameter Type Documentation SHALL url uri Allows retrieving Questionnaires based on its canonical URL SHALL version token Allows retrieving a specific version of a Questionnaire SHOULD code token Allows filtering for questionnaires associated with particular LOINC or similar codes SHOULD context-type-value composite Allows filtering for procedures that are SDOH-related SHOULD identifier token Allows retrieving Questionnaires with a known identifier SHOULD publisher string Allows retrieving Questionnaires based on who is responsible for them SHOULD status token Allows retrieving Questionnaires that are active (and not draft or required) SHOULD subject-type token Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc. SHOULD title string Allows retrieving Questionnaires based on the name of the form Extended Operations Conformance Operation Documentation MAY $populate Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere Resource Conformance: SHALL QuestionnaireResponse Core FHIR Resource QuestionnaireResponse Reference Policy literal Interaction summary SHOULD support create Allows questionnaire responses to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. update Allows questionnaire responses to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. read Allows the retrieval of QuestionnaireResponses to use as a starting point for new responses or to continue editing. search-type Allows checking for updates in previously retrieved QuestionnaireResponses. Supported Profiles SDC Questionnaire Response Documentation Used to allow SMART apps to cread, update and retrieve QuestionnaireResponses relevant to SDOH care Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates SHALL author reference Allows filtering QuestionnaireResponses previously created/edited by a particular individual SHALL patient reference Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific SHALL questionnaire reference Allows retrieving QuestionnaireResponses that have been completed against a specified form SHALL status token Allows retrieving QuestionnaireResponses that are complete (or incomplete) SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD authored date Allows filtering for QuestionnaireResponses by when they were created/last edited Resource Conformance: SHALL RelatedPerson Core FHIR Resource RelatedPerson Reference Policy literal Interaction summary MAY support read Allows downstream coordination platforms or referral recipients to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest. search-type Allows downstream coordination platforms or referral recipients to monitor previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests. Supported Profiles RelatedPerson Documentation Used to allow downstream systems to access to information about the requester or intended performer of a ServiceRequest when they are someone with a personal relationship to the Patient Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates SHOULD _lastUpdated date Allows filtering for only records that have changed since last query Resource Conformance: SHALL ServiceRequest Core FHIR Resource ServiceRequest Reference Policy literal Interaction summary SHALL support read Allows client systems to retrieve the ServiceRequest pointed to by a Task. search-type Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling. MAY support create Allows records to be authored by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. update Allows records to be edited by a SMART app if the manager system does not have the capability itself - or finds it better to use a third-party interface. Supported Profiles SDOHCC ServiceRequest Documentation Used to allow retrieval of an order for SDOH-related services Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates SHALL category token Allows filtering to only retrieve ServiceRequests that are SDOH-related SHALL intent token Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc. SHALL patient reference Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific SHALL status token Allows filtering to retrieve only active ServiceRequests SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD code token Allows filtering to retrieve ServiceRequests for specific types of services SHOULD occurrence date Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided SHOULD performer reference Allows filtering to retrieve only ServiceRequests that designate a specific performer SHOULD requester reference Allows filtering to retrieve only ServiceRequests created by a specific practitioner SHOULD supporting-info reference Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent Resource Conformance: SHOULD Subscription Core FHIR Resource Subscription Reference Policy Interaction summary SHOULD support create Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things) MAY support update Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc. Supported Profiles http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription Documentation Used to allow upstream and occasionally downstream systems to subscribe to and monitor Tasks this system for change Extended Operations Conformance Operation Documentation SHOULD $status Allows upstream systems to verify their subscription is functioning properly and to check for errors Resource Conformance: SHALL Task Core FHIR Resource Task Reference Policy literal Interaction summary SHALL support create Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest. 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. Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management Documentation Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests or 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 Search Parameters Conformance Parameter Type Documentation SHALL _id token Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates SHALL code token Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables. SHALL patient reference Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.) SHALL requester reference Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system SHALL status token Allows filtering to only active or completed tasks SHALL focus reference Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest SHOULD _lastUpdated date Allows filtering for only records that have changed since last query SHOULD owner reference Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned) SHOULD output reference Allows for the 'output' of a Task to be included when retrieving a Task
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](CapabilityStatement-SDOHCC-ReferralSource.html) and also the initiation and management of referral fulfillment Tasks subsequently directed out to [Referral Recipients](CapabilityStatement-SDOHCC-ReferralRecipient.html). 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.
The clinical care coordinator needs to receive information from and update information in SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html).
Implementations must meet the general privacy & security requirements documented in [this implementation guide](privacy_and_security.html).
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
Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.
Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering for only records that have changed since last query
Used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral
Allows the system to retrieve a Condition that is the reason for a ServiceRequest.
Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.
Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering to only SDOH-related conditions
Allows filtering to only active conditions
Allows filtering to only specific SDOH conditions or sets of conditions
Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific
Allows filtering to exclude refuted or entered-in-error conditions
Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities
Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.
Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.
Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates
Allows including the document that contains the PDF or similar representation of a paper consent
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
Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.
Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates
Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.
Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.
Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.
Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates
Used to access goals related to an SDOH referral
Allows the system to retrieve a goal referenced by a ServiceRequest.
Allows the monitoring of previously-retrieved Goals in the event they are updated.
Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering to only include unmet goals
Allows filtering to only include SDOH-related goals
Allows filtering to only include active goals
Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific
Allows filtering based on when a particular goal is desired to be achieved
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.
Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.
Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates
Allows retrieval of the phyical site(s) associated with a HealthService
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.
Allows the system to retrieve a Location that is an available location for a service.
Allows the monitoring of previously-retrieved Locations that are the intended locations for services.
Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates
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.
Allows the system to retrieve an Observation referenced by a ServiceRequest or associated with the patient.
Allows the monitoring of previously-retrieved Observations for updates/corrections.
Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering for only SDOH-related observations
Allows filtering for specific types of observations
Allows filtering for observations that have a specific coded value answer for a specified observation type
Allows filtering for observations that held in a particular time period
Allows filtering for observations derived from a particular QuestionnaireResponse
Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific
Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)
Used to access information about an Organization that is the requester or intended performer of a ServiceRequest
Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.
Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates
Used to access information about the Patient that is the subject a ServiceRequest
Allows the system to retrieve the Patient that is the subject of a ServiceRequest.
Allows the monitoring of previously-retrieved Patients.
Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates
Used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest
Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.
Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates
Used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest
Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.
Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates
Allows doing an _include on Organization when retrieving the PractitionerRole
Allows doing an _include on Practitioner when retrieving the PractitionerRole
Used to access information about actions that have been performed as a result of a referral
Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.
Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.
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.
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.
Allows retrieving known Proceddure records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering for procedures resulting from a particular service request
Allows filtering for procedures that are SDOH-related
Allows filtering for procedures based on the specific service delivered
Allows filtering for procedures based on when they were delivered
Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.
Allows filtering for procedures based on who delivered the procedure.
Allows filtering for procedures that are complete or in progress
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.
Allows the coordination platform to search for questionnaires relevant to a patient context.
Allows filtering for questionnaires associated with particular LOINC or similar codes
Allows retrieving Questionnaires with a known identifier
Allows retrieving Questionnaires based on who is responsible for them
Allows retrieving Questionnaires that are active (and not draft or required)
Allows retrieving Questionnaires that are intended to be completed about patients - as opposed to practitioner, organizations, etc.
Allows retrieving Questionnaires based on the name of the form
Allows retrieving Questionnaires based on its canonical URL
Allows retrieving a specific version of a Questionnaire
Allows SMART on FHIR or other systems to pre-populate a questionnaire response with existing information either available locally or queried from elsewhere
Used to allow QuestionnaireResponses referenced by a ServiceRequest or Task
Allows the retrieval of QuestionnaireResponses pointed to as supporting information by a ServiceRequest or as output of a Task.
Allows checking for updates in previously retrieved QuestionnaireResponses.
Allows retrieving known QuestionnaireResponse records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering QuestionnaireResponses previously created/edited by a particular individual
Allows filtering for QuestionnaireResponses by when they were created/last edited
Allows retrieving QuestionnaireResponses associated with a particular patient. Some systems may only permit searches that are patient-specific
Allows retrieving QuestionnaireResponses that have been completed against a specified form
Allows retrieving QuestionnaireResponses that are complete (or incomplete)
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
Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.
Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.
Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates
Used to retrieve an order for SDOH-related services
Allows client systems to retrieve the ServiceRequest pointed to by a Task.
Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.
Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering to only retrieve ServiceRequests that are SDOH-related
Allows filtering to retrieve ServiceRequests for specific types of services
Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.
Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided
Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific
Allows filtering to retrieve only ServiceRequests that designate a specific performer
Allows filtering to retrieve only ServiceRequests created by a specific practitioner
Allows filtering to retrieve only active ServiceRequests
Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent
Used to monitor updates to Tasks on downstream systems
Necessary if using subscriptions to monitor updates to the Task
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
Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors
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.
Allows the coordination platform system to create tasks on a delivery system (or downstream coordination system).
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.
Allows the coordination platform to poll a single Task for changes.
Allows the coordination platform to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.
Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates
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.
Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)
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.)
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
Allows filtering to only active or completed tasks
Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest
Allows for the 'output' of a Task to be included when retrieving a Task
Allows polling for changes to multiple resource types simultaneously
Coordinating systems and service providers will frequently need to access information from the SDOH clinical care manager.
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
Allows downstream coordination platforms or referral recipients to retrieve a CareTeam that is the intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved CareTeams that are the intended performer of ServiceRequests.
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
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.
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.
Allows downstream coordination platforms or referral recipients to retrieve a Condition that is the requester or performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Conditions that are referenced by ServiceRequests.
Used to allow access to the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities
Allows downstream coordination platforms or referral recipients to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Consents related to ServiceRequests of interest.
Used to allow retrieval of the requester or intended performer of an SDOH ServiceRequest
Allows downstream coordination platforms or referral recipients to retrieve a Device that is the requester or intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Devices that are the requester or intended performer of ServiceRequests.
Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms.
Allows the app to record a new PDF (e.g. a completed form)
Allows the system to revise a previously stored PDF
Allows downstream coordination platforms or referral recipients to retrieve a PDF or similar content referenced by a Consent or Task.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.
Used to allow access to goals related to an SDOH referral
Allows downstream coordination platforms or referral recipients to retrieve a goal referenced by a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Goals in the event they are updated.
Exposes information about which patients associated with a particular payor coverage type currently have SDOH concerns under management
Allows a payer or other oversight agency to a Group whose identity is already known (e.g. for polling).
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.
Allows retrieving known Group records - and more specifically, retrieving more than one in a single call to poll for updates
Allows filtering based on the insurer or plan associated with the group
Allows filtering based on the type of group
Allows filtering based on who is maintaining the group
Allows performing an _include to retrieve the members of the group
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.
Allows downstream coordination platforms or referral recipients to retrieve a HealthcareService that is the intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.
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.
Allows other systems to retrieve a Location that is an available location for a service.
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
Allows downstream coordination platforms or referral recipients to retrieve an Observation referenced by a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Observations for updates/corrections.
Used to allow downstream systems to access to information about an Organization that is the requester or intended performer of a ServiceRequest
Allows downstream coordination platforms or referral recipients to retrieve an Organization that is the requester or intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.
Used to allow downstream systems to access to information about the Patient that is the subject a ServiceRequest
Allows downstream coordination platforms or referral recipients to retrieve the Patient that is the subject of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Patients.
Used to allow downstream systems to access to information about an Practitioner that is the requester or intended performer of a ServiceRequest
Allows downstream coordination platforms or referral recipients to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.
Used to allow downstream systems to access to information about an PractitionerRole that is the requester or intended performer of a ServiceRequest
Allows downstream coordination platforms or referral recipients to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.
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.
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.
Allows downstream coordination platforms and referral recipients to update records of procedures done - e.g. changing status, adding notes.
Allows upstream systems to retrieve procedures referenced by Tasks.
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.
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.
Allows SMART apps or downstream systems to search for questionnaires relevant to a patient context.
Used to allow SMART apps to cread, update and retrieve QuestionnaireResponses relevant to SDOH care
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.
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.
Allows the retrieval of QuestionnaireResponses to use as a starting point for new responses or to continue editing.
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
Allows downstream coordination platforms or referral recipients to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.
Allows downstream coordination platforms or referral recipients to monitor previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.
Used to allow retrieval of an order for SDOH-related services
Used to allow upstream and occasionally downstream systems to subscribe to and monitor Tasks this system for change
Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)
Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.
Allows upstream systems to verify their subscription is functioning properly and to check for errors
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
Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest.
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).
Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.
Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.
Allows other systems to poll for changes to multiple resource types simultaneously