Status query

Owned by Andrew Turner (Unlicensed)
Last updated: Apr 11, 2023 by Tom Pick (Unlicensed)
2 min read

http://fhir.patientsknowbest.com/operation/status-query

[Prod Resource]

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

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

name

"status-query"

status

"active"

kind

"operation"

description

This operation allows:

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

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.

code

"status-query"

resource

  • "Patient"

system

false

type

true

instance

false

parameter

  • parameter[0]

    • name = "patientIdentifier"

    • use = "in"

    • min = 1

    • max = "5000"

    • type = "token"

Currently only NHS, CHI and Health & Care numbers are supported. Reference: https://pkbdev.atlassian.net/wiki/spaces/api/pages/3365077531/Identifier+Systems. If an unsupported system identifier is supplied on the request then the whole request will be rejected and an error returned.

  • parameter[1]

    • name = "patientStatus"

    • use = "out"

    • min = 1

    • max = "5000"

    • type = "multi part parameter"

  • parameter[2]

    • name = "patientIdentifier"

    • use = "out"

    • min = 1

    • max = "1"

    • type = "token"

    • part = patientStatus

  • parameter[3]

    • name = "deceased"

    • use = "out"

    • min = 0

    • max = "1"

    • type = boolean

    • part = patientStatus

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'.

  • parameter[4]

    • name = "registered"

    • use = "out"

    • min = 0

    • max = "1"

    • type = "boolean"

    • part = patientStatus

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'.

  • parameter[5]

    • name = "dateOfBirth"

    • use = "out"

    • min = 0

    • max = "1"

    • type = "date"

    • part = patientStatus

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

  • parameter[6]

    • name = "diagnostics"

    • use = "out"

    • min = 0

    • max = "1"

    • type = "string"

    • part = patientStatus