Patient Request for Corrections Implementation Guide
1.0.0 - STU 1 International flag

Patient Request for Corrections Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-patient-correction/ and changes regularly. See the Directory of published versions

CapabilityStatement: Patient Request for Corrections Capability Statement

Official URL: http://hl7.org/fhir/uv/patient-corrections/CapabilityStatement/PatientCorrectionCapability Version: 1.0.0
Standards status: Trial-use Maturity Level: 1 Computable Name: PatientCorrectionCapability

Describes the capabilities for a FHIR server to support patient requests for corrections.

Supported profiles

PatientCorrectionBundle

Conformance expectation: SHALL

Reference policy: resolves

Profile interaction summary:

  • SHALL support $correction-request
  • SHALL support read
  • MAY support vread, history-instance, search-type

Fetch and search criteria:

  • A server SHOULD be capable of returning a Bundle resource using: GET [base]/Bundle/[id]

PatientCorrectionCommunication

Conformance expectation: SHALL

Reference policy: resolves

Profile interaction summary:

  • SHALL support search-type, read
  • SHOULD support vread, history-instance

Fetch and search criteria:

  • A server SHALL be capable of returning a Communication resource using: GET [base]/Communication/[id]
  • A server SHALL support the following searches for Communication resources:
    • About
    • Patient
    • Category
    • Identifier
    • Sent
    • Topic
  • A server SHOULD support the following searches for Communication resources:
    • Sender
    • Recipient
    • Encounter

PatientCorrectionTask

Conformance expectation: SHALL

Reference policy: resolves

Profile interaction summary:

  • SHALL support search-type, read
  • SHOULD support vread, history-instance

Fetch and search criteria:

  • A Server SHALL be capable of returning a Task resource using: GET [base]/Task/[id]
  • A server SHALL support the following searches for Task resources:
    • Patient
    • Identifier
    • Code
    • Status
  • A server SHOULD support the following searches for Task resources:
    • ReasonReference
    • Authored-on
    • Modified
    • Requester
    • Encounter
    • Owner
    • BusinessStatus

Raw OpenAPI-Swagger Definition file | Download

Patient Request for Corrections Capability Statement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2022-03-04
  • Published by: HL7 International / Patient Empowerment

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.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Description of the needed resources to be supported by the FHIR server, and the different possible interactions.

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • 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
Communication yyabout
Task yyreasonReference
Bundle y

Resource Conformance: SHALL Communication

Core FHIR Resource
Communication
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Documentation

Read a communication between a patient and a fulfiller relating to a patient correction request.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLaboutreference

Search for PatientCorrectionTask or PatientCorrectionCommunication this PatientCorrectionCommunication is about.

 

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Documentation

Read a Task relating to a patient correction request.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLreasonReferencereference

For Disagreement Tasks, search for the original request for correction Communication.

 

Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • SHALL support read.

Documentation

Read a Patient Correction Bundle which contains a Patient Correction Communication and related resources.