Status query

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

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

Overview

This operation allows:
  • a system to query the registration status for 1 or many patients identified by national identifier.

Endpoints

Interaction HTTP URL Supported Parameters Permitted User Types Description Examples (more)
operation POST /Patient/$status-query
  • patientIdentifier. Required.
Reference 'in' mappings below.
  • System
For each patientIdentifier provided PKB will return a subset of key registration information for that patient.

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

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 wants to generate the tokens. The parameter will be the UUID of the PKB organisation.
/Patient/$status-query

Mappings

FHIR PKB Notes
OperationDefinition.url "http://fhir.patientsknowbest.com/operation/status-query"  
OperationDefinition.name "status-query"  
OperationDefinition.status "active"  
OperationDefinition.kind "operation"  
OperationDefinition.code "status-query"  
OperationDefinition.resource
  • "Patient"
 
OperationDefinition.system false  
OperationDefinition.type true  
OperationDefinition.instance false  
OperationDefinition.parameter
  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "in"
    • min = 1
    • max = "5000"
    • type = "token"
  • parameter[x]: BackboneElement
    • name = "patientStatus"
    • use = "out"
    • min = 1
    • max = "5000"
    • type = "multi part parameter"
  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "out"
    • min = 1
    • max = "1"
    • type = "token"
    • part = patientStatus
  • parameter[x]: BackboneElement
    • name = "deceased"
    • use = "out"
    • min = 0
    • max = "1"
    • type = "boolean"
    • part = patientStatus
  • parameter[x]: BackboneElement
    • name = "registered"
    • use = "out"
    • min = 0
    • max = "1"
    • type = "boolean"
    • part = patientStatus
  • parameter[x]: BackboneElement
    • name = "dateOfBirth"
    • use = "out"
    • min = 0
    • max = "1"
    • type = "date"
    • part = patientStatus
  • parameter[x]: BackboneElement
    • name = "diagnostics"
    • use = "out"
    • min = 0
    • max = "1"
    • type = "string"
    • part = patientStatus
Currently only 'NHS Number' is supported. 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.




















The deceased boolean value is returned in the response if the patient is found or if diagnostics = 'No access'.  It is not returned if diagnostics = 'Not found'.






The registered boolean value is returned in the response if the patient is found or if diagnostics = 'No access'.  It is not returned if diagnostics = 'Not found'.






The dateOfBirth date is returned only when the patient is found.  The value is not returned if diagnostics = 
'Not found' or 'No access'.

Subpages (1): Examples
Comments