Date of last data point

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

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

Overview

This operation allows:
  • a System user to query for the last update to one or many patient records.
  • a Patient user type to query for the date of last update to that patient record.

Endpoints

Interaction HTTP URL Supported Parameters Permitted User Types Description  Examples (more)
operation POST /Patient/$date-of-last-data-point Inbound parameters are supported only if user type is System.

Reference 'in' mappings below.
  • System
Return date of most recent data point on record. Date returned is data point from any organisation or entered manually to that patient record.

If a data point is deleted then the datetime returned may be earlier than the datetime retrieved from a previous call to the API. The calling system should take this into account.

Data point coverage will be everything excluding
  • Demographics
  • Measurements from a connected device. E.g. a fitbit.
  • Unprocessed data.
  • Consent and privacy label changes
If the scope is Patient
  • Patient is identified from supplied patient scope OAuth 2.0 access token. No request parameters are required.
If the scope is System
  • query by one or many national identifiers to determine the date of the most recent data point on a patient record. OR
  • query by PKB Public ID. This is a PKB-defined UUID. The ID can be retrieved from the PKB proprietary REST API and HL7 QRY^A19 STA.
  • In addition to the OAuth 2.0 access token, the X-Org-Public-Id HTTP header must be provided in the request to specify the organisation that the system is calling on behalf of. The parameter will be the UUID of the PKB organisation.
  • A supplied patientIdentifier must be part of that org or org network. If not then the patientIdentifier is ignored
/Patient/$date-of-last-data-point

Mappings

FHIR PKB Notes
OperationDefinition.url "http://fhir.patientsknowbest.com/operation/date-of-last-data-point"  
OperationDefinition.name "date-of-last-data-point"  
OperationDefinition.status "active"  
OperationDefinition.kind "operation"  
OperationDefinition.code "date-of-last-data-point"  
OperationDefinition.resource
  • "Patient"
 
OperationDefinition.system false  
OperationDefinition.type false  
OperationDefinition.instance true  
OperationDefinition.parameter In parameters - System scope:
  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "in"
    • min = 1
    • max = "100"
    • type = "token"
    • documentation = "Reference: http://dev.patientsknowbest.com/home/fhir-api/identifier-systems. If an unsupported system identifier is supplied on the request then the whole request will be rejected and an error returned.”
Out parameters - System scope:
  • parameter[x]: BackboneElement
    • name = "lastDataPointsResult"
    • use = "out"
    • min = 0
    • max = "100"
    • type = "multi part parameter"
  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "out"
    • min = 1
    • max = "1"
    • type = "token"
    • part = last-data-point-result
  • parameter[x]: BackboneElement
    • name = "lastRecordUpdate"
    • use = "out"
    • min = 0
    • max = "1"
    • type = "datetime"
    • part = last-data-point-result
    • documentation = "The date time in UTC of the most recent data point on record. If the patient account has no data points at all then this is omitted from the response. If a data point is deleted then the datetime may be earlier than the datetime retrieved from an earlier call to this API”
Out parameters - Patient scope:

  • parameter[x]: BackboneElement
    • name = "lastRecordUpdate"
    • use = "out"
    • min = 0
    • max = "1"
    • type = "datetime"
    • part = last-data-point-result
    • documentation = "The date time in UTC of the most recent data point on record. If the patient account has no data points at all then this is omitted from the response. If a data point is deleted then the datetime may be earlier than the datetime retrieved from an earlier call to this API”


Subpages (1): Examples
Comments