Aggregate Documents
Perform Aggregate Documents through GenHealth.
genhealth_aggregate_documentswrite
Inputs
- Document Ids
document_idsexpressionrequiredRequired literal value or workflow expression.
- Document Id Field
document_id_fieldtextOptional text value.
- Add Bookmarks
add_bookmarksbooleanOptional true-or-false value.
Default:
false - Skip Unreadable
skip_unreadablebooleanOptional true-or-false value.
Default:
false - Show In Inbox
show_in_inboxbooleanOptional true-or-false value.
Default:
true - Title
titleexpressionrequiredRequired literal value or workflow expression.
- Patient Id
patient_idexpressionOptional literal value or workflow expression.
- Categories
categoriesmulti_selectOptional list of selected values.
- Metadata
metadatajsonOptional JSON value.
- External Id
external_idexpressionOptional literal value or workflow expression.
Outputs
successSuccessdocument_idDocument Idaggregate_document_idAggregate Document IdtitleTitlecreatedCreatedsource_document_countSource Document Countpage_countPage Countskipped_document_idsSkipped Document IdserrorError
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_ids",
"title"
],
"properties": {
"title": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"metadata": {
"description": "Optional JSON value.",
"x-workflow-field-type": "json"
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of selected values.",
"x-workflow-field-type": "multi_select"
},
"patient_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"external_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"document_ids": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"add_bookmarks": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"show_in_inbox": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"skip_unreadable": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"document_id_field": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"title": {},
"created": {},
"success": {},
"page_count": {},
"document_id": {},
"skipped_document_ids": {},
"aggregate_document_id": {},
"source_document_count": {}
},
"additionalProperties": true
}