SDOHCC-ReferralRecipient
type: CapabilityStatement
node role: treeRoot
id:
  v: SDOHCC-ReferralRecipient
language:
  v: en
text:
  status:
    v: extensions
  div: Generated Narrative: CapabilityStatement SDOHCC-ReferralRecipient SDOHCC Referral Recipient Implementation Guide Version: 3.0.0-draft 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 referral recipient needs to access information from and update information in SDOH clinical care referral sources and/or coordination platforms that have solicited the filling of SDOH-related referrals by this system 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, clinica…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
  value: code
    v: pc
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
  value: integer
    v: 2
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value: canonical
        v: http://hl7.org/fhir/us/sdoh-clinicalcare/ImplementationGuide/hl7.fhir.us.sdoh-clinicalcare
        link: http://hl7.org/fhir/us/sdoh-clinicalcare/ImplementationGuide/hl7.fhir.us.sdoh-clinicalcare
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value: code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value: canonical
        v: http://hl7.org/fhir/us/sdoh-clinicalcare/ImplementationGuide/hl7.fhir.us.sdoh-clinicalcare
        link: http://hl7.org/fhir/us/sdoh-clinicalcare/ImplementationGuide/hl7.fhir.us.sdoh-clinicalcare
url:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient
version:
  v: 3.0.0-draft
name:
  v: SDOHCC_ReferralRecipient
title:
  v: SDOHCC Referral Recipient
status:
  v: active
date:
  v: 2021-06
publisher:
  v: HL7 International / Patient Care
contact:
  name:
    v: HL7 International / Patient Care
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/patientcare
  telecom:
    system:
      v: email
description:
  v: This resource describes the required and desired behavior of systems acting as SDOH clinical care 'referral recipients'. These are typically community-based organizations that can provide services such as food bank access, housing remediation, etc.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: US
    display:
      v: United States of America
purpose:
  v: In some cases, a referral recipient might actually further refer the patient to a downstream service provider through non-FHIR means. In such cases, the system is still treated as a 'referral recipient' rather than a [Coordination Platform](CapabilityStatement-SDOHCC-CoordinationPlatform.html) because, from a FHIR interface perspective, the referral process 'stops' with that system. Referral recipients must be able to receive or monitor for Tasks issued by [Referral Sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [Coordination Platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html). They must also be able to respond to access the ServiceRequest representing the referral pointed to by the Task and any relevant information referenced by the referral, update the Task with their acceptance or rejection of the referral, and finally provide information about what interventions were actually performed using the Procedure resource.\n\n There are actually two types of referral recipients defined in this implementation guide. This CapabilityStatement describes the expected behavior of more sophisticated service delivery systems that are capable of exposing a FHIR service and persisting Tasks and Procedures in their own environment. A separate set of interface expectations is defined for ['Light' Referral Recipients](CapabilityStatement-SDOHCC-ReferralRecipientLight.html) that are not capable of exposing an endpoint and where the Task and any resulting Procedures must be stored in the requesting system's database.
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: xml
format:
  v: json
rest:
  mode:
    v: client
  documentation:
    v: The clinical care referral recipient needs to access information from and update information in SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html) and/or [coordination platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) that have solicited the filling of SDOH-related referrals by this system
  security:
    description:
      v: Implementations must meet the general privacy & security requirements documented in [this implementation guide](privacy_and_security.html).
  resource:
    type:
      v: CareTeam
    supported profile:
      v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|7.0.0
      link: 7.0
      link: .0
      extension:
        value: code
    documentation:
      v: For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific team of people. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses
    interaction:
      extension:
        value: code
      code:
        v: read
      documentation:
        v: Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.
    interaction:
      extension:
        value: code
      code:
        v: search-type
      documentation:
        v: Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.
    reference policy:
      v: literal
    search param:
      extension:
        value: code
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates
    search param:
      extension:
        value: code
      name:
        v: _lastUpdated
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
        link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
      type:
        v: date
      documentation:
        v: Allows filtering for only records that have changed since last query
  resource:
    type:
      v: Condition
    supported profile:
      v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition
      link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition
      extension:
        value: code
    documentation:
      v: For referral sources that receive referrals from upstream systems, used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral
    interaction:
      extension:
        value: code
      code:
        v: read
      documentation:
        v: Allows the system to retrieve a Condition that is the reason for a ServiceRequest.
    interaction:
      extension:
        value: code
      code:
        v: search-type
      documentation:
        v: Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.
    reference policy:
      v: literal
    search param:
      extension:
        value: code
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates
    search param:
      extension:
        value: code
      name:
        v: _lastUpdated
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
        link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
      type:
        v: date
      documentation:
        v: Allows filtering for only records that have changed since last query
    search param:
      extension:
        value: code
      name:
        v: category
      definition:
        v: http://hl7.org/fhir/SearchParameter/Condition-category
        link: http://hl7.org/fhir/SearchParameter/Condition-category
      type:
        v: token
      documentation:
        v: Allows filtering to only SDOH-related conditions

v: SMART-on-FHIR

code
v: SHALL

code
v: MAY

code
v: MAY

code
v: SHALL

code
v: SHOULD

code
v: SHALL

code
v: SHALL

code
v: SHOULD

code
v: SHALL

code
v: SHOULD

code
v: SHALL

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: clinical-status
definition:
  v: http://hl7.org/fhir/SearchParameter/Condition-clinical-status
  link: http://hl7.org/fhir/SearchParameter/Condition-clinical-status
type:
  v: token
documentation:
  v: Allows filtering to only active conditions

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: code
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-code
  link: http://hl7.org/fhir/SearchParameter/clinical-code
type:
  v: token
documentation:
  v: Allows filtering to only specific SDOH conditions or sets of conditions

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: patient
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-patient
  link: http://hl7.org/fhir/SearchParameter/clinical-patient
type:
  v: reference
documentation:
  v: Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: verification-status
definition:
  v: http://hl7.org/fhir/SearchParameter/Condition-verification-status
  link: http://hl7.org/fhir/SearchParameter/Condition-verification-status
type:
  v: token
documentation:
  v: Allows filtering to exclude refuted or entered-in-error conditions

type:
  v: Consent
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.
reference policy:
  v: literal
search include:
  v: Consent:source-reference:DocumentReference
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: source-reference
  definition:
    v: http://hl7.org/fhir/SearchParameter/Consent-source-reference
    link: http://hl7.org/fhir/SearchParameter/Consent-source-reference
  type:
    v: reference
  documentation:
    v: Allows including the document that contains the PDF or similar representation of a paper consent

type:
  v: Device
supported profile:
  v: http://hl7.org/fhir/StructureDefinition/Device
  link: http://hl7.org/fhir/StructureDefinition/Device
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: 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
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: DocumentReference
supported profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|7.0.0
  link: 7.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: Goal
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: Used to access goals related to an SDOH referral
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a goal referenced by a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Goals in the event they are updated.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: achievement-status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Goal-achievement-status
    link: http://hl7.org/fhir/SearchParameter/Goal-achievement-status
  type:
    v: token
  documentation:
    v: Allows filtering to only include unmet goals
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/Goal-category
    link: http://hl7.org/fhir/SearchParameter/Goal-category
  type:
    v: token
  documentation:
    v: Allows filtering to only include SDOH-related goals
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: lifecycle-status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status
    link: http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status
  type:
    v: token
  documentation:
    v: Allows filtering to only include active goals
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: target-date
  definition:
    v: http://hl7.org/fhir/SearchParameter/Goal-target-date
    link: http://hl7.org/fhir/SearchParameter/Goal-target-date
  type:
    v: date
  documentation:
    v: Allows filtering based on when a particular goal is desired to be achieved

type:
  v: HealthcareService
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: location
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-location
    link: http://hl7.org/fhir/SearchParameter/HealthcareService-location
  type:
    v: reference
  documentation:
    v: Allows retrieval of the phyical site(s) associated with a HealthService

type:
  v: Location
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: 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.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a Location that is an available location for a service.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Locations that are the intended locations for services.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: Observation
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral as well as certain SDOH-relevant demographic information
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve an Observation referenced by a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Observations for updates/corrections.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-category
    link: http://hl7.org/fhir/SearchParameter/Observation-category
  type:
    v: token
  documentation:
    v: Allows filtering for only SDOH-related observations
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  type:
    v: token
  documentation:
    v: Allows filtering for specific types of observations
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: code-value-concept
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-code-value-concept
    link: http://hl7.org/fhir/SearchParameter/Observation-code-value-concept
  type:
    v: composite
  documentation:
    v: Allows filtering for observations that have a specific coded value answer for a specified observation type
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-date
    link: http://hl7.org/fhir/SearchParameter/clinical-date
  type:
    v: date
  documentation:
    v: Allows filtering for observations that held in a particular time period
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: derived-from
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-derived-from
    link: http://hl7.org/fhir/SearchParameter/Observation-derived-from
  type:
    v: reference

v: Allows filtering for observations derived from a particular QuestionnaireResponse

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: patient
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-patient
  link: http://hl7.org/fhir/SearchParameter/clinical-patient
type:
  v: reference
documentation:
  v: Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: status
definition:
  v: http://hl7.org/fhir/SearchParameter/Observation-status
  link: http://hl7.org/fhir/SearchParameter/Observation-status
type:
  v: token
documentation:
  v: Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)

type:
  v: Organization
supported profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|7.0.0
  link: 7.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about an Organization that is the requester or intended performer of a ServiceRequest
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: Patient
supported profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|7.0.0
  link: 7.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about the Patient that is the subject a ServiceRequest
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve the Patient that is the subject of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Patients.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: Practitioner
supported profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0
  link: 7.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: PractitionerRole
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-practitionerrole
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-practitionerrole
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.
reference policy:
  v: literal
search include:
  v: PractitionerRole:organization
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: PractitionerRole:practitioner
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: organization
  definition:
    v: http://hl7.org/fhir/SearchParameter/PractitionerRole-organization
    link: http://hl7.org/fhir/SearchParameter/PractitionerRole-organization
  type:
    v: reference
  documentation:
    v: Allows doing an _include on Organization when retrieving the PractitionerRole
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: practitioner
  definition:
    v: http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner
    link: http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner
  type:
    v: reference
  documentation:
    v: Allows doing an _include on Practitioner when retrieving the PractitionerRole

type:
  v: Procedure
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: Used to record information about actions that have been performed as a result of a referral
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: create
  documentation:
    v: Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: update
  documentation:
    v: Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows the referral recipient to retrieve procedures referenced by Tasks previously posted.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows the referral recipient to check if others have updated (e.g. added comments) to procedures previously posted and/or to find previously submitted procedures so they can be rendered to a user.
versioning:
  v: versioned-update
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: based-on
  definition:
    v: http://hl7.org/fhir/SearchParameter/Procedure-based-on
    link: http://hl7.org/fhir/SearchParameter/Procedure-based-on
  type:
    v: reference
  documentation:
    v: Allows filtering for procedures resulting from a particular service request
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/Procedure-category
    link: http://hl7.org/fhir/SearchParameter/Procedure-category
  type:
    v: token
  documentation:
    v: Allows filtering for procedures that are SDOH-related
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  type:
    v: token
  documentation:
    v: Allows filtering for procedures based on the specific service delivered
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-date
    link: http://hl7.org/fhir/SearchParameter/clinical-date
  type:
    v: date
  documentation:
    v: Allows filtering for procedures based on when they were delivered
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: performer
  definition:
    v: http://hl7.org/fhir/SearchParameter/Procedure-performer
    link: http://hl7.org/fhir/SearchParameter/Procedure-performer
  type:
    v: reference
  documentation:
    v: Allows filtering for procedures based on who delivered the procedure.
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Procedure-status
    link: http://hl7.org/fhir/SearchParameter/Procedure-status
  type:
    v: token
  documentation:
    v: Allows filtering for procedures that are complete or in progress

type:
  v: RelatedPerson
supported profile:
  v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to access information about the requester or intended performer of a ServiceRequest when they are someone with a personal relationship to the Patient. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
  documentation:
    v: Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
  documentation:
    v: Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.
reference policy:
  v: literal
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query

type:
  v: ServiceRequest
supported profile:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: For referral sources that receive referrals from upstream systems, used to retrieve an order for SDOH-related services
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
  documentation:
    v: Allows client systems to retrieve the ServiceRequest pointed to by a Task.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: search-type
  documentation:
    v: Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.
reference policy:
  v: literal
search include:
  v: HealthCareService:location
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
search include:
  v: ServiceRequest:supporting-info
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: ServiceRequest:pertains-to-goal
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: ServiceRequest:patient
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: ServiceRequest:requester
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: ServiceRequest:performer
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: PractitionerRole:practitioner
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search include:
  v: PractitionerRole:organization
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: Allows filtering for only records that have changed since last query
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-category
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-category
  type:
    v: token
  documentation:
    v: Allows filtering to only retrieve ServiceRequests that are SDOH-related
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  type:
    v: token
  documentation:
    v: Allows filtering to retrieve ServiceRequests for specific types of services
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: intent
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-intent
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-intent
  type:
    v: token
  documentation:
    v: Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: occurrence
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence
  type:
    v: date
  documentation:
    v: Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD

v: performer

v: reference

v: Allows filtering to retrieve only ServiceRequests that designate a specific performer

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: requester
definition:
  v: http://hl7.org/fhir/SearchParameter/ServiceRequest-requester
  link: http://hl7.org/fhir/SearchParameter/ServiceRequest-requester
type:
  v: reference
documentation:
  v: Allows filtering to retrieve only ServiceRequests created by a specific practitioner

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: status
definition:
  v: http://hl7.org/fhir/SearchParameter/ServiceRequest-status
  link: http://hl7.org/fhir/SearchParameter/ServiceRequest-status
type:
  v: token
documentation:
  v: Allows filtering to retrieve only active ServiceRequests

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: supporting-info
definition:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/ServiceRequest-supporting-info
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/ServiceRequest-supporting-info
type:
  v: reference
documentation:
  v: Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent

type:
  v: Subscription
supported profile:
  v: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription
  link: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: Used to allow upstream systems to subscribe to and monitor Tasks stored on this system for change
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: create
  documentation:
    v: Necessary if using subscriptions to monitor updates to the Task
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
  documentation:
    v: 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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
    link: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
  documentation:
    v: Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
code:
  v: batch
documentation:
  v: Allows polling for changes to multiple resource types simultaneously

mode:
  v: server
documentation:
  v: The clinical care referral recipient needs to allow SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [coordination platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) to have solicited the filling of SDOH-related referrals by this system and also to access Procedures that describe interventions taken by the users of this system.
security:
  service:
    coding:
      system:
        v: http://terminology.hl7.org/CodeSystem/restful-security-service
      code:
        v: SMART-on-FHIR
  description:
    v: Implementations must meet the general privacy & security requirements documented in [this implementation guide](privacy_and_security.html).
resource:
  type:
    v: DocumentReference
  supported profile:
    v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|7.0.0
    link: 7.0
    link: .0
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
  documentation:
    v: Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms.
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    code:
      v: create
    documentation:
      v: Allows the app to record a new PDF (e.g. a completed form)
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHOULD
    code:
      v: update
    documentation:
      v: Allows the system to revise a previously stored PDF
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    code:
      v: read
    documentation:
      v: Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task.
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    code:
      v: search-type
    documentation:
      v: Allows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.
  reference policy:
    v: literal
  search param:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    name:
      v: _id
    definition:
      v: http://hl7.org/fhir/SearchParameter/Resource-id
      link: http://hl7.org/fhir/SearchParameter/Resource-id
    type:
      v: token
    documentation:
      v: Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates
  search param:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHOULD
    name:
      v: _lastUpdated
    definition:
      v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
      link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    type:
      v: date
    documentation:
      v: Allows filtering for only records that have changed since last query
resource:
  type:
    v: Subscription
  supported profile:
    v: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription
    link: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
  documentation:
    v: Used to allow upstream coordination platforms and referral sources to subscribe to and monitor Tasks created on this system
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHOULD
    code:
      v: create
    documentation:
      v: Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: MAY
    code:
      v: update
    documentation:
      v: Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.
  operation:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHOULD
    name:
      v: status
    definition:
      v: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
      link: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
    documentation:
      v: Allows upstream systems to verify their subscription is functioning properly and to check for errors
resource:
  type:
    v: Task
  supported profile:
    v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient
    link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
  supported profile:
    v: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement
    link: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
  documentation:
    v: Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests. Also used by downstream referral recipiencts 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
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    code:
      v: create
    documentation:
      v: Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities.
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    code:
      v: update
    documentation:
      v: 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). ReferralRecipients can freely modify any Tasks they have created (though they should consider the impact of doing so on downstream recipients or the patient). However, if they are not the creator, they SHALL only modify tasks they are the 'owner' of and then, only modify Task.status, Task.statusReason, and Task.outputs are possible, and then only for Tasks where the owner is the patient.
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    code:
      v: read
    documentation:
      v: Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL

v: search-type

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

v: versioned-update

v: modified-since

v: literal

v: Task:output

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: _id
definition:
  v: http://hl7.org/fhir/SearchParameter/Resource-id
  link: http://hl7.org/fhir/SearchParameter/Resource-id
type:
  v: token
documentation:
  v: Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: _lastUpdated
definition:
  v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
type:
  v: date
documentation:
  v: Allows filtering for only records that have changed since last query

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: code
definition:
  v: http://hl7.org/fhir/SearchParameter/Task-code
  link: http://hl7.org/fhir/SearchParameter/Task-code
type:
  v: token
documentation:
  v: 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.

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: owner
definition:
  v: http://hl7.org/fhir/SearchParameter/Task-owner
  link: http://hl7.org/fhir/SearchParameter/Task-owner
type:
  v: reference
documentation:
  v: Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: patient
definition:
  v: http://hl7.org/fhir/SearchParameter/Task-patient
  link: http://hl7.org/fhir/SearchParameter/Task-patient
type:
  v: reference
documentation:
  v: 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.)

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: requester
definition:
  v: http://hl7.org/fhir/SearchParameter/Task-requester
  link: http://hl7.org/fhir/SearchParameter/Task-requester
type:
  v: reference
documentation:
  v: 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

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: status
definition:
  v: http://hl7.org/fhir/SearchParameter/Task-status
  link: http://hl7.org/fhir/SearchParameter/Task-status
type:
  v: token
documentation:
  v: Allows filtering to only active or completed tasks

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: focus
definition:
  v: http://hl7.org/fhir/SearchParameter/Task-focus
  link: http://hl7.org/fhir/SearchParameter/Task-focus
type:
  v: reference
documentation:
  v: Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: output
definition:
  v: http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference
  link: http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference
type:
  v: reference
documentation:
  v: Allows for the 'output' of a Task to be included when retrieving a Task

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
code:
  v: batch
documentation:
  v: Allows other systems to poll for changes to multiple resource types simultaneously