FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/IHE.SDOH-RSQ.client

Packageihe.pcc.rsq
TypeCapabilityStatement
IdIHE.SDOH-RSQ.client
FHIR VersionR4
Sourcehttps://profiles.ihe.net/PCC/ReferralStatus/https://build.fhir.org/ig/IHE/PCC.SDOH.RSQ/CapabilityStatement-IHE.SDOH-RSQ.client.html
URLhttps://profiles.ihe.net/PCC/SDOH-RSQ/CapabilityStatement/IHE.SDOH-RSQ.client
Version0.0.1-current
Statusactive
Date2024-06-14
NameIHE_Referral_Status_Consumer
TitleIHE Referral Status Consumer
Realmuv
Authorityihe
DescriptionCapabilityStatement for the Referral Status Consumer Actor in the Patient Care Coordination Technical Framework Supplement PCC SDOH Referral Status Query. See https://profiles.ihe.net/PCC/TF/Volume1/ch-38.html. The IHE Profile text is Normative, this conformance resource is Informative. The Consumer obtains the status of an existing SDOH Referral by querying the SDOH Referral Status Provider based on the referral identifier. - The referral workflow and the various mechanisms on how the referral identifier is known to the consumer and the provider are out of scope. - The consumer may choose the entry point for the FHIR search, either a `ServiceRequest` or a `Task` resource.
CopyrightIHE http://www.ihe.net/Governance/#Intellectual_Property
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IHE.SDOH-RSQ.client

IHE Referral Status Consumer

  • Implementation Guide Version: 0.0.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-06-14
  • Published by: IHE Patient Care Coordination Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

The Referral Status Query Client has the capability to query a Server for the status of a previously accepted referral. The query is accomplished via FHIR Search against the ServiceRequest or Task resources. The choice of which resource is used depends on the architecture of the implementation.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
ServiceRequest yy_id, identifier
Task yy_id, identifier

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
resolves
Interaction summary
  • Supports read, search-type.

Documentation

Using FHIR search on the ServiceRequest resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

The business identifier representing the referral identifier

 

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
resolves
Interaction summary
  • Supports read, search-type.

Documentation

Using FHIR search on the Task resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

The business identifier representing the referral identifier

 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.SDOH-RSQ.client",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/PCC/SDOH-RSQ/CapabilityStatement/IHE.SDOH-RSQ.client",
  "version": "0.0.1-current",
  "name": "IHE_Referral_Status_Consumer",
  "title": "IHE Referral Status Consumer",
  "status": "active",
  "experimental": false,
  "date": "2024-06-14",
  "publisher": "IHE Patient Care Coordination Technical Committee",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ihe.net/ihe_domains/patient_care_coordination/"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "pcc@ihe.net"
        }
      ]
    },
    {
      "name": "IHE Patient Care Coordination Technical Committee",
      "telecom": [
        {
          "system": "email",
          "value": "pcc@ihe.net"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for the Referral Status Consumer Actor in the Patient Care Coordination Technical Framework Supplement PCC SDOH Referral Status Query. See https://profiles.ihe.net/PCC/TF/Volume1/ch-38.html. The IHE Profile text is Normative, this conformance resource is Informative. \n\nThe Consumer obtains the status of an existing SDOH Referral by querying the SDOH Referral Status Provider based on the referral identifier.\n- The referral workflow and the various mechanisms on how the referral identifier is known to the consumer and the provider are out of scope.\n- The consumer may choose the entry point for the FHIR search, either a `ServiceRequest` or a `Task` resource.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "The Referral Status Query Client has the capability to query a Server for the status of a previously accepted referral. The query is accomplished via FHIR Search against the ServiceRequest or Task resources. \nThe choice of which resource is used depends on the architecture of the implementation. ",
      "security": {
        "description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "ServiceRequest",
          "documentation": "Using FHIR search on the `ServiceRequest` resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token",
              "documentation": "The business identifier representing the referral identifier"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Task",
          "documentation": "Using FHIR search on the `Task` resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token",
              "documentation": "The business identifier representing the referral identifier"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}