Skip to documentation
NikoHealth integration

Find or Add Referring Provider Location

Perform Find or Add Referring Provider Location through NikoHealth.

View as Markdown
nikohealth_find_or_add_referring_provider_location
writenikohealth

Inputs

  • provider_id
    expressionrequired
    Provider Id

    Required literal value or workflow expression.

  • address_line
    expressionrequired
    Address Line

    Required literal value or workflow expression.

  • address_line_2
    expression
    Address Line 2

    Optional literal value or workflow expression.

  • city
    expressionrequired
    City

    Required literal value or workflow expression.

  • state
    expressionrequired
    State

    Required literal value or workflow expression.

  • zip
    expressionrequired
    Zip

    Required literal value or workflow expression.

  • phone
    expression
    Phone

    Optional literal value or workflow expression.

  • fax
    expression
    Fax

    Optional literal value or workflow expression.

  • email
    expression
    Email

    Optional literal value or workflow expression.

  • location_name
    expression
    Location Name

    Optional literal value or workflow expression.

  • add_if_missing
    boolean
    Add If Missing

    Optional true-or-false value.

    Default: "true"

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: "false"

Outputs

  • successSuccess
  • provider_idProvider Id
  • location_idLocation Id
  • addedAdded
  • match_statusMatch Status
  • readback_verifiedReadback Verified
  • missing_fieldsMissing Fields
  • failure_categoryFailure Category
  • status_codeStatus Code
  • correlation_idCorrelation Id
  • error_typeError Type
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
Yes

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "provider_id",
    "address_line",
    "city",
    "state",
    "zip"
  ],
  "properties": {
    "fax": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "zip": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "city": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "email": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "state": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "dry_run": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "provider_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "address_line": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "location_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "add_if_missing": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "address_line_2": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "added": {},
    "error": {},
    "success": {},
    "error_type": {},
    "location_id": {},
    "provider_id": {},
    "status_code": {},
    "match_status": {},
    "correlation_id": {},
    "missing_fields": {},
    "failure_category": {},
    "readback_verified": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions