IHE PaLM - Radiology Pathology Concordance (RPC)
0.1.0 - ci-build International flag

IHE PaLM - Radiology Pathology Concordance (RPC), published by IHE IT Infrastructure Technical Committee. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/IHE/PaLM.RPC/ and changes regularly. See the Directory of published versions

2.91. Retrieve Concordance Report Definition [LAB-91]

This section corresponds to transaction [LAB-91] of the IHE Technical Framework. Transaction [LAB-91] is used by the Content Data Structure Consumer and Content Data Structure Creator Actors. The [LAB-91] transaction describes how to retrieve a definition of a concordance report so that a concordance report can be created and/or validated.

Scope

The Retrieve Concordance Report Definition [LAB-91] transaction is used to obtain the FHIR Measure to structure and validate a given FHIR MeasureReport.

Actors Roles

Table: Actor Roles

Actor Role
Content Data Structure Creator The Content Data Structure Creator is responsible for the creation of a Measure Resource, which specifies the structure of a given MeasureReport
Content Data Structure Consumer A Content Data Structure Consumer is responsible for receiving the Measure Resource and validating its messages

Referenced Standards

FHIR-R4 HL7 FHIR Release 4.0

Interactions

Content Data Structure ConsumerContent Data Structure ConsumerContent Data Structure CreatorContent Data Structure CreatorRetrieve Concordance Report Definition [LAB-91]Concordance Report Definition Response [LAB-91]


Figure: Retrieve Concordance Report Definition Interactions

Retrieve Concordance Report Definitision Message

This transaction details the Content Data Structure Consumer requesting an RPC Measure from a Content Data Structure Creator. The Measure MAY be used by the Content Consumer to validate their RPC messages upon receipt. As such, it is expected that the Content Consumer and Content Data Structure Consumer MAY be bundled in most use cases.

The Retrieve Concordance Report Definition [LAB-91] is implemented as a FHIR Read transaction defined in the RESTful API implementation guide: https://www.hl7.org/fhir/http.html#read.

The format for this transaction is as follows: GET [base]/Measure/[id]

Trigger Events

A Content Data Structure Consumer sends a Retrieve Concordance Report Definition [LAB-91] as a request for a given Measure from a Content Data Structure Creator.

Message Semantics

The following table describes the messaging semantics for a Concordance Report Definition.

  Description
URL The RPC Profile does not prescribe the form of the URL to be advertised by a Content Consumer except that the scheme of the URL SHALL be “https”.
Headers The Read request SHALL contain a Content-type header identifying the payload
  Type:Content-type: application/ fhir+xml
  Type:Content-type: application/fhir+json
  The request MAY contain any additional headers. For example, a Content Creator may require an Authorization header.
BODY The body of an RPC Retrieve Data Structure request SHALL contain the ID of the requested Measure resource.
Expected Actions

The Content Data Structure Consumer SHALL send a request for a given Measure from the Content Data Structure Creator.

Retrieve Concordance Report Definition Response Message

This transaction defines the response given by a Content Data Structure Creator to a Content Data Structure Consumer. The Retrieve Concordance Report Definition [LAB-91] Response is implemented as a FHIR Read transaction defined in the RESTful API implementation guide: https://www.hl7.org/fhir/http.html#read.

An example Measure is provided in PaLM TF-3: Appendix A.1.

Trigger Events

A Content Data Structure Creator SHALL return a Report Concordance Definition Response if a Content Consumer has sent a Retrieve Concordance Report Definition Request.

Message Semantics

The Content Data Structure Creator SHALL conform to HTTPS standards and respond to the Retrieve Concordance Report Definition Request with the appropriate status code outlined in the table below.

Table 3.Y2.4.2.2-1: Retrieve Concordance Report Definition Result Status Codes
HTTP Status Code Interpretation
200 Retrieve Concordance Report Definition Request was successfully processed
202 Retrieve Concordance Report Definition Request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs.
303 The response to the Retrieve Concordance Report Definition Request when the task is complete can be retrieved from another URL. When received in response to a Retrieve Concordance Report Definition, the client should presume that the server has received the data and should issue a redirect with a separate GET message.
400 Bad Request - message content is badly formed or invalid.
401 Not authorized - authorization is required for the interaction that was attempted.
404 Not found - The referenced Measure resource was not found.
405 Method not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids.
409/412 Conflict - invalid identifier in the message content.
415 Unsupported content-type or media
422 Unprocessable entity - The referenced Measure resource does not adhere to the message semantics.
501 The request method is not implemented.

The HL7 FHIR Measure SHALL contain the following elements: title The name for this concordance report. status The publication status of this Measure. group.code The meaning of the group. group.stratifier The criteria for the measure. group.straifier.code The meaning of the stratifier. group.component A separator for multiple stratifiers part of a single group. group.component.criteria The criteria for the group including the language and expression for where to find the data in a given patient record in order to build the MeasureReport.

Expected Actions

The Content Data Structure Creator SHALL return the requested Measure in the Concordance Report Definition Response to the Content Data Structure Consumer.

CapabilityStatement Resource

Server implementing this transaction shall provide a CapabilityStatement Resource as described in ITI TF-2x: Appendix Z.3 indicating the transaction has been implemented.

Security Considerations

See RPC Security Considerations

This profile is assumed to use patient data. The appropriate security precautions are expected to be taken to protect PHI, these should include the precautions outlined in the PaLM Security Environment Considerations in PaLM TF-1: Appendix A.

Transport of RPC data SHOULD be safeguarded according to jurisdictional guidelines. To protect data integrity these SHOULD include encryption of the transport layer and the use of an appropriate mutual authentication mechanism which meets these guidelines.

Content Consumers should also take adequate account of security considerations related to the generic processing of RPC documents.

Security Audit Considerations

TThere are no specific security considerations for FHIR Measures, as they should not contain PHI.

Client Audit

'’TODO: the specifics’’

Server Audit

'’TODO: the specifics’’