status-query

https://www.hl7.org/fhir/STU3/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 registration status for 1 or many patients identified by national identifier.

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescription
operationPOST/Patient/$status-query

mandatory:

  • patientIdentifier

Reference 'in' mappings below.
  • System User

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.


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



Mappings

FHIRPKBNotes
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.systemfalse 
OperationDefinition.typefalse 
OperationDefinition.instancetrue 
OperationDefinition.parameter

  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "in"
    • min = "1"
    • max = "<to be determined>"
    • type = "token"
  • parameter[x]: BackboneElement
    • name = "patientStatus"
    • use = "out"
    • min = "1"
    • max = "<to be determined>"
    • 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

'NHS Number', 'CHI Number' and 'Health and Care Number' national identifier systems will be 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.



















not returned if diagnostics = 'Not found'








not returned if diagnostics = 'Not found'







not returned if diagnostics = 'Not found' or 'No access'








diagnostics = 'Not found' or 'No access'

Examples

Request


{ "resourceType": "Parameters", "parameter": [ { "name": "patientIdentifier", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "4546511590" } }, { "name": "patientIdentifier", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "4523836485" } } ] }


Response

{ "resourceType" : "Parameters", "parameter" : [ { "name" : "patientStatus", "part" : [ { "name" : "patientIdentifier", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "4546511590" } }, { "name" : "registered", "valueBoolean" : true }, { "name" : "deceased", "valueBoolean" : false }, { "name" : "dateOfBirth", "valueDate" : "1920-01-01" } ] }, { "name" : "patientStatus", "part" : [ { "name" : "patientIdentifier", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "4523836485" } }, { "name" : "diagnostics", "valueString" : "Not found" } ] } ] }

Comments