NikoHealth integration

Create Sales Order

Perform Create Sales Order through NikoHealth.

View as Markdown

nikohealth_create_sales_order

writenikohealth

Inputs

document_id
expressionrequired
Document Id
Required literal value or workflow expression.
patient_id
expressionrequired
Patient Id
Required literal value or workflow expression.
service_location_id
text
Service Location Id
Optional text value.
service_location_id_select
selectdynamic options
Service Location Id Select
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
notes
expression
Notes
Optional literal value or workflow expression.
order_tag_ids
expression
Order Tag Ids
Optional literal value or workflow expression.
order_tag_ids_select
multi_selectdynamic options
Order Tag Ids Select
Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.

Outputs

successSuccess
order_idOrder Id
order_urlOrder Url
resourceResource
patient_idPatient Id
service_location_idService Location Id
item_countItem Count
tag_idsTag Ids
persisted_order_countPersisted Order Count
provider_resolution_warningProvider Resolution Warning
generic_fallback_warningGeneric Fallback Warning
order_date_warningOrder Date Warning
failure_categoryFailure Category
review_reasonReview Reason
messageMessage
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",
    "patient_id"
  ],
  "properties": {
    "notes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_tag_ids": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "service_location_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_tag_ids_select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "service_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"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "success": {},
    "tag_ids": {},
    "order_id": {},
    "resource": {},
    "order_url": {},
    "item_count": {},
    "patient_id": {},
    "review_reason": {},
    "failure_category": {},
    "order_date_warning": {},
    "service_location_id": {},
    "persisted_order_count": {},
    "generic_fallback_warning": {},
    "provider_resolution_warning": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions