Check Patient Exists
Perform Check Patient Exists through NikoHealth.
nikohealth_check_patient_existswritenikohealth
Inputs
- Document Id
document_idexpressionrequiredRequired literal value or workflow expression.
- Duplicate Match Mode
duplicate_match_modeselectOptional selected identifier or value.
Default:
"strict"Options: Strict ("strict"), Exact First Name, Last Name, and DOB ("exact_identity"), Review Near Matches ("review_near_matches"), Match on Available Identifiers (name-only when no DOB) ("available_identifiers")
Outputs
successSuccesspatient_existsPatient Existsniko_patient_idNiko Patient Iddoc_idDoc Idpatient_check_statusPatient Check Statusambiguous_patient_matchAmbiguous Patient Matchambiguous_patient_match_tag_idAmbiguous Patient Match Tag IderrorError
Output schema completeness: best_effort_declared
Safety
- External effect
- write
- Confirmation recommended
- No
- Retry safe
- No
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"document_id"
],
"properties": {
"document_id": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"duplicate_match_mode": {
"enum": [
"strict",
"exact_identity",
"review_near_matches",
"available_identifiers"
],
"type": "string",
"default": "strict",
"description": "Optional selected identifier or value.",
"x-workflow-field-type": "select"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"doc_id": {},
"success": {},
"patient_exists": {},
"niko_patient_id": {},
"patient_check_status": {},
"ambiguous_patient_match": {},
"ambiguous_patient_match_tag_id": {}
},
"additionalProperties": true
}