Reminder - Standard Appointment File Format

<< Click to Display Table of Contents >>

Navigation:  Soprano Applications > Reminder > Reminder - Company Setup >

Reminder - Standard Appointment File Format

Previous pageReturn to chapter overviewNext page

 

Appointment data can be uploaded into Reminder either manually as a Comma Separated (.csv) file or scheduled to automatically upload files from an external FTP site. These uploads can be scheduled to occur at specific times or periodically.

 

The file will contain scheduled appointments. Reminder will process the file and send out SMS reminders.

 

 

File Format - Input

The appointment record is listed in 'Comma Separated Value (CSV)' file format. One line represents one record (i.e. appointment).

 

No.

Field

Mandatory

Size (i.e. Max # of characters)

Type

Description

Example

1

Mobile

Y

13

Number

Patient/Client's mobile number (in international format).

61491234567

2

PermissionToSendSMS

Y

1

Number

1 for permit, 0 for not permit.

1

3

FirstName

Y

100

Text

Patient/Contact's First Name.

John

4

LastName

Y

100

Text

Patient/Contact's Last Name.

Smith

5

Home

 

30

Text

Patient/Contact's Home Phone.

(02)99001234

6

Work

 

30

Text

Patient/Contact's Work Phone.

(02)99005678

7

Email

 

50

Text

Patient/Contact's Email Address.

jsmith@abcxy.com

8

AppointmentDate

Y

10

Date

In 'DD/MM/YYY' format e.g.  '15/06/2008', or the date format specified in the Reminder 'File Format', which is specified in Reminder/Information Order.

27/07/2013

9

AppointmentTime

Y

11

Time

In 24 hour (hh:mm) format e.g. 15:00, 09:30, or the time format specified in the Reminder 'File Format', which is specified in the Reminder/Information order.

15:30

10

Location Name

Y

40

Text

Name of clinic, hospital, building etc.

AAA Medical Centre

11

LocationAddress

 

Y

200

Text

Address for above location.

221B Barker Street, Burwood

12

LocationPhoneNumber

Y

30

Text

Phone number of the clinic, hospital, building etc.

61491234568

13

ClinicianID

 

30

Text

As per the business process or regulatory requirements.

123456

14

ClinicianTitle

Y

15

Text

Mr, Ms, Mrs, Dr

Dr

15

ClinicianGivenName

 

Y

100

Text

e.g. Dr John F Smith

Maria

16

ClinicianInitial

 

10

Text

e.g. Dr John F Smith

 

J

17

ClinicianSurname

 

Y

100

Text

e.g. Dr John F Smith

 

Hamm

18

Owes

 

12

Decimal (12.2)

How much the Patient owes including decimal point (e.g. 0.0 or 70.5).

0.0

19

Eligibility

 

100

Text

As per the business process or regulatory requirements.

 

20

NewClient

 

3

Text

'New' if patient is a new client, otherwise left blank.

New

21

ClientID

 

20

Text

ID of the Patient/Client.

2000001409

 

 

 

Example

61491234567,1,John,Smith,(02) 9900 1234, (02) 9900 5678,,jSmith@abcxyz.com,26/05/2013,15:00,ABC Medical Centre,221B Baker Street,(02) 2222 0555,1420,Dr,John,H,Watson,65,Medicare,New,125678

61491234568,0,Mary,Smith,(02) 9911 1111,,mSmith@bbcxyz.com,24/05/2013,15:45,ABC Dental Centre,10 Downing Street,(02) 2222 0666,1007,Mr,Max,M,Payne,0,SeniorsCard,,798945

 

 

 

File Format - Output

The appointment record is listed in 'Comma Separated Value (CSV)' file format. One line represents one record (i.e. appointment).

 

 

No.

Field

Description

Size (i.e. Max # of characters)

 

Type

Example

1

Mobile

Patient/Client's mobile number (in international format).

 

13

Number

61491234567

2

PermissionToSendSMS

1 for permit, 0 for not permit

 

1

Number

1

3

FirstName

Patient/Contact's First Name

 

100

Text

John

4

LastName

Patient/Contact's Last Name

 

100

Text

Smith

5

Home

Patient/Contact's Home Phone

 

30

Text

(02)99001234

6

Work

Patient/Contact's Work Phone

 

30

Text

(02)99005678

7

Email

Patient/Contact's Email Address

 

50

Text

jsmith@abcxy.com

8

AppointmentDate

In 'DD/MM/YYY' format e.g.  '15/06/2008', or the date format specified in the Reminder 'File Format', which is specified in Reminder/Information Order.

 

10

Date

27/07/2013

9

AppointmentTime

In 24 hour (hh:mm) format e.g. 15:00, 09:30, or the time format specified in the Reminder 'File Format', which is specified in the Reminder/Information order.

 

11

Time

15:30

10

Location Name

Name of clinic, hospital, building etc.

 

40

Text

AAA Medical Centre

11

LocationAddress

Address for above location.

 

200

Text

221B Barker Street, Burwood

12

LocationPhoneNumber

Phone number of the clinic, hospital, building etc.

 

30

Text

61491234568

13

ClinicianID

As per the business process or regulatory requirements.

 

30

Text

123456

14

ClinicianTitle

Mr, Ms, Mrs, Dr

 

15

Text

Dr

15

ClinicianGivenName

e.g. Dr John F Smith

 

100

Text

Maria

16

ClinicianInitial

e.g. Dr John F Smith

 

10

Text

J

17

ClinicianSurname

e.g. Dr John F Smith

 

100

Text

Hamm

18

Owes

How much the Patient owes - may include decimal point (e.g. 0.0 or 70.5).

 

12

Decimal (12.2) or Number (12)

0.0

19

Eligibility

As per the business process or regulatory requirements.

 

100

Text

 

20

NewClient

'New' if patient is a new client, otherwise left blank.

 

3

Text

New

21

ClientID

ID of the Patient/Client.

 

20

Text

2000001409

 

22

AppointmentStatus

Status of appointment. Possible values are:

 

CONFIRMED_SMS: Patient confirmed appointment via SMS;

CANCELLED_SMS: Patient cancelled appointment via SMS;

CHANGED: Patient confirmed but then canceled later on via SMS, or the other way round.

 

30

Text

CONFIRMED_SMS

23

AppointmentID

Appointment ID in the GSMS system.

10

Number

12367345

 

 

Example

61491234567,1,John,Smith,(02) 9900 1234, (02) 9900 5678,,jSmith@abcxyz.com,26/05/2013,15:00,ABC Medical Centre,221B Baker Street,(02) 2222 0555,1420,Dr,John,H,Watson,65,Medicare,New,125678

61491234567,0,Mary,Smith,(02) 9911 1111,,mSmith@bbcxyz.com,24/05/2013,15:45,ABC Dental Centre,10 Downing Street,(02) 2222 0666,1007,Mr,Max,M,Payne,0,SeniorsCard,,798945

 

Please note: A license may be required in order to view or use the above features.