Skip to documentation
MyForms integration

Validate Facility Document Candidate

Perform Validate Facility Document Candidate through MyForms.

View as Markdown
myforms_validate_facility_document_candidate
write

Inputs

  • candidate
    jsonrequired
    Candidate

    Required JSON value.

Outputs

  • successSuccess
  • eligibleEligible
  • skippedSkipped
  • skip_reasonSkip Reason
  • order_idOrder Id
  • workflow_numberWorkflow Number
  • workflow_templateWorkflow Template
  • workflow_template_idWorkflow Template Id
  • workflow_state_idWorkflow State Id
  • workflow_state_nameWorkflow State Name
  • patient_idPatient Id
  • patient_statePatient State
  • doc_created_atDoc Created At
  • local_patient_idLocal Patient Id
  • account_keyAccount Key
  • dry_runDry Run
  • 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": [
    "candidate"
  ],
  "properties": {
    "candidate": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "skipped": {},
    "success": {},
    "eligible": {},
    "order_id": {},
    "patient_id": {},
    "account_key": {},
    "skip_reason": {},
    "patient_state": {},
    "doc_created_at": {},
    "workflow_number": {},
    "local_patient_id": {},
    "workflow_state_id": {},
    "workflow_template": {},
    "workflow_state_name": {},
    "workflow_template_id": {}
  },
  "additionalProperties": true
}
View all MyForms actions