Create Order
Perform Create Order through ClaimSoft.
claimsoft_create_orderInputs
- Idempotency Key
idempotency_keytextrequiredRequired text value.
- Write Idempotency To Original Ref No
write_idempotency_to_original_ref_nobooleanOptional true-or-false value.
Default:
true - Patient Id
patient_idexpressionrequiredRequired literal value or workflow expression.
- Date Of Service From
date_of_service_fromtextrequiredRequired text value.
- Date Of Service To
date_of_service_totextrequiredRequired text value.
- Location
locationtextrequiredRequired text value.
- Diagnosis Codes
diagnosis_codesjsonrequiredRequired JSON value.
- Physician Id
physician_idnumberrequiredRequired numeric value.
- Physician
physiciantextrequiredRequired text value.
- Referral Source Id
referral_source_idnumberOptional numeric value.
- Referral Source
referral_sourcetextOptional text value.
- Psr Id
psr_idnumberrequiredRequired numeric value.
- Sales Rep Id
sales_rep_idnumberOptional numeric value.
- Sales Rep
sales_reptextOptional text value.
- Warehouse
warehousenumberOptional numeric value.
- Place Of Service
place_of_servicenumberOptional numeric value.
- Signature
signaturenumberOptional numeric value.
- Rendering Provider Id
rendering_provider_idnumberOptional numeric value.
- Rendering Provider
rendering_providertextOptional text value.
- Semantic Items
semantic_itemsjsonOptional JSON value.
- Is Accident
is_accidentbooleanOptional true-or-false value.
- Accident Date
accident_datetextOptional text value.
- Accident State Id
accident_state_idtextOptional text value.
- Accident Description
accident_descriptiontextOptional text value.
- Prescription Date
prescription_datetextOptional text value.
- Order Override
order_overridejsonOptional JSON value.
Outputs
successSuccessorder_idOrder IdcreatedCreatedduplicate_preventedDuplicate Preventedmatch_basisMatch Basisidempotency_keyIdempotency KeymessageMessageerror_kindError KinderrorError
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": [
"idempotency_key",
"patient_id",
"date_of_service_from",
"date_of_service_to",
"location",
"diagnosis_codes",
"physician_id",
"physician",
"psr_id"
],
"properties": {
"psr_id": {
"type": "number",
"description": "Required numeric value.",
"x-workflow-field-type": "number"
},
"location": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"physician": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"sales_rep": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"signature": {
"type": "number",
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"warehouse": {
"type": "number",
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"patient_id": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"is_accident": {
"type": "boolean",
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"physician_id": {
"type": "number",
"description": "Required numeric value.",
"x-workflow-field-type": "number"
},
"sales_rep_id": {
"type": "number",
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"accident_date": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"order_override": {
"description": "Optional JSON value.",
"x-workflow-field-type": "json"
},
"semantic_items": {
"description": "Optional JSON value.",
"x-workflow-field-type": "json"
},
"diagnosis_codes": {
"description": "Required JSON value.",
"x-workflow-field-type": "json"
},
"idempotency_key": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"referral_source": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"place_of_service": {
"type": "number",
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"accident_state_id": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"prescription_date": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"date_of_service_to": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"referral_source_id": {
"type": "number",
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"rendering_provider": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"accident_description": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"date_of_service_from": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"rendering_provider_id": {
"type": "number",
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"write_idempotency_to_original_ref_no": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"created": {},
"message": {},
"success": {},
"order_id": {},
"error_kind": {},
"match_basis": {},
"idempotency_key": {},
"duplicate_prevented": {}
},
"additionalProperties": true
}