Create Contact

Component Details

v1.0.0

Basic Information

appmixer.cliniko.core.CreateContact

Create Contact

1.0.0

Public

Creates a contact - a referring doctor, a third-party payer or any other non-patient contact. Cliniko requires a First Name or a Last Name even for a company contact.

Input Ports

in

FieldTypeDescription
First Name text -
Last Name text -
Preferred Name text -
Company Name text Use this for organisations such as third-party payers.
Title text For example Mr, Ms or Dr.
Email text -
Type select What kind of contact this is.
Doctor Type select Only meaningful when Type is Doctor.
Provider Number text -
Occupation text -
Phone Number text Sent together with Phone Type as the contact's phone number.
Phone Type select Only used when Phone Number is filled in.
Address Line 1 text -
Address Line 2 text -
Address Line 3 text -
City text -
State text -
Post Code text -
Country Code text Two-letter ISO 3166-1 country code, for example AU or GB.
Notes textarea -

Output Ports

out

FieldTypeDescription
Contact ID string -
First Name string -
Last Name string -
Preferred Name string -
Company Name string -
Email string -
Type string -
Type Code integer -
Doctor Type string -
Provider Number string -
Occupation string -
Title string -
Address Line 1 string -
Address Line 2 string -
Address Line 3 string -
City string -
State string -
Post Code string -
Country string -
Country Code string -
Notes string -
Phone Numbers array -
Archived At string -
Created At string -
Updated At string -

Full Metadata