NikoHealth integration

Find or Create Patient

Perform Find or Create Patient through NikoHealth.

View as Markdown

nikohealth_find_or_create_patient

writenikohealth

Inputs

document_id
expressionrequired
Document Id
Required literal value or workflow expression.
location_id
expression
Location Id
Optional literal value or workflow expression.
location_id_select
selectdynamic options
Location Id Select
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
auto_update_existing_patient_fields
boolean
Auto Update Existing Patient Fields
Optional true-or-false value.
Default: false
append_missing_phone_contacts
boolean
Append Missing Phone Contacts
Optional true-or-false value.
Default: false
duplicate_match_mode
select
Duplicate Match Mode
Optional 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")
patient_genhealth_tag_id
text
Patient Genhealth Tag Id
Optional text value.
patient_genhealth_tag_id_select
selectdynamic options
Patient Genhealth Tag Id Select
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
mark_signature_on_file
boolean
Mark Signature On File
Optional true-or-false value.
Default: false
existing_patient_signature_date
date
Existing Patient Signature Date
Optional date in YYYY-MM-DD format.
overwrite_existing_signature_date
boolean
Overwrite Existing Signature Date
Optional true-or-false value.
Default: true
set_responsible_contact_to_self
boolean
Set Responsible Contact To Self
Optional true-or-false value.
Default: false

Outputs

successSuccess
patient_idPatient Id
first_nameFirst Name
last_nameLast Name
birthdayBirthday
is_new_patientIs New Patient
document_idDocument Id
applied_patient_tag_idsApplied Patient Tag Ids
patient_tag_writeback_statusPatient Tag Writeback Status
patient_tag_warningPatient Tag Warning
patient_check_statusPatient Check Status
ambiguous_patient_matchAmbiguous Patient Match
ambiguous_patient_match_tag_idAmbiguous Patient Match Tag Id
responsible_contact_updatedResponsible Contact Updated
errorError

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"
    },
    "location_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "location_id_select": {
      "type": "string",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "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"
    },
    "mark_signature_on_file": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "patient_genhealth_tag_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "append_missing_phone_contacts": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "existing_patient_signature_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "patient_genhealth_tag_id_select": {
      "type": "string",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "set_responsible_contact_to_self": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "overwrite_existing_signature_date": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "auto_update_existing_patient_fields": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "birthday": {},
    "last_name": {},
    "first_name": {},
    "patient_id": {},
    "document_id": {},
    "is_new_patient": {},
    "patient_tag_warning": {},
    "patient_check_status": {},
    "ambiguous_patient_match": {},
    "applied_patient_tag_ids": {},
    "responsible_contact_updated": {},
    "patient_tag_writeback_status": {},
    "ambiguous_patient_match_tag_id": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions