read-receipt-query

https://www.hl7.org/fhir/operations.html

https://www.hl7.org/fhir/STU3/operationdefinition.html

Status

In development. API spec subject to change.

Overview

This operation allows:
  • a System user to query the read status for 1 or many document identifiers.

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescription
operationPOST/DocumentReference/$read-receipt-query

mandatory:

  • documentIdentifier

Reference 'in' mappings below.
  • System User

For each documentIdentifier provided PKB will return the read status of that document.


Multiple document identifiers can be supplied as the input to the operation. This allows the calling system to work in batches.  


The document identifier provided should correspond to the identifier sent on the original document.  The document would typically be supplied to PKB via an HL7 MDM^T02.  Document identifier as provided in TXA-12.1.  The sending system should use unique identifiers (e.g. UUID) for the document identifiers to ensure they are unique across organisations.

The OAuth 2.0 system user access token will be provided along with a header parameter in the request that specifies the organisation that sent the document. The parameter will be the UUID of the PKB organisation. 


Mappings

FHIRPKBNotes
OperationDefinition.url"http://fhir.patientsknowbest.com/operation/read-receipt-query" 
OperationDefinition.name"read-receipt-query" 
OperationDefinition.status"active" 
OperationDefinition.kind"operation" 
OperationDefinition.code"read-receipt-query" 
OperationDefinition.resource
  • "DocumentReference"
 
OperationDefinition.systemfalse 
OperationDefinition.typefalse 
OperationDefinition.instancetrue 
OperationDefinition.parameter

  • parameter[x]: BackboneElement
    • name = "documentIdentifier"
    • use = "in"
    • min = "1"
    • max = "100"
    • type = "token"
  • parameter[x]: BackboneElement
    • name = "readReceipt"
    • use = "out"
    • min = "0"
    • max = "<to be determined>"
    • type = "multi part parameter"

  • parameter[x]: BackboneElement
    • name = "documentIdentifier"
    • use = "out"
    • min = "1"
    • max = "1"
    • type = "string"
    • part = readReceipt

  • parameter[x]: BackboneElement
    • name = "read"
    • use = "out"
    • min = "1"
    • max = "1"
    • type = "boolean"
    • part = readReceipt








readReceipt will not be returned when the documentIdentifier can not be found.

Examples

Request


{ "resourceType": "Parameters", "parameter": [ { "name": "documentIdentifier", "valueString": "97a25402-622b-47e0-b650-bbbd08de4daf" }, { "name": "documentIdentifier", "valueString": "33bbef92-9303-4ec7-a03f-6ee02045271e" }, { "name": "documentIdentifier", "valueString": "b41908d9-1ec1-4884-b98c-f63473cb5bc0" } ] }


Response

{ "resourceType" : "Parameters", "parameter" : [ { "name" : "read_receipt", "part" : [ { "name" : "documentIdentifier", "valueString" : "97a25402-622b-47e0-b650-bbbd08de4daf" }, { "name" : "read", "valueBoolean" : true } ] }, { "name" : "read_receipt", "part" : [ { "name" : "documentIdentifier", "valueString" : "33bbef92-9303-4ec7-a03f-6ee02045271e" }, { "name" : "read", "valueBoolean" : false } ] } ] }

Comments