Package | ihe.pcc.rsq |
Type | CapabilityStatement |
Id | IHE.SDOH-RSQ.client |
FHIR Version | R4 |
Source | https://profiles.ihe.net/PCC/ReferralStatus/https://build.fhir.org/ig/IHE/PCC.SDOH.RSQ/CapabilityStatement-IHE.SDOH-RSQ.client.html |
URL | https://profiles.ihe.net/PCC/SDOH-RSQ/CapabilityStatement/IHE.SDOH-RSQ.client |
Version | 0.0.1-current |
Status | active |
Date | 2024-06-14 |
Name | IHE_Referral_Status_Consumer |
Title | IHE Referral Status Consumer |
Realm | uv |
Authority | ihe |
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. 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. |
Copyright | IHE http://www.ihe.net/Governance/#Intellectual_Property |
Kind | requirements |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.SDOH-RSQ.client
application/fhir+xml
, application/fhir+json
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.
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.
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
search-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
ServiceRequest | y | y | _id, identifier | ||||||
Task | y | y | _id, identifier |
resolves
read
, search-type
.Using FHIR search on the
ServiceRequest
resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | identifier | token | The business identifier representing the referral identifier |
Using FHIR search on the
Task
resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | identifier | token | The business identifier representing the referral identifier |
{ "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" } ] } ] }