Generate invitation tokens


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

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

Overview

This operation allows:
  • a system to generate invitation tokens for 1 or many patients identified by national identifier.

Endpoints

Interaction HTTP URL Supported Parameters Permitted User Types Description Examples (more)
operation POST /Organization/$generate-invitation-tokens
  • patientIdentifier. Required.
Reference 'in' mappings below.
  • System
Generates invitation tokens for the patient identified by patientIdentifier (e.g. NHS). 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.
/Organization/$generate-invitation-tokens

Mappings

FHIR PKB Notes
OperationDefinition.url "http://fhir.patientsknowbest.com/operation/generate-invitation-tokens"  
OperationDefinition.name "generate-invitation-tokens"  
OperationDefinition.status "active"  
OperationDefinition.kind "operation"  
OperationDefinition.code "generate-invitation-tokens"  
OperationDefinition.resource
  • "Organization"
 
OperationDefinition.system false  
OperationDefinition.type true  
OperationDefinition.instance false  
OperationDefinition.parameter
  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "in"
    • min = 1
    • max = "500"
    • type = "token"
  • parameter[x]: BackboneElement
    • name = "patientTokens"
    • use = "out"
    • min = 1
    • max = "500"
    • type = "multi part parameter"
  • parameter[x]: BackboneElement
    • name = "patientIdentifier"
    • use = "out"
    • min = 1
    • max = "1"
    • type = "token"
    • part = patientTokens
  • parameter[x]: BackboneElement
    • name = "token"
    • use = "out"
    • min = 1
    • max = "1"
    • type = "string"
    • part = patientTokens
  • parameter[x]: BackboneElement
    • name = "code"
    • use = "out"
    • min = 1
    • max = "1"
    • type = "string"
    • part = patientTokens
  • parameter[x]: BackboneElement
    • name = "expiry"
    • use = "out"
    • min = 1
    • max = "1"
    • type = "DateTime"
    • part = patientTokens
Currently only NHS, CHI and Health & Care numbers are 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.




patientTokens will not be returned where patient is deceased, not found, already registered or has no date of birth. status-query should be used prior to this operation to confirm the patient is applicable for invitation.
Subpages (1): Examples
Comments