Child Care Management System
Service Provider Interface
Technical Specifications
Version Number: 1.50 v1.0 final
Revision Date: 13/12/2012
Date of Effect: December 2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Table of Contents
1
OVERVIEW ............................................................................................................................. 6
2
INTERFACE OVERVIEW ..................................................................................................... 7
2.1
2.2
2.3
2.4
3
CCB APPROVAL AND SERVICE PROVIDER DETAILS .................................................................... 7
CCB ENROLMENTS ..................................................................................................................... 7
ATTENDANCE DETAILS ............................................................................................................... 7
SERVICE PROVIDER OTHER DETAILS .......................................................................................... 7
INTERFACE DETAILS .......................................................................................................... 8
3.1
3.2
3.3
3.4
TRANSPORT PROTOCOL / TECHNICAL INFRASTRUCTURE ............................................................ 8
INTERFACE MESSAGES ................................................................................................................ 8
SECURITY AND AUTHENTICATION............................................................................................. 10
INTERFACE ERRORS .................................................................................................................. 11
3.4.1
3.4.2
3.4.3
4
SOAP Faults
Return Code, Return Errors and Return Message
WSDL Import Considerations
11
12
13
INTERFACE DATA .............................................................................................................. 14
4.1
4.2
4.3
4.4
4.5
4.6
4.7
4.8
4.9
DATA FORMATS ........................................................................................................................ 14
SOURCE SYSTEM CODE ............................................................................................................. 14
SERVICE PROVIDER REFERENCE ............................................................................................... 14
ATTENDANCE BATCH NUMBER................................................................................................. 15
CCB APPROVAL ID ................................................................................................................... 15
FACSIA ENROLMENT ID ........................................................................................................... 15
FACSIA ATTENDANCE ID ......................................................................................................... 15
TRANSACTION ID ...................................................................................................................... 16
AUTHORISED PERSON DATA ...................................................................................................... 16
4.9.1
4.10
4.11
4.12
5
Authorised Person Id
16
SERVICE CLIENT IDS ............................................................................................................ 16
IS CASE IDS .......................................................................................................................... 17
IS CASE CLAIM IDS .............................................................................................................. 17
QUERY INTERFACES ......................................................................................................... 18
5.1
5.2
5.3
5.4
6
BASIC OPERATION OF THE QUERY ............................................................................................. 18
PAGE SIZE ................................................................................................................................. 19
PAGE NUMBER .......................................................................................................................... 19
LAST PAGE INDICATOR ............................................................................................................. 19
INTERFACE EXAMPLES ................................................................................................... 20
6.1
6.2
6.3
6.4
7
EXAMPLE REQUEST MESSAGE .................................................................................................. 20
EXAMPLE RESPONSE MESSAGE................................................................................................. 21
EXAMPLE SOAP FAULT ............................................................................................................ 21
EXAMPLE NON ZERO RETURN CODE ........................................................................................ 21
INTERFACE AVAILABILITY ............................................................................................ 22
7.1
7.2
8
PRODUCTION ............................................................................................................................. 22
TEST SYSTEM ............................................................................................................................ 22
INTERFACE DEVELOPMENT AND TESTING .............................................................. 23
8.1
8.2
8.3
8.4
RELEASE OF UPDATED SPECIFICATION ..................................................................................... 23
TEST SYSTEM AVAILABLE ........................................................................................................ 23
SOFTWARE REGISTRATION........................................................................................................ 23
PILOTING .................................................................................................................................. 24
9
APPENDIX A – GLOSSARY ............................................................................................... 25
10
APPENDIX B – INTERFACE LISTING............................................................................. 26
10.1
CCB APPROVAL INTERFACE ................................................................................................ 26
Version Number: 1.50 v1.0 final
Page 2 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
10.2
10.3
10.4
10.5
10.6
10.7
10.8
10.9
ENROLMENT INTERFACE ...................................................................................................... 26
ATTENDANCE INTERFACE .................................................................................................... 26
IS CASE INTERFACE ............................................................................................................. 27
IS CASE CLAIM INTERFACE .................................................................................................. 27
MESSAGES INTERFACE ......................................................................................................... 27
CARE PROVIDED AND VACANCY INTERFACE ....................................................................... 27
REMITTANCE INTERFACE ..................................................................................................... 27
DIAGNOSTIC INTERFACE ...................................................................................................... 27
APPENDIX C – CCB APPROVAL INTERFACE ............................................................. 28
11
11.1
QUERY CCB APPROVAL ...................................................................................................... 28
11.1.1
11.1.2
11.1.3
11.1.4
11.1.5
11.2
Update Profile Request Message Data Definition
Update Profile Request Data Rules
Update Profile Allowable Values – Request
Update Profile Response Message Data Definition
Update Profile Allowable Values – Response Message
45
48
51
51
54
UPDATE ALL PERSONNEL..................................................................................................... 55
11.3.1
11.3.2
11.3.3
11.3.4
11.3.5
11.4
28
29
29
30
43
UPDATE PROFILE .................................................................................................................. 45
11.2.1
11.2.2
11.2.3
11.2.4
11.2.5
11.3
Query CCB Approval Request Message Data Definition
Query CCB Approval Request Data Rules
Query CCB Approval Allowable Values – Request
Query CCB Approval Response Message Data Definition
Query CCB Approval Allowable Values – Response Message
Update All Personnel Request Message Data Definition
Update All Personnel Request Data Rules
Update All Personnel Allowable Values – Request
Update All Personnel Response Message Data Definition
Update All Personnel Allowable Values – Response Message
55
59
63
64
68
UPDATE FEES ....................................................................................................................... 69
11.4.1
11.4.2
11.4.3
11.4.4
11.4.5
Update Fees Request Message Data Definition
Update Fees Request Data Rules
Update Fees Allowable Values – Request
Update Fees Response Message Data Definition
Update Fees Allowable Values – Response Message
69
71
74
74
78
APPENDIX D – ENROLMENT INTERFACE ................................................................... 79
12
12.1
CREATE ENROLMENT ........................................................................................................... 79
12.1.1
12.1.2
12.1.3
12.1.4
12.1.5
12.2
94
95
96
96
104
Update Enrolment Request Message Data Definition
Update Enrolment Request Data Rules
Update Enrolment Allowable Values - Request Message
Update Enrolment Response Message Data Definition
Update Enrolment Allowable Values – Response Message
106
109
112
113
122
CANCEL ENROLMENT ......................................................................................................... 123
12.4.1
12.4.2
12.4.3
12.4.4
12.4.5
12.5
Formalise Enrolment Request Message Data Definition
Formalise Enrolment Request Data Rules
Formalise Enrolment Allowable Values - Request Message
Formalise Enrolment Response Message Data Definition
Formalise Enrolment Allowable Values – Response Message
UPDATE ENROLMENT ......................................................................................................... 106
12.3.1
12.3.2
12.3.3
12.3.4
12.3.5
12.4
79
81
83
84
93
FORMALISE ENROLMENT...................................................................................................... 94
12.2.1
12.2.2
12.2.3
12.2.4
12.2.5
12.3
Create Enrolment Request Message Data Definition
Create Enrolment Request Data Rules
Create Enrolment Allowable Values – Request
Create Enrolment Response Message Data Definition
Create Enrolment Allowable Values – Response Message
Cancel Enrolment Request Message Data Definition
Cancel Enrolment Request Data Rules
Cancel Enrolment Allowable Values - Request Message
Cancel Enrolment Response Message Data Definition
Cancel Enrolment Allowable Values – Response Message
123
124
124
124
125
QUERY ENROLMENTS ......................................................................................................... 126
12.5.1
12.5.2
12.5.3
12.5.4
12.5.5
Query Enrolment Request Message Data Definition
Query Enrolment Request Data Rules
Query Enrolment Allowable Values – Request Message
Query Enrolment Response Message Data Definitions
Query Enrolment Allowable Values – Response Message
Version Number: 1.50 v1.0 final
Page 3 of 230
126
128
128
129
141
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
APPENDIX E – ATTENDANCES INTERFACE ............................................................. 142
13
13.1
CREATE ATTENDANCES ..................................................................................................... 142
13.1.1
13.1.2
13.1.3
13.1.4
13.1.5
13.2
142
148
155
156
157
QUERY ATTENDANCES ....................................................................................................... 158
13.2.1
13.2.2
13.2.3
13.2.4
13.2.5
13.3
Create Attendance Request Message Data Definition
Create Attendance Request Data Rules
Create Attendance Allowable Values - Request Message
Create Attendance Response Message Data Definition
Create Attendance Allowable Values - Response Message
Query Attendance Request Message Data Definition
Query Attendance Request Data Rules
Query Attendance Allowable Values – Request Message
Query Attendance Response Message Data Definition
Query Attendance Allowable Values – Response Message
158
159
160
160
171
CANCEL ATTENDANCE ....................................................................................................... 172
13.3.1
13.3.2
13.3.3
13.3.4
13.3.5
Cancel Attendance Request Message Data Definition
Cancel Attendance Request Data Rules
Cancel Attendance Allowable Values – Request Message
Cancel Attendance Response Message Data Definitions
Cancel Attendance Allowable Values – Response Message
172
173
173
174
174
APPENDIX F – IS CASE INTERFACE ............................................................................ 175
14
14.1
QUERY IS CASE.................................................................................................................. 175
14.1.1
14.1.2
14.1.3
14.1.4
14.1.5
Query IS Case Request Message Data Definition
Query IS Case Request Data Rules
Query IS Case Allowable Values – Request Message
Query IS Case Response Message Data Definition
Query IS Case Allowable Values – Response Message
175
176
176
177
182
APPENDIX G – IS CASE CLAIMS INTERFACE .......................................................... 183
15
15.1
CREATE IS CASE CLAIM ..................................................................................................... 183
15.1.1
15.1.2
15.1.3
15.1.4
15.1.5
15.2
183
184
185
186
187
QUERY IS CASE CLAIMS .................................................................................................... 188
15.2.1
15.2.2
15.2.3
15.2.4
15.2.5
15.3
Create IS Case Claim Request Message Data Definition
Create IS Case ClaimRequest Data Rules
Create IS Case Claim Allowable Values
Create IS Case Claim Response Message Data Definition
Create IS Case ClaimAllowable Values – Response Message
Query IS Case Claim Request Message Data Definition
Query IS Case ClaimRequest Data Rules
Query IS Case Claim Allowable Values – Request Message
Query IS Case Claim Response Message Data Definition
Query IS Case Claim Allowable Values – Response Message
188
189
189
190
194
CANCEL IS CASE CLAIM .................................................................................................... 195
15.3.1
15.3.2
15.3.3
15.3.4
Cancel IS Case Claim Request Message Data Definition
Cancel IS Case Claim Request Data Rules
Cancel IS Case Claim Response Message Data Definitions
Query IS Case Claim Allowable Values – Response Message
195
196
197
197
APPENDIX H – MESSAGES INTERFACE ..................................................................... 198
16
16.1
RETRIEVE MESSAGES ......................................................................................................... 198
16.1.1
16.1.2
16.1.3
16.1.4
16.1.5
Retrieve Messages Request Message Data Definition
Retrieve Messages Request Data Rules
Retrieve Messages Allowable Values – Request Message
Retrieve Messages Response Message Data Definition
Retrieve Messages Allowable Values - Response Message
198
199
199
200
201
17
APPENDIX I – VACANCY INTERFACE ........................................................................ 202
18
APPENDIX J – CARE PROVIDED AND VACANCY INTERFACE ............................ 202
18.1
UPDATE CARE PROVIDED ................................................................................................... 202
18.1.1
18.1.2
18.1.3
18.1.4
Update Care Provided Request Message Data Definition
Update Care Provided Request Data Rules
Update Care Provided Allowable Values – Request Message
Update Care Provided Response Message Data Definition
202
206
211
212
APPENDIX K – REMITTANCE INTERFACE ............................................................... 213
19
19.1
QUERY REMITTANCE BY PAYEE ......................................................................................... 213
19.1.1
Query Remittance by Payee Request Message Data Definition
Version Number: 1.50 v1.0 final
Page 4 of 230
213
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
19.1.2
19.1.3
19.1.4
19.2
Query Remittance by Payee Request Data Rules
Query Remittance by Payee Allowable Values – Request Message
Query Remittance by Payee Response Message Data Definition
214
215
215
QUERY PAYMENTS FOR CCB APPROVAL ........................................................................... 218
19.2.1
19.2.2
19.2.3
19.2.4
Query Payments for CCB Approval Request Message Data Definition
Query Payments for CCB Approval Request Data Rules
Query Payments for CCB Approval Allowable Values – Request Message
Query Payments for CCB Approval Response Message Data Definition
218
219
219
220
APPENDIX L – DIAGNOSTIC INTERFACE.................................................................. 222
20
20.1
PING INTERFACE ................................................................................................................ 222
20.1.1
20.1.2
20.1.3
Ping Interface Request Message Data Definition
Ping Interface Request Data Rules
Ping Interface Response Message Data Definition
222
222
223
21
APPENDIX M – SUMMING AND COUNTING RULES FOR ATTENDANCE.......... 224
22
APPENDIX N – DATA MODEL ........................................................................................ 225
23
APPENDIX O – DOCUMENT CHANGE HISTORY ...................................................... 226
23.1
23.2
23.3
23.4
23.5
23.6
CHANGES FROM VERSION 1.40 TO 1.50 DRAFT V0.01 ........................................................ 226
CHANGES FROM VERSION 1.50 DRAFT V0.01 TO DRAFT V0.02 .......................................... 226
CHANGES FROM VERSION 1.50 DRAFT V0.02 TO DRAFT V0.03 .......................................... 227
CHANGES FROM VERSION 1.50 DRAFT V0.03 TO DRAFT V0.04 .......................................... 227
CHANGES FROM VERSION 1.50 DRAFT V0.04 TO DRAFT V0.05 .......................................... 228
CHANGES FROM VERSION 1.50 DRAFT V0.05 TO DRAFT V0.06 .......................................... 228
APPENDIX P – SPECIAL CHARACTERS .................................................................................... 229
Version Number: 1.50 v1.0 final
Page 5 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
1
Overview
The Child Care Management Solution is a national child care computer system for the
administration and payment of Child Care Benefit fee relief on behalf of parents to
approved child care services. It will also provide for the collection of information
about the supply and usage of child care across Australia.
The CCMS will allow all CCB approved child care services to provide information
directly to FaHCSIA via the internet to facilitate the calculation and payment of CCB
fee reduction on behalf of children in their service.
Services will use software available from third party Software Providers to record
child and attendance information. This information will be transferred through the
Service Provider Interface to FaHCSIA.
This document provides the technical specifications for the Service Provider Interface
and is intended to provide information for third party Software Providers to the child
care industry. It covers the following:
 Interface Details – technical infrastructure, interface messages and security
and authentication and errors
 Interface Data – data formats and commonly used data terms
 Explanation of the Query Interface
 Interface Examples
 Interface Availability
 Development and Testing Process
 Detailed Specifications
Version Number: 1.50 v1.0 final
Page 6 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
2
Interface Overview
In order to interact with the CCMS, Service Providers will be required to use software
that is capable of transferring enrolment, attendance and service data to FaHCSIA.
The software will send the data through a Web Service / SOAP interface that is
accessible via the Internet.
Figure 1 – High Level Technical Architecture
The transfer of data will occur via a secure HTTPS connection and Service Providers
will need to authenticate via a username and password.
The software used by Service Providers will interface the following data to and from
FaHCSIA:
 Limited Service Provider and CCB Approval details
 CCB Enrolments
 Weekly Attendance Details
 Vacancy Reporting
 Message for Service Providers
2.1 CCB Approval and Service Provider Details
Service Providers will be able to retrieve and update limited details relating to their
Service and their CCB Approval. To facilitate this, the Service Provider Interface
provides the functions to query Service and CCB Approval details, as well as update
Personnel details, Operational Profile details and Fee details.
2.2 CCB Enrolments
Service Providers will need to create and update enrolment details for each child that
attends care at their service. To facilitate this, the Service Provider Interface provides
the functions to create, update and query enrolment details.
2.3 Attendance Details
Service Providers will need to provide attendance and session information to
FaHCSIA on a weekly basis for each child who attends care. The Attendance record
contains detailed information about the hours, type and fee charged for care so that the
CCB fee reductions can be determined. The Service Provider Interface provides the
function to create, query and cancel attendance details.
2.4 Service Provider Other Details
The Service Provider Interface also provides the ability to transfer care provided
andvacancy information to FaHCSIA on a weekly basis. In addition, an interface will
be provided to enable Service Providers to receive messages from FaHCSIA
regarding their service.
Version Number: 1.50 v1.0 final
Page 7 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
3
Interface Details
The following section provides an overview of the technical specifications of the
Service Provider Interface.
3.1 Transport Protocol / Technical Infrastructure
The Service Provider Interface will be available via the Internet; therefore an Internet
connection is required to access the interface. It is anticipated that Service Providers
will use a commercially available ISP (Internet Service Provider) via a broadband or
similar connection to access the Internet. The speed of the Internet connection will
influence performance of the data transfer.
Figure 2 – High Level Technical Architecture
It is recommended that Service Providers protect their computer systems via a firewall
or similar, to prevent unauthorised access to their equipment and information.
The interface transport protocol will be HTTP v1.1 with SSL, commonly known as
HTTPS. This is a common standard for secure transfer of data via the Internet.
3.2 Interface Messages
The transfer of data between Service Providers and FaHCSIA will use a Web Service
/ SOAP message structure. This is an XML based interface standard that is commonly
used for machine-to-machine interaction.
An example of the SOAP message structure is illustrated below.
Figure 3 – SOAP Interface Message Structure
Version Number: 1.50 v1.0 final
Page 8 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
The standard SOAP message structure comprises of the SOAP Envelope, the SOAP
Header and the SOAP Body. The Service Provider Interface will use these elements in
the following way:
Figure 4 – Definitions of SOAP Components
SOAP Envelope
Contains the SOAP Header and SOAP Body
SOAP Header
Used for Security and Authentication Information.
SOAP Body
Used for Interfaced Data, return messages and fault codes.
A request, response pattern will be used for the interfacing of data between Service
Providers and FaHCSIA. The request is used to pass information to FaHCSIA, the
response contains information returned from FaHCSIA to the Service Provider.
Figure 5 –Request Response Pattern between Service Providers and FaHCSIA
Where practical the interface will allow for multiple requests to be packaged together
reducing the number of round trips. For example, the interface will allow the
submission of multiple attendance records within a single call.
Version Number: 1.50 v1.0 final
Page 9 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
3.3 Security and Authentication
FaHCSIA will issue all Services with a username and password, which will be used to
access the interface. A single username and password will be issued to each Service,
which in turn will be linked to their CCB approval(s).
Figure 6 – Username and Password example, single service
CCB Long
Day Care
Approval
Service
Username:
Password:
Username1
Password1
CCB After
School Care
Approval
It is necessary for the software that supports multiple Services (eg larger organisations
with centralised administrative processes and multiple services) to manage the
credentials for each Service. It is the responsibility of the Software Provider to
securely store the credentials of a Service Provider in their software.
Figure 7 – Username and Password example, multiple services
Same Owner or Same Software System
CCB Long
Day Care
Approval
Service A
Username:
Password:
CCB After
School
Care
Approval
Username A
Password A
Service B
Username:
Password:
CCB Long
Day Care
Approval
Username B
Password B
Each Service will have it own credentials.
Version Number: 1.50 v1.0 final
Page 10 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
In order to reduce complexity of third party software systems, the Service Provider
Interface will not be session based. Therefore, the credentials of the Service Provider
will need to be passed each time a request is sent to FaHCSIA.
The Service Provider Interface will support the WS-Security specification (WSSE v
1.0) for the transfer of user credentials. The WSSE specification provides a structure
within the SOAP Header to store the credentials. Figure 8, illustrates the user
credentials within the SOAP message.
Figure 8 – SOAP Message including User Credentials
The username and password are in clear text within the message. They are however,
encrypted via the HTTPS transport protocol making the transfer secure.
3.4 Interface Errors
The Service Provider Interface will handle errors in one of two ways. If the entire
interface message could not be processed then the error will be processed as a SOAP
Fault. This means that there is an underlying problem with the transfer of data to
FaHCSIA. If the error exists within the data to be processed then it will be handled as
a Return Code and Return Message. This means that there is a problem with the data
that has been submitted and would typically need to be corrected by the user and
resubmitted.
3.4.1
SOAP Faults
SOAP Faults will be used for all errors that prevent the processing of the interface
message. For example, SOAP Faults are generated if the message is not well formed
or an authentication issue exists. Figure 9, displays a sample return message
containing a SOAP Fault.
Version Number: 1.50 v1.0 final
Page 11 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Figure 9 – Example of a SOAP Fault
The SOAP Fault sits within the SOAP Body of the interface message structure. The
fault code and fault string provide exact information in regards to the fault. For
example, in Figure 9 the SOAP Fault is for an invalid username and password. The
SOAP Fault may contain detailed stack information, which may be useful when
trouble-shooting errors with FaHCSIA but would not be easily understood by an end
user.
Refer to the addendum to this document for the list of known SOAP faults.
3.4.2
Return Code, Return Errors and Return Message
The second method for error handling will be via Return Code, Return Error and
Return Message. This method will be used for all ‘business type’ errors that occur
during the processing of an interface message. A ‘non-zero’ Return Code indicates
that an error has occurred with the processing; the corresponding Return Error is the
unique identifier of the problem during processing and the corresponding Return
Message will indicate the details of the error. For example, an error will be generated
for incomplete data.
Figure 10 – Example of Error Messages for Data Formats
When a business type error occurs, a ‘non-zero’ Return Code, Return Error and
Return Message will be generated. In the case where the interface made multiple
similar requests a Return Code, Return Error and Return Message will be provided for
each request in the interface call.
The Return Code is a generic number used to identify the error type of the problem
that has occurred. The following table provides a list of Return Codes used by the
Service Provider Interface:
Version Number: 1.50 v1.0 final
Page 12 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Return Code
Description
0
The message is OK.
1
Warning message. For example, ‘No records have been found’ when a query is executed.
2
Required data has not been specified in the request message.
3
Validation failed on data specified in the request message.
4
Unable to locate data specified in the request message.
5
Undetermined application error
6
To be determined
7
To be determined
8
To be determined
9
Miscellaneous error messages.
The Return Error is an error code specific to the type of error can be used to help track
the source of error or troubleshoot, for example“SOURCE_SYSTEM_CODE_REQ”.
The Return Message will be a human readable error message, which could be
provided to an end user, for example “Source System Code is
required”.
3.4.3
WSDL Import Considerations
If you are importing the WSDL using WCF in .Net, you may experience errors with
the current published WSDL’s. This is due to WCF forcing the sequence of tags in
response XML.
To avoid this problem, do not import the WSDL using WCF in .Net or the work
around is to modify the WSDL to the correct sequence.
Version Number: 1.50 v1.0 final
Page 13 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
4
Interface Data
The following section provides information about the interface data requirements. For
specific data and interface requirements refer to the relevant appendix.
4.1 Data Formats
The data formatting used across the Service Provider Interface is compliant with
standard WSDL data types.
4.2 Source System Code
All software (and major revisions of software) that interfaces with FaHCSIA requires
a unique identifier. This identifier will be known as the Source System Code. It will
be used to help track and resolve errors that occur in the interface.
Figure 12 – Example of Source System Code
<SourceSystemCode>A2345RD</SourceSystemCode>
All messages sent to FaHCSIA by a Service Provider will need to include the Source
System Code of the software. The code will be checked and validated prior to
processing the interface message. If the code is invalid the processing of the message
will fail.
Prior to development and testing, Software Providers will be required to contact
DEEWR and obtain their unique source system code.
4.3 Service Provider Reference
In order to reduce errors caused by ‘duplicate’ records, the software will need to
uniquely identify enrolment, attendance and session records via a Service Provider
Reference. The Enrolment Service Provider Reference must be unique across all
Enrolments for an approved Service. Likewise, the Attendance Service Provider
Reference must be unique across all activeAttendance for an approved Service and the
Session Service Provider Reference must be unique across all activeSessions for an
approved Service.
The Service Provider Reference does not need to be unique across enrolment,
attendance and session records. For example, an Enrolment could have the same
reference as an attendance but no two enrolments or two attendance records could
have the same reference.
Figure 13 – Example of the Service Provider Reference
<ServiceProviderEnrolmentReference>REF000001</ServiceProviderEnrolmentReference>
In the case where the Service Provider cancels an attendance record and then submits
a new attendance for the week,the Service Provider References on the attendance and
associated sessions can be reused as long as they are unique across all active
Attendance and Sessions for the approved Service.
Version Number: 1.50 v1.0 final
Page 14 of 230
Revision Date: 13/12/2012
FaHCSIA
CCMS – Service Provider Interface Technical Specifications
4.4 Attendance Batch Number
To ‘identify’ or ‘label’ a batch of attendance records submitted via the interface to
FaHCSIA, the attendance record can contain a Batch Number.
The intent of this field is to assist with the tracking and processing of a group of
attendance records. For example, the software could put the same batch number on all
attendance records submitted on a given day.
Figure 14 – Example of the Attendance Batch Number
<ServiceProviderAttendanceBatchNumber>REFB000001</ServiceProviderAttendanceBatchNumber
>
The Attendance Batch Number is a text field, which can take up to 30 characters. This
is not mandatory and does not need to be used.
4.5 CCB Approval Id
Where a CCB Approval Id is required by the interface, the Service Provider will need
to specify their valid CCB Approval Id issued by DEEWR. In order to ensure Service
Providers are creating enrolments for valid CCB Approvals, the CCB Approval Id is
mandatory for most transactions.
The CCB Approval Id refers to the Service’s CCB Approval. For example, if a
Service has approval to operate CCB Long Day Care and CCB After School Care,
then the Service will have two CCB Approval Ids.
Software Providers will need to store approval information (CCB Approval Id) within
their software to be used when interfacing data.
4.6 FaCSIA Enrolment Id
When the Service successfully creates an Enrolment, a ‘FaCSIA Enrolment Id’ will be
generated and provided to the Service Provider in the response message. The FaCSIA
Enrolment Id is a unique identifier and is required to query or update an Enrolment as
well as submit, query and cancel attendance data through the interface.
Software Providers will need to store the FaCSIA Enrolment Id against the Enrolment
record within the software. If the FaCSIA Enrolment Id is not specified when needed
in future transactions, then the transaction will fail.
4.7 FaCSIA Attendance Id
When the Service successfully creates an Attendance record, the FaCSIA Attendance
Id will be interfaced to the Service Provider in the response message. The FaCSIA
Attendance Id is required to query and cancel attendance data through the interface.
Software Providers will need to store the FaCSIA Attendance Id against the
attendance record within the software. If the FaCSIA Attendance Id is not specified
when needed in future transactions, then the transaction will fail.
Version Number: 1.50 v1.0 final
Page 15 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
4.8 Transaction Id
Whenever a Service Provider interfaces with FaHCSIA, a Transaction Id will be
required in the request message to identify the transaction. This will be returned in the
response message. The transaction Id should be unique and may take the form of a
time stamp (eg 20061030102334567) or some other unique Id such as a global unique
identifier (GUID).
The reason for this Transaction Id is to assist in resolving problems and troubleshoot
interface errors. FaHCSIA will be receiving many messages from different providers
and different software, the Transaction Id will aid in identifying a particular request
message.
4.9 Authorised Person data
This is the person in the Service who authorised the submission of the transaction and
associated data to CCMS.
The authorised officer of the Service is to be satisfied that the data submitted to the
CCMS for processing reflects information supplied by each family and actual
attendances and absences for each child. Other people may be involved in the creation
of the transaction (such as entering absences) but the authorised person is the person
who takes responsibility for the submitted transaction.
4.9.1
Authorised Person Id
The Authorised Person Id represents a current Authorised or Key Person who can
approve submission of all data into CCMS. The Authorised Person Id is an alpha
numeric identifier of that person. Each authorised person must be allocated a unique
Id within the service. The Id must not be shared or re-used between people and should
preferably point back to the personnel or some similar record of the authorised person.
From version 1.50, Services can provide the list of Authorised and Key personnel
through the Update Personnel interface, replacing existing manual processes. Over
time, matching and validation of Authorised Person details on transactions other than
queries will be introduced.
4.10 Service Client Ids
Where Service Client Ids are required by the interface, the Service Provider will need
to specify a unique identifier for both the child and the parent/guardian. This is to
ensure Service Providers are not creating duplicate and/or overlapping enrolments for
the same parent/guardian and child combinations, regardless of the enrolment type
submitted.
There is no expectation that this value will be a Statistical Linkage Key (SLK).
The Service Client Ids should in no way identify the clients, such as names. Global
unique identifiers (GUIDs) should also not be used for Service Client Ids.
Version Number: 1.50 v1.0 final
Page 16 of 230
Revision Date: 13/12/2012
FaHCSIA
CCMS – Service Provider Interface Technical Specifications
4.11 IS Case Ids
When an Inclusion Support Case has been submitted and approved for a service, there
will be an associated IS Case ID. This IS Case ID will be used when submitting
attendances that are associated with an IS Case, and on IS Claims when claiming
against a case.
4.12 IS Case Claim Ids
This is the ID that is generated on submission of an IS Case Claim record. The IS
Case Claim ID is only required if a query against a particular IS Case Claim is
needed, or if the IS Case Claim needs to be cancelled.
Version Number: 1.50 v1.0 final
Page 17 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
5
Query Interfaces
The following section provides information on the ‘query interfaces’. These interfaces
can be used to review the processing progress of enrolment and attendance data as
well as the related payment data.
5.1 Basic Operation of the query
To perform a query operation the software will need to send a message to FaHCSIA
with the query parameters. For example, the message may include record Ids, status
and date ranges.
Figure 15 – Query Process
The interface will query the FaHCSIA system for the information specified in the
query request and return a response containing the records matching the query
parameters.
In order to reduce transmission problems and performance issues, records matching
the query parameters will be returned in a page of records. Typically software will
query and return page one, in the event that more data exists then it will re-query to
get the next page until all pages of data have been retrieved. A flag on the response
record indicates if it is the last page of data.
Version Number: 1.50 v1.0 final
Page 18 of 230
Revision Date: 13/12/2012
FaHCSIA
CCMS – Service Provider Interface Technical Specifications
Figure 16 – Pages of Records
In the event that no records match the query parameters, a Return Code of one (1) will
be generated with a Return Error and Return Message indicating that ‘No records
have been found matching the search parameters’.
5.2 Page Size
Page size refers to the number of records returned per page. Software can specify the
page size on the query request. Pages sizes cannot be smaller than one record and will
have a maximum size.
In the event that a query requests a page size greater than the maximum, the default
page size will be used instead.
If the page size is not specified by the software, then the default page size of records
will be used.
5.3 Page Number
As part of the query request, the software can specify the page number that it wishes
to return.
If the software does not specify the page number, then the default page number (the
first page) will be returned.
5.4 Last Page Indicator
The last page indicator is used to indicate whether or not the record set returned is the
last page of records.
If the Last Page indicator is True then this is the last page and no more records exist
that match the query parameters. If the Last Page indictor is False then this indicates
more records exist that match the query parameters and software can request the next
page.
Version Number: 1.50 v1.0 final
Page 19 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
6
Interface Examples
The following section provides an example of the request message, the response
message, a SOAP fault and a ‘non zero’ return codes. For exact data specifications,
please consult the relevant appendix.
6.1 Example Request Message
The following provides an example of a request to create a new enrolment.
<?xml version="1.0" encoding="UTF-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/07/secext"
soap:mustUnderstand="0">
<wsse:UsernameToken xmlns:wsu="http://schemas.xmlsoap.org/ws/2002/07/utility"
wsu:Id="SecurityToken-9b2f99a0-31cc-4e83-bdd8-218fae0d1f3a">
<wsse:Username>USERNAME</wsse:Username>
<wsse:Password Type="wsse:passwordText">password</wsse:Password>
<wsse:Nonce>ptP+lRHx+CIXrNPOxrgtPg==</wsse:Nonce>
<wsu:Created>2010-05-26T12:11:07Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<FaCSIAEnrolmentInterface_CreateEnrolment_Input xmlns="http://facsia.gov.au/interfaces">
<TransactionId>SPI_ENRC_403251211720571</TransactionId>
<SourceSystemCode>FOFMS V1.30</SourceSystemCode>
<NewEnrolment>
<ServiceProviderEnrolmentReference>SPI_ENRC_403251211738472</ServiceProvide
rEnrolmentReference>
<Type>Informal</Type>
<ChildCRN />
<ChildDateOfBirth>2001-01-01</ChildDateOfBirth>
<ParentGuardianCRN />
<ParentGuardianDateOfBirth>1975-01-01</ParentGuardianDateOfBirth>
<StartDate>2010-02-16</StartDate>
<EndDate>2010-02-17</EndDate>
<CCBApprovalId>1-11GZO</CCBApprovalId>
<ServiceType>FDC</ServiceType>
<RequestEnrolmentAdvance />
<ChildServiceClientId>JoanneWhite</ChildServiceClientId>
<ParentGuardianServiceClientId>DavidWhite</ParentGuardianServiceClientId>
<AuthorisedPersonFirstName>Author</AuthorisedPersonFirstName>
<AuthorisedPersonLastName>Rise</AuthorisedPersonLastName>
<AuthorisedPersonId>SysAdmin</AuthorisedPersonId>
<ChildIndigenousStatus />
<ChildSpecialNeeds />
<ChildSpecialNeedsEffectiveDate />
<ChildDisability />
<ChildDisabilityEffectiveDate />
<JFAEligibilityDetailsRequest />
</NewEnrolment>
</FaCSIAEnrolmentInterface_CreateEnrolment_Input>
</soap:Body>
</soap:Envelope>
Version Number: 1.50 v1.0 final
Page 20 of 230
Revision Date: 13/12/2012
FaHCSIA
CCMS – Service Provider Interface Technical Specifications
6.2 Example Response Message
The following provides an example of the response message FaHCSIA will generate
for the successful creation of a new enrolment.
<?xml version="1.0" encoding="UTF-8" ?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns:FaCSIAEnrolmentInterface_CreateEnrolment_Output xmlns:ns="http://facsia.gov.au/interfaces">
<ns:TransactionId>SPI_ENRC_403251211720571</ns:TransactionId>
<ns:ReturnCode>0</ns:ReturnCode>
<ns:ReturnError />
<ns:ReturnMessage>OK</ns:ReturnMessage>
<Enrolment xmlns="http://facsia.gov.au/interfaces">
<ChildServiceClientId>JoanneWhite</ChildServiceClientId>
<ParentGuardianServiceClientId>DavidWhite</ParentGuardianServiceClientId>
<CCBApprovalId>1-11GZO</CCBApprovalId>
<FaCSIAEnrolmentId>1-DEKZT</FaCSIAEnrolmentId>
<ServiceProviderEnrolmentReference>SPI_ENRC_403251211738472</ServiceProvide
rEnrolmentReference>
<Type>Informal</Type>
<StartDate>2010-02-16</StartDate>
<EndDate>2010-02-17</EndDate>
<Status>Active</Status>
<ServiceType>FDC</ServiceType>
<ChildDateOfBirth>2001-01-01</ChildDateOfBirth>
<ParentGuardianDateOfBirth>1975-01-01</ParentGuardianDateOfBirth>
<EnrolmentAdvanceStatus>Pending</EnrolmentAdvanceStatus>
<RequestEnrolmentAdvance>N</RequestEnrolmentAdvance>
<ListOfJFAEligibility />
</Enrolment>
</ns:FaCSIAEnrolmentInterface_CreateEnrolment_Output>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
6.3 Example SOAP Fault
The following provides an example of SOAP fault where an invalid username and
password has been provided.
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>Either an invalid user name or password was specified in the request
for operation, &apos;CreateEnrolment&apos;.
(SBL-EAI-05163)</faultstring>
<detail>
<siebelf:errorstack xmlns:siebelf="http://www.siebel.com/ws/fault">
<siebelf:error>
<siebelf:errorsymbol>IDS_EAI_WS_RELOGIN_FAILURE</siebe
lf:errorsymbol>
<siebelf:errormsg>Either an invalid user name or
password was specified in the request for operation,
&apos;CreateEnrolment&apos;.(SBL-EAI05163)</siebelf:errormsg>
</siebelf:error>
</siebelf:errorstack>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
6.4 Example Non Zero Return Code
The following provides an example of a ‘non-zero’ Return Code FaHCSIA will
generate if the Source System Code is invalid.
<?xml version="1.0" encoding="UTF-8" ?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns:FaCSIAEnrolmentInterface_CreateEnrolment_Output xmlns:ns="http://facsia.gov.au/interfaces">
<ns:TransactionId>SPI_ENRC_4032513533142399</ns:TransactionId>
<ns:ReturnCode>2</ns:ReturnCode>
<ns:ReturnError>AUTH_PERSON_FST_NAME_REQ</ns:ReturnError>
<ns:ReturnMessage>Authorised Person First Name required</ns:ReturnMessage>
</ns:FaCSIAEnrolmentInterface_CreateEnrolment_Output>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Version Number: 1.50 v1.0 final
Page 21 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
7
Interface Availability
The following section provides information on interface availability. Software
designers should take into account availability of the FaHCSIA system when
designing their software.
7.1 Production
It is expected that the interface will be generally available1 at all times. Support for
the interface will be provided Monday to Friday, 8am to 8pm AEST, excluding ACT
public holidays. In the event that the interface is unavailable DEEWR will endeavour
to provide information to the Service Providers about the outage.
Software designers should be aware of the availability of FaHCSIA Systems when
designing their software. If the interface is unavailable, it is expected that the Service
Provider Software will store the data and when the interface is available the data will
be re-sent. For example, the software may try and send the data once it has been
entered, however if the interface is unavailable it should be stored and resent again
later. Alternatively, the Service Provider may batch up the data and send this through
at the end of the day or week. Therefore, the unavailability of the FaHCSIA interface
should not stop the day-to-day operation of a Service.
A ‘Ping’ interface has been defined that will enable software to query the FaHCSIA
systems and can be used to test connectivity and authentication. The interface
provides no functionality other than to return a blank response. The intent of the
interface is to assist in the testing and diagnosing connection and authentication
issues.
Ideally, FaHCSIA would prefer that software be designed so that services using the
same software do not interface data at exactly the same time. That is, FaHCSIA would
prefer the load of data from a Software Provider to be ‘randomly’ spread across the
day and not all transmitted at the same time.
7.2 Test System
Any test system provided by FaHCSIA will have varying levels of availability.
Software Providers should contact DEEWR to determine availability before using a
test system.
1
Generally available means that FaHCSIA will endeavour to have the interface available; outages,
maintenance periods and factors outside of FaHCSIA control may prevent this.
Version Number: 1.50 v1.0 final
Page 22 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
8
Interface Development and Testing
The following section provides an overview of the testing and development approach
for the Child Care Management System.
This approach may be modified over time depending on development progress and
comments from Software Developers.
8.1 Release of Updated Specification
The specification was first released as a draft in November 2006 with version 1.00
released on the FaHCSIA website in March 2007. Version 1.10 of the specification
was released July 2007 and incorporated a number of requests for additional
functionality.
Version 1.20 incorporated all corrections that had been issued via the CCMS SWT
Release Notesup to its release date in March 2009. It also incorporated new and
modified business rules.
Refer to Appendix O – Document Change History in each of the released versions for
a complete list of changes introduced in that version.
8.2 Test System Available
To assist Software Providers in their development activity a site has been developed
for Software Providers to test their application. All of the Service Provider Interfaces
that requires testing will be made available via the Internet.
The test site was released on 20 April2007and will be available until all application
development has ceased.
To access the site please email ccms@deewr.gov.au with your company name,
contact telephone number and email address. A software starter pack will then be sent
to the provider. It will include the system URL, userid, password and start data as
well as information about support arrangements.
It is expected that Software Providers will need to communicate regularly with
DEEWR and FaHCSIA during the testing phase to ensure their software is working as
intended. Any queries should be directed to ccms@deewr.gov.au.
8.3 Software Registration
Software Providers will need to ensure that their software meets CCMS requirements.
To do this they will need to successfully complete registration testing and provide the
Department with a Business Assurance Statement.
To commence the registration process a Software Provider should send an email to
ccms@deewr.gov.au requesting their software to be registered with FaHCSIA.
A test pack will then be sent to Software Providers which will include test scenarios, a
Business Assurance Statement and contact details of the Registration Officer. Once
Version Number: 1.50 v1.0 final
Page 23 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
the software has passed registration written advice will be sent to the Software
Provider and the list of registered software on DEEWR CCMS home page will be
updated.
To ensure all software continues to meet CCMS requirements, previously registered
software may require re-registration as part of the implementation of changes made to
this document.
DEEWR will advise Software Providers if and when their software requires reregistration.
8.4 Piloting
The final stage before implementation is the CCMS pilot. The pilot will provide
additional verification of the integrity of the business and system components
associated with CCMS. It will involve a small number of Service Providers
(Providers self-nominate) and Software Providers. The Department will continue to
liaise with Software Providers as more information is available for the pilot.
The CCMS pilot concluded in early 2008.
Version Number: 1.50 v1.0 final
Page 24 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
9
Appendix A – Glossary
Term
Explanation
Attendance
The attendance record contains detailed information about the sessions of care the child
attends for the week. It specifies the individual sessions, the hours used and the fee
charged. Centrelink uses the attendance record to calculate fee reduction for the week.
Carer
Refers to Home Based Carers.
CCB Approval Id
The unique identifier of the CCB Approval on the FaHCSIA system.
DEEWR
The Department of Education, Employment and Workplace Relations
Enrolment
An enrolment associates a child and their parent to a CCB Approval. An enrolment must
exist in the FaHCSIA system before attendance records can be submitted or an enrolment
advance paid.
FaHCSIA
The Department of Housing, Families, Community Services and Indigenous Affairs
FaCSIA Attendance Id
The unique identifier of the Attendance record on the FaHCSIA system.
FaCSIA Enrolment Id
The unique identifier of the Enrolment record on the FaHCSIA system.
HTTPS
HyperText Transfer Protocol layered over the Secure Sockets Layer (SSL) protocol.
IS Case ID
The unique identifier of the IS Case record on the FaHCSIA system.
IS Case Claim ID
The unique identifier of the IS Case Claim record on the FaHCSIA system.
ISP – Internet Service
Provider
A company that provides access to the internet.
Operational Profile
The Operational Profile describes when a Service is open for business. It includes the
number of hours, the days and the number of weeks open per year.
Profile
See Operational Profile.
Service
Services are approved by the Australian Government to accept Child Care Benefit on
behalf of a family from DEEWR.
Software Provider
A Third Party Provider of software to the Child Care Industry.
SOAP – Simple
Object Access
Protocol
Protocol that uses a combination of XML-based data structuring and the Hyper Text
Transfer Protocol (HTTP) to define a standardized method for invoking methods in objects
distributed in diverse operating environments across the internet.
SSL
Secure Sockets Layer A commonly used protocol for managing the security of a message
transmission on the internet. Sockets refers to the sockets method of passing data back
and forth between a client and a server program in a network or between program layers in
the same computer. SSL uses the public- and private-key encryption system, which
includes the use of a digital certificate.
Web Service
A web service is a collection of protocols and standards used for exchanging data between
applications or systems. Software applications written in various programming languages
and running on various platforms can use web services to exchange data over computer
networks like the Internet in a manner similar to inter-process communication on a single
computer. This interoperability (e.g., between Java and Python, or Windows and Linux
applications) is due to the use of open standards.
WSDL Web Services
Description Language
An XML language used to describe a Web service and to specify how to communicate with
it.
XML
Extensible Markup Language XML is a simplified subset of the Standardized Generalized
Markup Language (SGML) that provides a file format for representing data, a schema for
describing data structure, and a mechanism for extending and annotating HTML with
semantic information.
For other CCMS related shortened forms, please refer to the CCMS Child Care
Service Handbook.
Version Number: 1.50 Draft
Page 25 of 230
Revision Date: 3/02/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
10
Appendix B – Interface Listing
The following provides a listing and description of the interfaces that comprise the Service Provider Interface:
10.1 CCB Approval Interface
Interface
Description
Purpose
Query CCB Approval
Query for Service Provider and CCB Approval
Details
This interface is used to query and retrieve Service Provider and CCB Approval Details including Profile, Persons,
Home Based Carers and Fees by CCB Approval.
Update Profile
Update existing Operational Profile Details
This interface is used to update Operational Profile details by CCB Approval.
Update All Personnel
Create/update Personnel Details
This interface is used to create/update personnel details for people associated with the CCB Approval including carers.
Update Fees
Create/update Fee Details
This interface is used to create/update fee information for the CCB Approval.
10.2 Enrolment Interface
Interface
Description
Purpose
Create Enrolment
Create a new Enrolment Record
This interface is used to create Enrolment records. An Enrolment is required before Attendance can be submitted.
Formalise Enrolment
Formalises an Informal Enrolment
This interface is used to change an Informal Enrolment into a Formal Enrolment.
Update Enrolment
Update an Existing Enrolment
This interface is used to update Enrolment records.
Cancel Enrolment
Cancel an Existing Enrolment
The interface is used to cancel Enrolment records. Enrolment records can be cancelled in the status of Submitted or in
the status of Active if there are no active Attendance records against that Enrolment.
Query Enrolments
Query for Enrolments
This interface is used to query Enrolment records and retrieve information about the Enrolment.
10.3 Attendance Interface
Interface
Description
Purpose
Create Attendances
Create a new Attendance Record
The interface is used to create Attendance records for all children attending the service.
Query Attendances
Query for Attendance Records
The interface is used to query Attendance records and retrieve information about the Attendance.
Cancel Attendance
Cancel an existing Attendance Record
The interface is used to cancel Attendance records. An Attendance needs to be cancelled if an error or mistake has
been made to enable resubmission of updated data.
Version Number: 1.50 v1.0 final
Page 26 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
10.4 IS Case Interface
Interface
Description
Purpose
Query IS Case
Query for IS Case Records
The interface is used to query IS Case records and retrieve information about the IS Case.
10.5 IS Case Claim Interface
Interface
Description
Purpose
Create IS Case Claim
Create a new IS Case ClaimRecord
The interface is used to create an IS Case Claim against an IS Case.
Query IS Case Claim
Query for IS Case Claim Records
The interface is used to query IS Case Claim records and retrieve information about the IS Case Claim.
Cancel IS Case Claim
Cancel an existing IS Case Claim Record
The interface is used to cancel IS Case Claim records. An IS Case Claim needs to be cancelled if an error or mistake
has been made to enable resubmission of updated data.
10.6 Messages Interface
Interface
Description
Purpose
Retrieve Messages
Retrieves messages generated by FaHCSIA
for the Service Provider
The interface is used to retrieve messages. FaHCSIA will generate messages for Service Providers for a variety of
circumstances.
10.7 Care Provided and Vacancy Interface
Interface
Description
Purpose
Update Care Provided
Reports care provided and vacancies for the
Places Offered by the Service
The interface is used to report care provided and vacancies. Service Providers are required to report the care provided
and number of vacancies at their Service for the upcoming weeks.
10.8 Remittance Interface
Interface
Description
Purpose
Query Remittance
Query of all payments to a payee.
The interface is used to query payments made to payee and therefore provides remittance detail on payments made to
the payee. This is used where payments cross CCB approvals and Services.
Query Payments
Query of all payments for a CCB Approval
The interface is used to query payments made against a CCB Approval.
10.9 Diagnostic Interface
Interface
Description
Purpose
Ping Interface
Provides FaHCSIA’s current system
time in response to a successful
request message
The intent of the interface is to enable Service Providers to test connectivity and authentication with CCMS.
Version Number: 1.50 v1.0 final
Page 27 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11
Appendix C – CCB Approval Interface
The following section provides specific information about the Service Provider CCB Approval Interfaces.
11.1 Query CCB Approval
The Query CCB Approval Interface Function is to be used when the Service wishes to query for the latest information held relating to their
Service, CCB Approval, Accreditations, Places, Operational Profile, Operating Hours, Personnel, Fees and, if applicable, Home Based Carers.
11.1.1 Query CCB Approval Request Message Data Definition
CCB Approval Interface - Query Approval - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction. Ideally it would
be a GUID (Global Unique
Identifier).
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval.
Updated By DEEWR Since
[UpdatedByDEEWRSince]
N
ISO D/T
19
YYYY-MMDDTHH:MM:SS
2006-0612T15:12:34
Indicates that the query should
return the CCB Approval if any
records associated with it have
been updated by DEEWR (and not
via the SP interfaces) since
this date/time stamp.
Return Home Based Carer
Data
[ReturnCarerData]
N
Boolean
1
N/A
N
Indicates if Home Based Carer
data should be returned in the
All Personnel part of the
query.
Return End Dated
Personnel
[ReturnEndDatedPersonnel]
N
Boolean
1
N/A
N
Indicates if Personnel who have
an end date in the past are
returned in the query.
Version Number: 1.50 v1.0 final
Page 28 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query Approval - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Return Profile History
[ReturnProfileHistory]
N
Boolean
1
N/A
Y
Indicates if historical
operational profile data should
be returned as part of the
query if updated by DEEWR since
parameter is not specified.
Page Size
[PageSize]
N
Int
-
NNN
10
Maximum number of records
returned.
Page Number
[PageNumber]
N
Int
-
NNN
1
The page number of records to
return.
11.1.2 Query CCB Approval Request Data Rules
CCB Approval Interface - Query CCB Approval - Rules
Comments
[Source System Code] must be valid system.
Registered version of software must be greater than or equal to 1.50.
If [Updated By DEEWR Since] is provided in the request, only updates made by DEEWR staff are considered in combination with the date
provided.
If [Return Carer Data] = “Y”, All Personnel will include data where [Relationship] = “Carer”, else Home Based Carer data is not returned.
If [Return End Dated Personnel] = “Y”, All Personnel will include data where [End Date] is less than or equal to today but not more than two years
(720 days).
If [Return Profile History] = “Y”, Profiles will include Operational Profile records (regardless of status) where [Date of Effect] is greater than today
minus 730 days.
11.1.3 Query CCB Approval Allowable Values – Request
Data Name
Values
N/A
Refer to addendum to this document for current production allowable values
Version Number: 1.50 v1.0 final
Page 29 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.1.4 Query CCB Approval Response Message Data Definition
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
20061030183312AHJ
KNMNKLHNNFDNFLUJK
LJ
Unique identifier of the
transaction.
Return Code
[ReturnCode]
Int
-
N/A
0
Return Code for Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
Return Message for Request
Message.
Last Page
[LastPage]
Boolean
1
N/A
Y
Indicates this is the last page
of data for the query
CCB Approval Id
[Approval].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
Service Type
[Approval].[ServiceType]
String
30
N/A
LDC
Primary Service Type for this
CCB Approval
Approval Source System
Code
[Approval].[ApprovalSourceSystemCode]
String
30
N/A
CCIS-V2.0-ASXT
Source system code stored on
the CCB approval of the
registered software that last
submitted attendance data
against this CCB Approval
CCB Start Date
[Approval].[CCBStartDate]
ISO D
10
YYYY-MM-DD
2006-08-20
Identifies the date that
services are to commence under
the CCB Approval
CCB End Date
[Approval].[CCBEndDate]
ISO D
10
YYYY-MM-DD
2006-08-20
Identifies the date that
services are to be completed or
the date the CCB Approval was
terminated.
CCB Approval Status
[Approval].[CCBApprovalStatus]
String
30
N/A
Pending Closure
Actual approval status of the
CCB Approval.
Version Number: 1.50 v1.0 final
Page 30 of 230
Return Error for Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
CCB Pending Closure Date
[Approval].[CCBPendingClosureDate]
ISO D
10
YYYY-MM-DD
2006-08-20
Date of the pending or actual
Service Provider closure.
Service Name
[Approval].[ServiceName]
String
255
N/A
Child Care
Australia
The Name from the Service
Provider’s Vendor record
Service Building
[Approval].[ServiceBuilding]
String
60
N/A
Level 1
Building name and/or floor of
the Service Provider’s primary
business address
Service Street
[Approval].[ServiceStreet]
String
100
N/A
1 Main Street
Street Address of the Service
Provider’s primary business
address
Service Suburb
[Approval].[ServiceSuburb]
String
50
N/A
Greenway
Suburb of the Service
Provider’s primary business
address
Service State
[Approval].[ServiceState]
String
10
N/A
ACT
State of the Service Provider’s
primary business address
Service Postcode
[Approval].[ServicePostcode]
String
30
N/A
2900
Postcode of the Service
Provider’s primary business
address
Postal Building Floor
[Approval].[PostalBuildingFloor]
String
60
N/A
Level 5
Service Provider postal address
details.
Postal Street PO Box
[Approval].[PostalStreetPOBox]
String
100
N/A
PO Box 5
Service Provider postal address
details.
Postal Suburb Town
[Approval].[PostalSuburbTown]
String
50
N/A
Sydney
Service Provider postal address
details.
Postal State
[Approval].[PostalState]
String
10
N/A
NSW
Service Provider postal address
details.
Postal Postcode
[Approval].[PostalPostcode]
String
30
N/A
2000
Service Provider postal address
details.
Service ABN
[Approval].[ServiceABN]
String
11
N/A
1234123412
ABN of the Service Provider
Version Number: 1.50 v1.0 final
Page 31 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Service Phone Number
[Approval].[ServicePhoneNumber]
String
30
N/A
+61212341234
Phone Number of the Service
Provider from the Vendor record
Service Fax Number
[Approval].[ServiceFaxNumber]
String
30
N/A
+61212341234
Fax Number of the Service
Provider from the Vendor record
Service Email
[Approval].[ServiceEmail]
String
50
N/A
mail@care.com
Service Provider Email from CCB
Approval
Service Web Address
[Approval].[ServiceWebAddress]
String
100
N/A
http://www.fahcsi
a.gov.au
The Service Provider’s web
address
Operator Name
[Approval].[OperatorName]
String
255
N/A
Child Care
Australia
The name from the Operator’s
Vendor record
Operator Building
[Approval].[OperatorBuilding]
String
60
N/A
Level 1
Building name and/or floor of
the business address associated
to the CCB Header
Operator Street
[Approval].[OperatorStreet]
String
100
N/A
1 Main Street
Street Address of the business
address associated to the CCB
Header
Operator Suburb
[Approval].[OperatorSuburb]
String
50
N/A
Greenway
Suburb of the business address
associated to the CCB Header
Operator State
[Approval].[OperatorState]
String
10
N/A
ACT
State of the business address
associated to the CCB Header
Operator Postcode
[Approval].[OperatorPostcode]
String
30
N/A
2900
Postcode of the business
address associated to the CCB
Header
Places [Listing]
[Approval]. [ListOfPlaces].[Place]
Age Group
[Approval].[ListOfPlaces].[Place].[Ag
eGroup]
String
30
N/A
0 - 12 Months0 12 Months
Indicates the age group
associated with the place
information
Number of Places
[Approval].[ListOfPlaces].[Place].[Nu
mberOfPlaces]
Int
-
N/A
25
Indicates the number of places
the service can provide.
Version Number: 1.50 v1.0 final
Page 32 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Accreditations [Listing]
[Approval].[ListOfAccreditations].[Ac
creditation]
Type
[Approval].[ListOfAccreditations].[Ac
creditation].[Type]
String
30
N/A
Accreditation
Type of Accreditation
(Certificate, License,
Qualification, etc.) attached
to the CCB Approval
Name
[Approval].[ListOfAccreditations].[Ac
creditation].[Name]
String
100
N/A
OSHC QA
Name of the Accreditation
(Childcare License etc.)
attached to the CCB Approval
Number
[Approval].[ListOfAccreditations].[Ac
creditation].[Number]
String
50
N/A
5
Identification number given by
the issuing body to the
Accreditation attached to the
CCB Approval
Status
[Approval].[ListOfAccreditations].[Ac
creditation].[Status]
String
30
N/A
Expired
Status of the Accreditation
(Active, Under Review etc.)
attached to the CCB Approval
Issued By
[Approval].[ListOfAccreditations].[Ac
creditation].[IssuedBy]
String
100
N/A
National
Childcare
Accreditation
Council
Body that issued the
Accreditation attached to the
CCB Approval
Issued Date
[Approval].[ListOfAccreditations].[Ac
creditation].[IssuedDate]
ISO D
10
YYYY-MM-DD
2006-08-20
Date the Accreditation was
issued attached to the CCB
Approval
End Date
[Approval].[ListOfAccreditations].[Ac
creditation].[EndDate]
ISO D
10
YYYY-MM-DD
2006-08-20
End date of the Accreditation
attached to the CCB Approval
Accreditation Last
Updated Date
[Approval].[ListOfAccreditations].[Ac
creditation].[LastUpdatedDate]
ISO D/T
19
YYYY-MMDDThh:mm:ss
2006-0820T08:00:00
The date/timestamp of the last
update on this accreditation
record
Operational Profile
[Listing]
[Approval].[ListOfOperationalProfiles
].[OperationalProfile]
Operational Profile Row
Id
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[OperationalPr
Id
15
N/A
1-ABCD
The unique row Id of the
operational profile record
Version Number: 1.50 v1.0 final
Page 33 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
ofileRowId]
Comments
issued by the CCMS system.
Status
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[Status]
String
10
N/A
Reject Reason
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[RejectReason]
String
50
N/A
Date of Effect
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[DoE]
ISO D
10
YYYY-MM-DD
2006-08-20
When the operational profile
will take effect.
Current
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[Current]
Boolean
1
N/A
N
Indicates if this is the
current record in the list of
operational profiles
Operational Status
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[OperationalSt
atus]
String
30
N/A
Operational
Indicates the operational
status of the service at the
time of the ‘Date of Effect’.
Operational Status Change
Reason
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[OperationalSt
atusChangeReason]
String
30
N/A
Renovations
The reason the operational
status was changed.
Weeks Open Per Year
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[WeeksPerYear]
Int
-
N/A
40
The number of weeks per year
that the Service Provider
operates for the particular
Service Type
Hours Open Per Week
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[HoursPerWeek]
String
6
HHH:MM
009:00
The number of hours per week
that the Service Provider
operates for the particular
Service Type.
Last Updated On
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[LastUpdatedOn
]
ISO D/T
19
YYYY-MMDDThh:mm:ss
2006-0924T12:00:01
Time stamp when this profile is
updated
Last Updated By
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[LastUpdatedBy
]
String
30
N/A
DEEWR
Indicates who last updated the
record.
Update Authorised Person
First Name
[Approval].[ListOfOperationalProfiles
].[UpdateAuthorisedPersonFirstName]
String
50
N/A
John
Indicates first name of the
person who authorised this
Version Number: 1.50 v1.0 final
Page 34 of 230
Submitted
Indicates the status of the
record.
Provides detail of the reason a
transaction was rejected.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
record to be submitted.
Update Authorised Person
Last Name
[Approval].[ListOfOperationalProfiles
].[UpdateAuthorisedPersonLastName]
String
50
N/A
Doe
Indicates last name of the
person who authorised this
record to be submitted.
Update Authorised Person
Id
[Approval].[ListOfOperationalProfiles
].[UpdateAuthorisedPersonId]
String
20
N/A
AUTH001
Indicates the id of the person
who authorised this record to
be submitted.
Operating Hours [Listing]
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[ListOfHours].
[Hours]
Day
[Approval].[ListOfOperationalrofile].
[OperationalProfile].[ListOfHours].[H
ours].[Day]
String
30
N/A
Mon.-Sun.
Indicates the day when the
service is open
Open
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[ListOfHours].
[Hours].[Open]
String
-
N/A
23:00:00
Indicates the time when service
is open. 24 Hour format.
Close
[Approval].[ListOfOperationalProfiles
].[OperationalProfile].[ListOfHours].
[Hours].[Close]
String
-
N/A
23:00:00
Indicates the time when service
is close. 24 Hour format.
All Personnel [Listing]
[Approval].[ListOfAllPersonnel].[AllP
ersonnel]
Personnel Row Id
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[PersonnelRowId]
Id
15
N/A
1-ABCD
The unique row Id of the
personnel record issued by the
CCMS system.
Date of Effect
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[DoE]
ISO D
10
YYYY-MM-DD
2008-09-01
The date when the record starts
taking effect
Current
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Current]
Boolean
1
N/A
N
Indicates if this is the
current record in the list of
operational profiles
Status
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Status]
String
30
N/A
Submitted
The status of the Personnel
record.
Version Number: 1.50 v1.0 final
Page 35 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Reject Reason
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[RejectReason]
String
50
N/A
Service Provider
Personnel Id
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[SPPersonnelId]
String
20
N/A
EMP0001
The id of the person assigned
by the service provider.
CCMS Personnel Id
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[CCMSPersonnelId]
String
20
N/A
1-123456
The unique S_PARTY_ID of the
person assigned by CCMS. Person
Id or CCMS Carer Id.
NQA Id
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[NqaId]
String
20
N/A
1-123456
The NQA id of the person.
Relationship
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Relationship]
String
30
N/A
Employee
Indicates the relationship
between the person and the
service provider
Home Based Carer Status
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[CarerStatus]
String
30
N/A
Active
The status of the Home Based
Carer to the service
Start Date
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[StartDate]
ISO D
10
YYYY-MM-DD
2008-09-01
Start date when the person is
associated with the approval.
End Date
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[EndDate]
ISO D
10
YYYY-MM-DD
2008-09-10
Last date when the person is
associated with the approval.
Last Name
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[LastName]
String
50
N/A
Wright
Surname of person
First Name
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[FirstName]
String
50
N/A
Kym
First Name of person
Title
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Title]
String
30
N/A
Dr
Title of the person
Position Type
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[PositionType]
String
30
N/A
Administration
Identifies the position type
for the contact officer
specifically for that CCB
Approval
Version Number: 1.50 v1.0 final
Page 36 of 230
Sample
Comments
Provides detail of the reason a
transaction was rejected.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Position Title
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[PositionTitle]
String
100
N/A
Administration
Assistance
The actual Position Title for
the contact officer
specifically for that CCB
Approval.
Role
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Role]
String
30
N/A
Key Personnel
Identifies the role of the
contact officer.
Date of Birth
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[DOB]
ISO D
10
YYYY-MM-DD
2008-09-01
The date of birth of the
person.
Email Address
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[EmailAddress]
String
50
*@*.*
test@test.com
Contact email address of the
person
Qualification 1
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Qualification1]
String
30
N/A
BA
First highest qualification of
the person
Qualification 2
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Qualification2]
String
30
N/A
BA
Second highest qualification of
the person
Qualification 3
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Qualification3]
String
30
N/A
BA
Third highest qualification of
the person
Other Qualification
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[QualificationOther]
String
255
N/A
Cert. 4 in
Business
A free text field that allows
service provider to specify the
qualification if they have
selected “Other” in one of the
qualification fields.
Contact
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[IsContact]
Boolean
1
N/A
Y
Indicates whether person is
acting as a contact for the CCB
Approval.
Key Person
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[IsKeyPerson]
Boolean
1
N/A
Y
Indicates whether person is an
Key person
Authorised Person
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[IsAuthorisedPerson]
Boolean
1
N/A
Y
Indicates whether person is an
Authorised person
Authorisation Status
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[AuthorisationStatus]
String
30
N/A
Not Authorised
Person
Indicates the status of the
authorisation
Version Number: 1.50 v1.0 final
Page 37 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Last Updated On
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[LastUpdatedOn]
ISO D/T
19
YYYY-MMDDThh:mm:ss
2006-0924T12:00:01
Time stamp when this profile is
updated. It should be the date
and time when this call is
made.
Last Updated By
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[LastUpdatedBy]
String
30
N/A
DEEWR
Indicates who last updated the
record.
Authorised Person First
Name
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[AuthorisedPersonFirstName]
String
50
N/A
John
Indicates first name of the
person who authorised this
record to be submitted.
Authorised Person Last
Name
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[AuthorisedPersonLastName]
String
50
N/A
Doe
Indicates last name of the
person who authorised this
record to be submitted.
Authorised Person Id
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[AuthorisedPersonId]
String
20
N/A
AUTH001
Indicates the id of the person
who authorised this record to
be submitted.
Phone Number
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[PhoneNumber]
String
30
N/A
0262815864
Phone number
Address Details
[ListOfAllPersonnel].[AllPersonnel].[
Address]
Building / Floor (Address
line 1)
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Address).[Building]
String
60
N/A
TOP
The home address of the Home
Based Carer. The Scheme is not
obliged to provide the home
address and can substitute the
Scheme’s address.
Street / PO Box (Address
line 2)
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Address).[Street]
String
100
N/A
Athllon Drive
The home address of the Home
Based Carer. The Scheme is not
obliged to provide the home
address and can substitute the
Scheme’s address.
Suburb / Town
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Address).[Suburb]
String
50
N/A
Tuggeranong
The home address of the Home
Based Carer. The Scheme is not
obliged to provide the home
address and can substitute the
Scheme’s address.
Version Number: 1.50 v1.0 final
Page 38 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
State
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Address).[State]
String
10
N/A
ACT
The home address of the Home
Based Carer. The Scheme is not
obliged to provide the home
address and can substitute the
Scheme’s address.
Postcode
[Approval].[ListOfAllPersonnel].[AllP
ersonnel].[Address).[Postcode]
String
30
N/A
2900
The home address of the Home
Based Carer. The Scheme is not
obliged to provide the home
address and can substitute the
Scheme’s address.
Fee Sets [Listing]
[Approval].[ListOfFeeHeaders].[FeeHea
der]
Fee Header Row Id
[Approval].[ListOfFeeHeaders].[FeeHea
der].[FeeHeaderRowId]
Id
15
N/A
1-ABCD
The unique row Id of the fee
set record issued by the CCMS
system.
Last Updated On
[Approval].[ListOfFeeHeaders].[FeeHea
der].[LastUpdatedOn]
ISO D/T
19
YYYY-MMDDThh:mm:ss
2006-0924T12:00:01
Time stamp when this fee
structure is last updated. It
should be the date and time
when this call is made.
Last Updated By
[Approval].[ListOfFeeHeaders].[FeeHea
der].[LastUpdatedBy]
String
30
N/A
DEEWR
Indicates who updated this
record.
Update Authorised Person
First Name
[Approval].[ListOfFeeHeaders].[FeeHea
der].[UpdateAuthorisedPersonFirstName
]
String
50
N/A
John
Indicates first name of the
person who authorised this
record to be submitted.
Update Authorised Person
Last Name
[Approval].[ListOfFeeHeaders].[FeeHea
der].[UpdateAuthorisedPersonLastName]
String
50
N/A
Doe
Indicates last name of the
person who authorised this
record to be submitted.
Update Authorised Person
Id
[Approval].[ListOfFeeHeaders].[FeeHea
der].[UpdateAuthorisedPersonId]
String
20
N/A
AUTH001
Indicates the id of the person
who authorised this record to
be submitted.
Date of Effect
[Approval].[ListOfFeeHeaders].[FeeHea
der].[DoE]
ISO D
10
YYYY-MM-DD
2006-09-24
When fee set will take effect.
Version Number: 1.50 v1.0 final
Page 39 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Current
[Approval].[ListOfFeeHeaders].[FeeHea
der].[Current]
Boolean
1
N/A
Y
Indicates the fee set is
current (i.e. closest and
before or equal to Today’s
date, and is Ready to Publish)
Expiry Date
[Approval].[ListOfFeeHeaders].[FeeHea
der].[Expiry Date]
ISO D
10
YYYY-MM-DD
2006-09-24
The last date when fee is in
effect.
Transport Service
[Approval].[ListOfFeeHeaders].[FeeHea
der].[TransportService]
String
30
N/A
Others – Contact
Service for
Details
Indicates the transport service
provided by service provider.
Educational Programs
[Approval].[ListOfFeeHeaders].[FeeHea
der].[EducationalPrograms]
String
30
N/A
No
Indicates whether educational
programs are provided.
Excursion / Incursion
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ExcursionIncursion]
String
30
N/A
Information Not
Provided
Indicates whether excursion or
incursion is included.
Additional Comments
[Approval].[ListOfFeeHeaders].[FeeHea
der].[AdditionalComments]
String
1000
N/A
Contact service
for more
information.
Additional comments for the fee
structure.
Additional Levy
[Approval].[ListOfFeeHeaders].[FeeHea
der].[AdditionalLevy]
Boolean
1
N/A
Y
Indicates whether additional
levy may apply.
Weekly Levy Amount
[Approval].[ListOfFeeHeaders].[FeeHea
der].[LevyAmount]
N.2
-
N/A
10.00
Indicates the weekly levy
amount.
Email Address for
Publication on MyChild
[Approval].[ListOfFeeHeaders].[FeeHea
der].[Email]
String
50
*@*.*
test@test.com
Indicates the email address to
be published on MyChild
Phone Number for
Publication on MyChild
[Approval].[ListOfFeeHeaders].[FeeHea
der].[Phone]
String
30
N/A
+6112345678
Indicates the phone number to
be published on MyChild
Website for Publication
on MyChild
[Approval].[ListOfFeeHeaders].[FeeHea
der].[Website]
String
100
N/A
www.test.com
Indicates the website to be
published on MyChild
Version Number: 1.50 v1.0 final
Page 40 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
MyChild Contact Personnel
Id
[Approval].[ListOfFeeHeaders].[FeeHea
der].[MyChildContactPersonnelId]
String
20
N/A
EMP001
Indicates who MyChild people
can contact in relation to the
fee structure.
MyChild Contact Last Name
[Approval].[ListOfFeeHeaders].[FeeHea
der].[MyChildContactLastName]
String
50
N/A
Doe
MyChild contact person’s last
name
MyChild Contact First
Name
[Approval].[ListOfFeeHeaders].[FeeHea
der].[MyChildContactFirstName]
String
50
N/A
John
MyChild contact person’s first
name
MyChild Contact Phone
Number
[Approval].[ListOfFeeHeaders].[FeeHea
der].[MyChildContactPhone]
String
30
N/A
+6112345678
MyChild contact person’s phone
number
MyChild Contact Email
Address
[Approval].[ListOfFeeHeaders].[FeeHea
der].[MyChildContactEmail]
String
50
N/A
xyz@email.com
MyChild contact person’s email
address
Additional Comments for
Publication on MyChild
[Approval].[ListOfFeeHeaders].[FeeHea
der].[AdditionalCommentsForPublicatio
n]
String
1000
N/A
Contact service
for more
information.
Additional comments for the fee
structure.
Fee Status
[Approval].[ListOfFeeHeaders].[FeeHea
der].[FeeStatus]
String
30
N/A
Publish
Indicates whether the fee is
ready to publish
Reject Reason
[Approval].[ListOfFeeHeaders].[FeeHea
der].[RejectReason]
String
50
N/A
Fee Details [Listing]
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees]
Provides detail of the reason a
transaction was rejected.
Fee Detail Row Id
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[FeeDetailRo
wId]
Id
15
N/A
1-ABCD
The unique row Id of the fee
detail record issued by the
CCMS system.
Age Group
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[AgeGroup]
String
30
N/A
36 Plus months
Indicates the type of age group
of the particular fee
structure.
Period
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[Period]
String
30
N/A
Weekly
Indicates the charge period.
Version Number: 1.50 v1.0 final
Page 41 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Query CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Standard Rate (Min)
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[RateMin]
N.2
-
N/A
10.00
Indicates the minimum rate of
service.
Standard Rate (Max)
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[RateMax]
N.2
-
N/A
12.00
Indicates the maximum rate of
the service.
Nappies Included
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[NappiesIncl
uded]
Boolean
1
N/A
N
Indicates if nappies are
included.
Breakfast Included
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[BreakfastIn
cluded]
Boolean
1
N/A
N
Indicates whether breakfast is
included.
Morning Tea Included
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[MorningTeaI
ncluded]
Boolean
1
N/A
N
Indicates whether morning tea
is included.
Lunch Included
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[LunchInclud
ed]
Boolean
1
N/A
N
Indicates whether lunch is
included.
Afternoon Tea Included
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[AfternoonTe
aIncluded]
Boolean
1
N/A
N
Indicates whether afternoon tea
is included.
Other Meals Included
[Approval].[ListOfFeeHeaders].[FeeHea
der].[ListOfFees].[Fees].[OtherMealsI
ncluded]
Boolean
1
N/A
N
Indicates whether other meals
are included.
Version Number: 1.50 v1.0 final
Page 42 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.1.5 Query CCB Approval Allowable Values – Response Message
Data Name
Values
Approval
CCB Approval Status
Places
Age Group
Accreditations
Type
Status
Operational Profile
Status
Operational Status
Operational Status Change Reason
Operating Hours
Day
All Personnel Details
Refer to addendum to this document for current production allowable values
Relationship
Status
Title
Position Type
Role
Qualification 1
Qualification 2
Qualification 3
Authorisation Status
Fees
Transport Service
Educational Programs
Excursion / Incursion
Version Number: 1.50 v1.0 final
Page 43 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Data Name
Values
Fee Status
Age Group
Period
Version Number: 1.50 v1.0 final
Page 44 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.2 Update Profile
The Update Profile Interface Function is to be used when a Service Provider wishes to update details of their Service, such as operating hours,
associated with their CCB Approval.
11.2.1 Update Profile Request Message Data Definition
CCB Approval Interface - Update Profile - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
AH
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
Authorised Person First
Name
[AuthorisedPersonFirstName]
Y
String
50
N/A
John
Indicates first name of the
person who authorised this
record to be submitted.
Authorised Person Last
Name
[AuthorisedPersonLastName]
Y
String
50
N/A
Doe
Indicates last name of the
person who authorised this
record to be submitted.
Authorised Person Id
[AuthorisedPersonId]
Y
String
20
N/A
AUTH001
Indicates the id of the person
who authorised this record to
be submitted.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
Clear Service Fax
Number
[ClearServiceFaxNumber]
Y
Boolean
1
N/A
N
Indicates whether Service
Provider’s fax number is to be
updated.
Service Fax Number
[ServiceFaxNumber]
N
String
30
N/A
0212341234
Fax Number of the Service
Provider from the Vendor record
Service Phone Number
[ServicePhoneNumber]
N
String
30
N/A
0212341234
Phone Number of the Service
Provider from the Vendor record
Version Number: 1.50 v1.0 final
Page 45 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Profile - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Clear Service Web
Address
[ClearServiceWebAddress]
Y
Boolean
1
N/A
N
Indicates whether Service
Provider’s web address is to be
updated.
Service Web Address
[ServiceWebAddress]
N
String
100
N/A
www.google.com
Web address of the service
provider
Service Email
[ServiceEmail]
N
String
50
N/A
mail@care.com
Service Provider Email from CCB
Approval
Operational Profile
[Listing]
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile]
Date of Effect
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[DoE]
Y
ISO D
10
YYYY-MM-DD
2006-08-20
When the operational profile
will take effect.
Operational Status
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[OperationalStatus]
Y
String
30
N/A
Operational
Indicates the operational
status of the service at the
time of the ‘Date of Effect’.
Operational Status
Change Reason
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[OperationalStatusC
hangeReason]
N
String
30
N/A
Renovations
The reason the operational
status was changed.
Weeks Open Per Year
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[WeeksPerYear]
Y
Int
-
N/A
40
The number of weeks per year
that the Service Provider
operates for the particular
Service Type
Hours Open Per Week
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[HoursPerWeek]
Y
String
6
HHH:MM
009:00
The number of hours per week
that the Service Provider
operates for the particular
Service Type
New Postal Building
Floor
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewPostalBuilding]
N
String
60
N/A
Level 5
New Service Provider postal
address details, if provided,
for manual action by DEEWR.
Version Number: 1.50 v1.0 final
Page 46 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Profile - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
New Postal Street PO
Box
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewPostalStreet]
N
String
100
N/A
24 Smith
Street
New Service Provider postal
address details, if provided,
for manual action by DEEWR.
New Postal Suburb Town
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewPostalSuburb]
N
String
50
N/A
Sydney
New Service Provider postal
address details, if provided,
for manual action by DEEWR.
New Postal State
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewPostalState]
N
String
10
N/A
NSW
New Service Provider postal
address details, if provided,
for manual action by DEEWR.
New Postal Postcode
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewPostalPostcode]
N
String
30
N/A
2000
New Service Provider postal
address details, if provided,
for manual action by DEEWR.
New Business Building
Floor
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewBusinessBuildin
g]
N
String
60
N/A
Level 5
New Service Provider Business
address details, if provided,
for manual action by DEEWR.
New Business Street PO
Box
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewBusinessStreet]
N
String
100
N/A
24 Smith
Street
New Service Provider Business
address details, if provided,
for manual action by DEEWR.
New Business Suburb
Town
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewBusinessSuburb]
N
String
50
N/A
Sydney
New Service Provider Business
address details, if provided,
for manual action by DEEWR.
New Business State
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewBusinessState]
N
String
10
N/A
NSW
New Service Provider Business
address details, if provided,
for manual action by DEEWR.
New Business Postcode
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewBusinessPostcod
e]
N
String
30
N/A
2000
New Service Provider Business
address details, if provided,
for manual action by DEEWR.
New Service Name
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[NewServiceName]
N
String
255
N/A
N
Indicates new service name, if
any
Version Number: 1.50 v1.0 final
Page 47 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Profile - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Operating Hours
[Listing]
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[ListOfHours].[Hour
s]
Day
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[ListOfHours].[Hour
s].[Day]
Y
String
-
30
Mon.-Sun.
Indicates the day when the
service is open. 24 Hour
format.
Open
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[ListOfHours].[Hour
s].[Open]
Y
String
-
N/A
23:30:00
Indicates the time when service
is open. 24 Hour format.
Close
[UpdateProfile].[ListOfUpdateOpe
rationalProfiles].[UpdateOperati
onalProfile].[ListOfHours].[Hour
s].[Close]
Y
String
-
N/A
23:30:00
Indicates the time when service
is close.
11.2.2 Update Profile Request Data Rules
Update Profile - Inbound Message Business Rules
Comments
[Source System Code] must be valid system.
Registered version of software must be greater than or equal to 1.50.
One or more future dated Operational Profile records can exist. Inbound Operational Profile data will replace all
existing future dated Operational Profiles stored in CCMS.
At least one record must be submitted in the Operational Profile [Listing].
[Authorised Person Id] must exist with a current [Service Provider Personnel Id] in Personnel for this CCB
Approval with Authorisation Status = Authorised if indicated by DEEWR.
Refer to the Addendum to this document for determine if validation of
Authorised Person Id against Personnel is currently enforced.
Clear Service Fax Number
If [Clear Service Fax Number] is set ‘Y’, Service Fax Number will be cleared.
Clear Service Phone Number
If [Clear Service Phone Number] is set ‘Y’, Service Phone Number will be cleared.
Version Number: 1.50 v1.0 final
Page 48 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Profile - Inbound Message Business Rules
Comments
Clear Service Web Address
If [Clear Service Web Address] is set ‘Y’, Service Web Address will be cleared.
Date of Effect
[Date of Effect] must be greater than today.
[Date of Effect] must unique within the Profiles submitted in the inbound message.
Operational Status
[Operational Status] must be an allowable value.
Operational Status Change Reason
[Operational Status Change Reason] is mandatory for defined Operational Statuses
Refer to addendum to this document for defined Operational Statuses that
require a Change Reason.
Weeks Open Per Year
[Weeks Open per Year] must be a whole number greater than or equal to 0 and less than or equal to 52.
Weeks Open per Year may not have a decimal point (eg. 50.5)
Hours Open Per Week
[Hours Open per Week] must be less than or equal to 168.
New Postal Address
If any of the following fields are specified, the whole set of fields must be provided:
New Postal Street PO Box
New Postal Suburb Town
New Postal State
New Postal Postcode
New Business Address
If any of the following fields are specified, the whole set of fields must be provided:

New Business Street PO Box

New Business Suburb Town

New Business State

New Business Postcode
Days
The combination of [Day], [Open] and [Close] must be unique on Hours List.
If [ListOfHours].[Hours] contains [Day] = “Mon.-Sun.”
It must be the only item submitted in [ListOfHours].
Version Number: 1.50 v1.0 final
Page 49 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Profile - Inbound Message Business Rules
Comments
If [ListOfHours].[Hours] contains [Day] = “Mon.-Fri.”
No other item in [ListOfHours] can be submitted where [Day] = “Monday”, “Tuesday”, “Wednesday”, “Thursday” or
“Friday”.
Version Number: 1.50 v1.0 final
Page 50 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.2.3 Update Profile Allowable Values – Request
Data Name
Values
Operational Status
Operational Status Change Reason
Refer to addendum to this document for current production allowable values
Day
11.2.4 Update Profile Response Message Data Definition
CCB Approval Interface - Update Profile - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
20061030183312AHJ
KNMNKLHNNFDNFLUJK
LJ
Unique identifier of the
transaction.
CCB Approval Id
[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
Authorised Person First
Name
[AuthorisedPersonFirstName]
String
50
N/A
John
Indicates first name of the person
who authorised this record to be
submitted.
Authorised Person Last
Name
[AuthorisedPersonLastName]
String
50
N/A
Doe
Indicates last name of the person
who authorised this record to be
submitted.
Authorised Person Id
[AuthorisedPersonId]
String
20
N/A
AUTH001
Indicates the id of the person who
authorised this record to be
submitted.
0
Return Code for Request Message.
Return Code
[ReturnCode]
Int
-
N/A
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
Return Message for Request Message.
Last Page
[LastPage]
Boolean
1
N/A
Y
Indicates this is the last page of
Version Number: 1.50 v1.0 final
Page 51 of 230
Return Error for Request Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Profile - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
data for the query
Service Fax Number
[ServiceFaxNumber]
String
30
N/A
+610212341234
Fax Number of the Service Provider
from the Vendor record
Service Phone Number
[ServicePhoneNumber]
String
30
N/A
+610212341234
Phone Number of the Service Provider
from the Vendor record
Service Web Address
[ServiceWebAddress]
String
100
N/A
www.google.com
Web address of the service provider
Service Email
[ServiceEmail]
String
50
N/A
mail@care.com
Service Provider Email from CCB
Approval
Operational Profile
[Listing]
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
Operational Profile Row
Id
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[OperationalProfileRowId]
Id
15
N/A
1-ABCD
The unique row Id of the operational
profile record issued by the CCMS
system.
Status
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[Status]
String
10
N/A
Submitted
Indicates the status of the record.
Date of Effect
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[DoE]
ISO D
10
YYYY-MMDD
2006-08-20
When the operational profile will
take effect.
Current
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[Current]
Boolean
1
N/A
N
Indicates if this is the current
record in the list of operational
profiles
Operational Status
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[OperationalStatus]
String
30
N/A
Operational
Indicates the operational status of
the service at the time of the ‘Date
of Effect’.
Operational Status
Change Reason
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[OperationalStatusChangeReason]
String
30
N/A
Renovation
The reason the operational status
was changed.
Weeks Open Per Year
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
Int
-
N/A
40
The number of weeks per year that
the Service Provider operates for
Version Number: 1.50 v1.0 final
30
Page 52 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Profile - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
.[WeeksPerYear]
Comments
the particular Service Type.
Hours Open Per Week
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[HoursPerWeek]
String
6
HHH:MM
009:00
The number of hours per week that
the Service Provider operates for
the particular Service Type.
New Postal Building
Floor
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewPostalBuilding]
String
60
N/A
Level 5
New Service Provider postal address
details, if provided, for manual
action by DEEWR.
New Postal Street PO
Box
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewPostalStreet]
String
100
N/A
24 Smith Street
New Service Provider postal address
details, if provided, for manual
action by DEEWR.
New Postal Suburb Town
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewPostalSuburbTown]
String
50
N/A
Sydney
New Service Provider postal address
details, if provided, for manual
action by DEEWR.
New Postal State
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewPostalState]
String
10
N/A
NSW
New Service Provider postal address
details, if provided, for manual
action by DEEWR.
New Postal Postcode
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewPostalPostcode]
String
30
N/A
2000
New Service Provider postal address
details, if provided, for manual
action by DEEWR.
New Business Building
Floor
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewBusinessBuilding]
String
60
N/A
Level 5
New Service Provider Business
address details, if provided, for
manual action by DEEWR.
New Business Street PO
Box
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewBusinessStreet]
String
100
N/A
24 Smith Street
New Service Provider Business
address details, if provided, for
manual action by DEEWR.
New Business Suburb
Town
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewBusinessSuburbTown]
String
50
N/A
Sydney
New Service Provider Business
address details, if provided, for
manual action by DEEWR.
New Business State
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewBusinessState]
String
10
N/A
NSW
New Service Provider Business
address details, if provided, for
manual action by DEEWR.
Version Number: 1.50 v1.0 final
Page 53 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Profile - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
New Business Postcode
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewBusinessPostcode]
String
30
N/A
2000
New Service Provider Business
address details, if provided, for
manual action by DEEWR.
New Service Name
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[NewServiceName]
String
255
N/A
N
Indicates new service name, if any
Operating Hours
[Listing]
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[ListOfHours].[Hours]
Day
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[ListOfHours].[Hours].[Day]
String
30
N/A
Mon.-Sun.
Indicates the day when the service
is open.
Open
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[ListOfHours].[Hours].[Open]
String
-
N/A
23:00:00
Indicates the time when service is
open. 24 Hour format.
Close
[ListOfUpdateOperationalProfileRespons
es].[UpdateOperationalProfileResponse]
.[ListOfHours].[Hours].[Close]
String
-
N/A
23:00:00
Indicates the time when service is
close. 24 Hour format.
11.2.5 Update Profile Allowable Values – Response Message
Data Name
Values
Status
Operational Status
Operational Status Change Reason
Refer to addendum to this document for current production allowable values
Day
Version Number: 1.50 v1.0 final
Page 54 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.3 Update All Personnel
The Update All Personnel Interface Function is to be used when a Service Provider wishes to update details of personnel associated with their
CCB Approval.
11.3.1 Update All Personnel Request Message Data Definition
CCB Approval Interface - Update All Personnel - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
AH
Unique identifier of the
transaction.
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
CCB Approval Id
Source System Code
Authorised Person First
Name
[AuthorisedPersonFirstName]
Y
String
50
N/A
John
Indicates first name of the
person who authorised this
record to be submitted.
Authorised Person Last
Name
[AuthorisedPersonLastName]
Y
String
50
N/A
Doe
Indicates last name of the
person who authorised this
record to be submitted.
Y
String
20
N/A
AUTH001
Indicates the id of the person
who authorised this record to
be submitted.
Authorised Person Id
[AuthorisedPersonId]
All Personnel [Listing]
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel]
Date of Effect
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[DoE]
Y
ISO D
10
YYYY-MM-DD
2008-09-01
The date when the record starts
taking effect
Service Provider
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
Y
String
20
N/A
EMP0001
The id of the person assigned
Version Number: 1.50 v1.0 final
Page 55 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Request Message Data Definition
Name
Path
Personnel Id
nnel].[SPPersonnelId]
CCMS Personnel Id
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[CCMSPersonnelId]
N
String
15
N/A
1-123456
The unique S_PARTY_ID of the
person assigned by CCMS. Person
Id or CCMS Carer Id.
NQA Id
[UpdateAllPersonnel][ListOfAll
Personnel].[AllPersonnel].[Nqa
Id]
N
String
20
N/A
1-123456
The NQA id of the person.
Relationship
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Relationship]
Y
String
30
N/A
Employee
Indicates the relationship
between the person and the
service provider.
Home Based Carer Status
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[CarerStatus]
N
String
30
N/A
Active
The status of the Home Based
Carer to the service
Start Date
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[StartDate]
Y
ISO D
10
YYYY-MM-DD
2008-09-01
Start date when the person is
associated with the approval.
End Date
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[EndDate]
N
ISO D
10
YYYY-MM-DD
2008-09-10
Last date when the person is
associated with the approval.
Last Name
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[LastName]
Y
String
50
N/A
Wright
Surname of person
First Name
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[FirstName]
Y
String
50
N/A
Kym
First Name of person
Title
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Title]
Y
String
30
N/A
Dr
Title of the person
Position Type
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
N
String
30
N/A
Administration
Identifies the position type
for the contact officer
specifically for that CCB
Version Number: 1.50 v1.0 final
Mandatory
Data Type
Length
Format
Sample
Comments
by the service provider.
Page 56 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
nnel].[PositionType]
Comments
Approval
Position Title
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[PositionTitle]
N
String
100
N/A
Administration
Assistance
The actual Position Title for
the contact officer
specifically for that CCB
Approval
Role
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Role]
N
String
30
N/A
Key Personnel
Identifies the role of the
contact officer.
Date of Birth
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[DOB]
N
ISO D
10
YYYY-MM-DD
2008-09-01
The date of birth of the
person.
Email Address
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[EmailAddress]
N
String
50
*@*.*
test@test.com
Contact email address of the
person
Qualification 1
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Qualification1]
Y
String
30
N/A
BA
First highest qualification of
the person
Qualification 2
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Qualification2]
N
String
30
N/A
BA
Second highest qualification of
the person
Qualification 3
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Qualification3]
N
String
30
N/A
BA
Third highest qualification of
the person
Other Qualification
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[QualificationOther]
N
String
255
N/A
Cert. 4 in
Business
A free text field that allows
service provider to specify the
qualification if they have
selected “Other” in one of the
qualification fields.
Contact
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[IsContact]
N
Boolean
1
N/A
Y
Indicates whether person is
acting as a contact for the CCB
Approval.
Version Number: 1.50 v1.0 final
Page 57 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Key Person
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[IsKeyPerson]
N
Boolean
1
N/A
Y
Indicates whether person is an
Key person
Authorised Person
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[IsAuthorisedPerson]
N
Boolean
1
N/A
Y
Indicates whether person is an
Authorised person
Phone Number
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[PhoneNumber]
N
String
30
N/A
+610262925834
Phone number
Address Details
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Address]
Building / Floor
(Address line 1)
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Address].[Building]
N
String
60
N/A
TOP
Indicates the building name /
floor where Home Based Carer is
located.
Street / PO Box
(Address line 2)
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Address].[Street]
N
String
100
N/A
Athllon Drive
Specifies the street address
where Home Based Carer is
located.
Suburb / Town
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Address].[Suburb]
N
String
50
N/A
Tuggeranong
Indicates which suburb / town
Home Based Carer is located.
State
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Address].[State]
N
String
10
N/A
ACT
Indicates which state Home
Based Carer is located.
Postcode
[UpdatePersonnel].[ListOfUpdat
eAllPersonnel].[UpdateAllPerso
nnel].[Address].[Postcode]
N
String
30
N/A
2900
Indicates the postcode where
service provider is located.
Version Number: 1.50 v1.0 final
Page 58 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.3.2 Update All Personnel Request Data Rules
Update All Personnel - Business Rules
Inbound Message Business Rules
Comments
[Source System Code] must be valid system.
Registered version of software must be greater than or equal to 1.50.
Only one record can be submitted for a SP_Personnel_id where [Date of Effect] is greater than Today
Inbound Personnel data will replace Personnel records stored in CCMS where [Date of Effect] is greater than
Today.
At least one record must be submitted in the All Personnel [Listing].
[Authorised Person Id] must exist with a current [Service Provider Personnel Id] in Personnel for this CCB
Approval with Authorisation Status = Authorised if indicated by DEEWR.
Refer to the Addendum to this document for determine if validation of
Authorised Person Id against Personnel is currently enforced.
In Personnel for this CCB Approval, if current [CCMS Personnel Id] record has a [Service Provider Personnel Id]
then [Authorised Person Id] must exist as a current [Service Provider Personnel Id] record with Authorisation
Status = Authorised if indicated by DEEWR.
In Personnel for this CCB Approval, if current [CCMS Personnel Id] record does not have a [Service Provider
Personnel Id] then:

inbound [Authorised Person Id] must be the same as inbound [Service Provider Personnel Id]

inbound [Authorised Person] must = Y and stored [Authorised Person] must = Y or
inbound [Key Person] must = Y and stored [Key Person] must = Y

current stored [CCMS Personnel Id] record must have Authorisation Status = Authorised.
Date of Effect
[Date of Effect] must be unique within CCMS_Personnel_Id submitted in the inbound message.
[Date of Effect] must be greater than today.
If [Start Date] is greater than today
[Date of Effect] must equal [Start Date].
If [End Date] is greater than today
[Date of Effect] must equal [End Date].
If [End Date] is less than or equal to today, [Date of Effect] must equal tomorrow.
SP Personnel Id
An [SP Personnel Id] must always have the same [CCMS Personnel Id] within CCB Approval Id.
Version Number: 1.50 v1.0 final
Page 59 of 230
Within a CCB Approval, although there may be many records with the same
SP Personnel Id, an SP Personnel Id must always have the same CCMS
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update All Personnel - Business Rules
Personnel Id.
If both [SP Personnel Id] and [CCMS Personnel Id] are submitted and stored [SP Personnel Id] for that [CCMS
Personnel Id] is not blank, the combination must already exist in CCMS.
Relationship
Personnel details where [Relationship] is equal to “Carer” can only be provided if allowed by Service Type.
Refer to addendum to this document for Service Types that allow submission
of Home Based Carer data.
Carer Status
If [Relationship] is equal to “Carer”
[Carer Status] must not be blank.
If [Relationship] is not equal to “Carer”
[Carer Status] must be blank.
Start Date
[Start Date] must be less than or equal to [End Date], if [End Date] is specified.
Last Name
If the Person has only one name, that name should be populated in both the First Name and Last Name fields.
End Date
[End Date] cannot be specified before the person has a current Personnel record in CCMS.
Last Name
If the Person has only one name, that name should be populated in both the First Name and Last Name fields.
Position Type
If [Relationship] is equal to “Carer”
[Position Type] must be blank.
If [Relationship] is not equal to “Carer”
[Position Type] is mandatory.
Position Title
If [Relationship] is equal to “Carer”
[Position Title] must be blank.
Role
If [Relationship] = “Carer”
Version Number: 1.50 v1.0 final
Page 60 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update All Personnel - Business Rules
[Role] must be blank.
If [Relationship] is not equal to “Carer”
Role is mandatory.
Date of Birth
[Date of Birth] must be less than today.
Email Address
If [Relationship] = “Carer”
[Email Address] must be blank.
Other Qualification
IF [Qualification 1] == “Other”
or [Qualification 2] == “Other”
or [Qualification 3] == “Other”
[Other Qualification] MUST NOT BE blank.
If [Qualification 1]
And [Qualification 2]
And [Qualification 3] is not equal to “Other”
[Other Qualification] MUST BE blank.
Contact
If [Relationship] = “Carer”
[Contact] must be blank.
If [Relationship] is not equal to “Carer” and [Key Person] = “Y”
[Contact] must = “Y”.
If [Relationship] is not equal to “Carer” and [Authorised Person] = “Y”
[Contact] must = “Y”.
Key Person
If [Relationship] = “Carer”
[Key Person] must be blank.
If [Authorised Person] = “Y”
A person can be either an Authorised Person or a Key Person, not both.
[Key Person] must not = “Y”.
If [Authorised Person Id] = [SP Personnel Id] on the inbound message
An authorised person cannot authorise a transaction that removes their own
“key” status.
And [Key Person] = “Y” on the “current” record in CCMS
Version Number: 1.50 v1.0 final
Page 61 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update All Personnel - Business Rules
[Key Person] must also equal “Y” on the inbound record
Authorised Person
If [Relationship] = “Carer”
[Authorised Person] must be blank.
If [Key Person] = “Y”
[Authorised Person] must not = “Y”.
If [Authorised Person Id] = [SP Personnel Id] on the inbound message
An authorised person cannot authorise a transaction that removes their own
“authorised” status.
And [Authorised Person] = “Y” on the “current” record in CCMS
[Authorised Person] must also equal “Y” on the inbound record
Phone Number
If [Relationship] = “Carer”
[Phone Number] must be blank.
If [Relationship] is not equal to “Carer” and [Contact] = “Y”, [Phone Number] must not be blank.
All contacts must provide at least a phone number.
Building / Floor (Address line 1)
If [Relationship] is not equal to “Carer”
[Building / Floor] must be blank.
Street / PO Box (Address line 2)
If [Relationship] is equal to “Carer”
[Street / PO Box (Address line 2)] is mandatory.
If [Relationship] is not equal to “Carer”
[Street / PO Box (Address line 2)] must be blank.
Suburb / Town
If [Relationship] is equal to “Carer”
[Suburb / Town] is mandatory.
If [Relationship] is not equal to “Carer”
[Suburb / Town] must be blank.
State
If [Relationship] is equal to “Carer”
[State] is mandatory.
If [Relationship] is not equal to “Carer”
Version Number: 1.50 v1.0 final
Page 62 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update All Personnel - Business Rules
[State] must be blank.
Postcode
If [Relationship] is equal to “Carer”
[Postcode] is mandatory.
If [Relationship] is not equal to “Carer”
[Postcode] must be blank.
11.3.3 Update All Personnel Allowable Values – Request
Data Name
Values
Relationship
Home Based Carer Status
Title
Position Type
Refer to addendum to this document for current production allowable values
Role
Qualification 1
Qualification 2
Qualification 3
Version Number: 1.50 v1.0 final
Page 63 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.3.4 Update All Personnel Response Message Data Definition
CCB Approval Interface - Update All Personnel - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331
2AHJKNMNKLHNN
FDNFLUJKLJ
Unique identifier of the
transaction.
CCB Approval Id
[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
Authorised Person
First Name
[AuthorisedPersonFirstName]
String
50
N/A
John
Indicates first name of the person
who authorised this record to be
submitted.
Authorised Person
Last Name
[AuthorisedPersonLastName]
String
50
N/A
Doe
Indicates last name of the person
who authorised this record to be
submitted.
Authorised Person Id
[AuthorisedPersonId]
String
20
N/A
AUTH001
Indicates the id of the person who
authorised this record to be
submitted.
0
Return Code for Request Message.
Return Code
[ReturnCode]
Int
-
N/A
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
Return Message for Request Message.
Last Page
[LastPage]
Boolean
1
N/A
Y
Indicates this is the last page of
data for the query
All Personnel
[Listing]
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
Personnel Row Id
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[PersonnelRowId]
Id
15
N/A
1-ABCD
The unique row Id of the personnel
record issued by the CCMS system.
Date of Effect
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[DoE]
ISO D
10
YYYY-MM-DD
2008-09-01
The date when the record starts
taking effect
Version Number: 1.50 v1.0 final
Page 64 of 230
Return Error for Request Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Current
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Current]
Boolean
1
N/A
N
Indicates if this is the current
record in the list of operational
profiles
Status
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Status]
String
30
N/A
Submitted
The status of the Personnel record.
Service Provider
Personnel Id
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[SPPersonnelId]
String
20
N/A
EMP0001
The id of the person assigned by
the service provider.
CCMS Personnel Id
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[CCMSPersonnelId]
String
15
N/A
1-123456
The unique S_PARTY_ID of the person
assigned by CCMS. Person Id or CCMS
Carer Id.
NQA Id
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[NqaId]
String
20
N/A
1-123456
The NQA id of the person.
Relationship
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Relationship]
String
30
N/A
Employee
Indicates the relationship between
the person and the service provider
Home Based Carer
Status
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[CarerStatus]
String
30
N/A
Active
The status of the Home Based Carer
to the service ie Active or Ceased.
Start Date
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[StartDate]
ISO D
10
YYYY-MM-DD
2008-09-01
Start date when the person is
associated with the approval.
End Date
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[EndDate]
ISO D
10
YYYY-MM-DD
2008-09-10
Last date when the person is
associated with the approval.
Last Name
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[LastName]
String
50
N/A
Wright
Surname of person
First Name
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
String
50
N/A
Kym
First Name of person
Version Number: 1.50 v1.0 final
Page 65 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
.[FirstName]
Title
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Title]
String
30
N/A
Dr
Title of the person
Position Type
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[PositionType]
String
30
N/A
Administratio
n
Identifies the position type for
the contact officer specifically
for that CCB Approval.
Position Title
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[PositionTitle]
String
100
N/A
Administratio
n Assistance
The actual Position Title for the
contact officer specifically for
that CCB Approval.
Role
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Role]
String
30
N/A
Key Personnel
Identifies the role of the contact
officer.
Date of Birth
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[DOB]
ISO D
10
YYYY-MM-DD
2008-09-01
The date of birth of the person.
Email Address
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[EmailAddress]
String
50
*@*.*
test@test.com
Contact email address of the person
Qualification 1
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Qualification1]
String
30
N/A
BA
First highest qualification of the
person
Qualification 2
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Qualification2]
String
30
N/A
BA
Second highest qualification of the
person
Qualification 3
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Qualification3]
String
30
N/A
BA
Third highest qualification of the
person
Other Qualification
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[QualificationOther]
String
255
N/A
Cert. 4 in
Business
A free text field that allows
service provider to specify the
qualification if they have selected
“Other” in one of the qualification
fields.
Version Number: 1.50 v1.0 final
Page 66 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Contact
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[IsContact]
Boolean
1
N/A
Y
Indicates whether person is acting
as a contact for the CCB Approval.
Key Person
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[IsKeyPerson]
Boolean
1
N/A
Y
Indicates whether person is an Key
person
Authorised Person
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[IsAuthorisedPerson]
Boolean
1
N/A
Y
Indicates whether person is an
Authorised person
Authorisation Status
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[AuthorisationStatus]
String
30
N/A
Not
Authorised
Indicates the status of the
authorisation
Phone Number
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[PhoneNumber]
String
30
N/A
+610261829593
Phone number
Address Details
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Address]
Building / Floor
(Address line 1)
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Address].[Building]
String
60
N/A
TOP
The home address of the Home Based
Carer. The Scheme is not obliged to
provide the home address and can
substitute the Scheme’s address.
Street / PO Box
(Address line 2)
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Address].[Street]
String
100
N/A
Athllon Drive
The home address of the Home Based
Carer. The Scheme is not obliged to
provide the home address and can
substitute the Scheme’s address.
Suburb / Town
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Address].[Suburb]
String
50
N/A
Tuggeranong
The home address of the Home Based
Carer. The Scheme is not obliged to
provide the home address and can
substitute the Scheme’s address.
State
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Address].[State]
String
10
N/A
ACT
The home address of the Home Based
Carer. The Scheme is not obliged to
provide the home address and can
substitute the Scheme’s address.
Version Number: 1.50 v1.0 final
Page 67 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update All Personnel - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Postcode
[UpdatePersonnel].[ListOfUpdateAllPersonn
elResponses].[UpdateAllPersonnelResponse]
.[Address].[Postcode]
String
30
N/A
2900
The home address of the Home Based
Carer. The Scheme is not obliged to
provide the home address and can
substitute the Scheme’s address.
11.3.5 Update All Personnel Allowable Values – Response Message
Data Name
Values
Status
Relationship
Home Based Carer Status
Title
Position Type
Refer to addendum to this document for current production allowable values
Role
Qualification 1
Qualification 2
Qualification 3
Authorisation Status
Version Number: 1.50 v1.0 final
Page 68 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.4 Update Fees
The Update Fees Interface Function is to be used when a Service Provider wishes to update their service details and fee information, available to
the public via the My Child website.
11.4.1 Update Fees Request Message Data Definition
CCB Approval Interface - Update Fees - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
2006103018331
2AH
Unique identifier of the
transaction.
Source System
Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the registered
Software Provider issued by FaHCSIA
Authorised Person
First Name
[AuthorisedPersonFirstName]
Y
String
50
N/A
John
The first name of the person at the
Service Provider who authorised
this transaction
Authorised Person
Last Name
[AuthorisedPersonLastName]
Y
String
50
N/A
Smythe
The last of the person at the
Service Provider who authorised
this transaction
Authorised Person
Id
[AuthorisedPersonId]
Y
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
Fee Headers
[UpdateFeeHeader]
Date of Effect
[UpdateFeeHeader].[DoE]
Y
ISO D
10
YYYY-MM-DD
2006-09-24
When fee structure will take
effect.
Transport Service
[UpdateFeeHeader].[TransportServ
ice]
Y
String
30
N/A
Others –
Contact
Service for
Details
Indicates the transport service
provided by service provider
Version Number: 1.50 v1.0 final
Page 69 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Fees - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Educational
Programs
[UpdateFeeHeader].[EducationalPr
ograms]
Y
String
30
N/A
No
Indicates whether educational
programs are provided.
Excursion /
Incursion
[UpdateFeeHeader].[ExcursionIncu
rsion]
Y
String
30
N/A
Information
Not Provided
Indicates whether excursion or
incursion is included.
Additional
Comments
[UpdateFeeHeader].[AdditionalCom
ments]
N
String
1000
N/A
Contact
service for
more
information.
Additional comments for the fee
structure.
Additional Levy
[UpdateFeeHeader].[AdditionalLev
y]
N
Boolean
1
N/A
Y
Indicates whether additional levy
may apply.
Weekly Levy
Amount
[UpdateFeeHeader].[LevyAmount]
N
N.2
-
N/A
10.00
Indicates the weekly levy amount.
Email Address for
Publication on
MyChild
[UpdateFeeHeader].[Email]
N
String
50
*@*.*
test@test.com
Indicates the email address to be
published on MyChild
Phone Number for
Publication on
MyChild
[UpdateFeeHeader].[Phone]
Y
String
30
N/A
1234 5678
Indicates the phone number to be
published on MyChild
Website for
Publication on
MyChild
[UpdateFeeHeader].[Website]
N
String
100
N/A
www.test.com
Indicates the website to be
published on MyChild
MyChild Contact
Personnel Id
[UpdateFeeHeader].[MyChildContac
tPersonnelId]
Y
String
15
N/A
EMP001
Indicates who MyChild people can
contact in relation to the fee
structure. The Id should match the
unique person Id (assigned by
FOFMS) as listed under Contacts.
Fees [Listing]
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees]
Version Number: 1.50 v1.0 final
Page 70 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Fees - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Age Group
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[AgeGroup]
Y
String
30
N/A
36 Plus
months
Indicates the type of age group of
the particular fee structure
Period
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[Period]
Y
String
30
N/A
Weekly
Indicates the charge period
Standard Rate
(Min)
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[RateMin]
Y
N.2
-
N/A
10.00
Indicates the minimum rate of
service
Standard Rate
(Max)
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[RateMax]
Y
N.2
-
N/A
12.00
Indicates the maximum rate of the
service.
Nappies Included
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[NappiesInclud
ed]
Y
Boolean
1
N/A
N
Indicates if nappies are included.
Breakfast
Included
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[BreakfastIncl
uded]
Y
Boolean
1
N/A
N
Indicates whether breakfast is
included.
Morning Tea
Included
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[MorningTeaInc
luded]
Y
Boolean
1
N/A
N
Indicates whether morning tea is
included.
Lunch Included
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[LunchIncluded
]
Y
Boolean
1
N/A
N
Indicates whether lunch is
included.
Afternoon Tea
Included
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[AfternoonTeaI
ncluded]
Y
Boolean
1
N/A
N
Indicates whether afternoon tea is
included.
Other Meals
Included
[UpdateFeeHeader].[ListOfUpdateF
ees].[UpdateFees].[OtherMealsInc
luded]
Y
Boolean
1
N/A
N
Indicates whether other meals are
included.
11.4.2 Update Fees Request Data Rules
Update Fees by CCB Approval - Business Rules
Version Number: 1.50 v1.0 final
Page 71 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Inbound Message Business Rules
Comments
[Source System Code] must be valid system.
Registered version of software must be greater than or equal to 1.50.
Page Size, Page Number must be greater than zero.
If Page Size = 0, it will be set to Default Page Size. If Page Number = 0 it will
be set to Default Page Number.
Page Size must be less than or equal to Maximum Page Size.
If Page Size is greater than Maximum Page Size it will be set to the Default
Page Size.
[Authorised Person Id] must exist with a current [Service Provider Personnel Id] in Personnel for this CCB
Approval with Authorisation Status = Authorised if indicated by DEEWR.
Refer to the Addendum to this document for determine if validation of
Authorised Person Id against Personnel is currently enforced.
Fee Sets
Only one fee set can be supplied in the Update Fees transaction.
Date of Effect
[Date of Effect] must be greater than today.
[Date of Effect] must not be greater than Today + Submission Period
Additional Comments
See Appendix P – Special Characters for details of allowed and not allowed
characters.
[Additional Comments] must not contain characters that are not allowed.
Weekly Levy Amount
IF [Additional Levy] == Y,
Service provider must provide the levy amount if they have indicated that
additional levy is applicable.
[Weekly Levy Amount] MUST BE > 0.
IF [Additional Levy] is not equal to “Y”
[Weekly Levy Amount] MUST = 0.
MyChild Contact Personnel Id
[MyChild Contact Personnel Id] must exist in All Personnel in [CCMS Personnel Id] and marked as [Contact] = “Y”.
Service provider selects a contact for fee by filling in the person id (i.e. the
unique id assigned by FOFMS to each person) in the MyChild Contact’s
Person Id field.
This id should exist as a current contact in the contact list at the time the fee
record is submitted.
List of Fees
At least one record must be submitted in the List of Fees.
Age Group
Version Number: 1.50 v1.0 final
Page 72 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Fees by CCB Approval - Business Rules
Inbound Message Business Rules
Comments
Combination of [Age Group] and [Period] must be valid for this Service Type
Refer to addendum to this document for valid combinations of Period type and
Age Groups.
Only one fee can be specified for any combination of Age Group / Period combination
Period
[Period] can not be submitted if not allowed for Service Type.
Refer to addendum to this document for valid period by Service Type.
[Period] must be submitted if mandatory for Service Type.
Refer to addendum to this document for valid period by Service Type.
If any Periods are specified as “Mandatory Within Combination” for the Service Type at least one of those Periods
must be included within the Fee Set.
Refer to addendum to this document for Periods that are mandatory wiithin
combination.
Standard Rate (Min)
[Standard Rate (Min)] is mandatory.
[Standard Rate (Min)] must equal [Standard Rate (Max)] if specified by Service Type.
Refer to addendum to this document for Service Types that require Min Rate
Must Equal Max Rate.
Standard Rate (Max)
Maximum Standard Rate cannot be less than Minimum Standard Rate.
Nappies Included
[Nappies Included] must not = “Y” [Nappies Allowed] = “N” for this Service Type
Refer to addendum to this document for allowed values by Service Type
Breakfast Included
[Breakfast Included] must not = “Y” [Breakfast Allowed] = “N” for this Service Type
Refer to addendum to this document for allowed values by Service Type
Morning Tea Included
[Morning Tea Included] must not = “Y” [Morning Tea Allowed] = “N” for this Service Type
Refer to addendum to this document for allowed values by Service Type
Lunch Included
[Lunch Included] must not = “Y” [Lunch Allowed] = “N” for this Service Type
Refer to addendum to this document for allowed values by Service Type
Afternoon Tea Included
[Afternoon Tea Included] must not = “Y” [Afternoon Tea Allowed] = “N” for this Service Type
Refer to addendum to this document for allowed values by Service Type
Other Meals Included
[Other Meals Included] must not = “Y” [Other Meals Allowed] = “N” for this Service Type
Version Number: 1.50 v1.0 final
Refer to addendum to this document for allowed values by Service Type
Page 73 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
11.4.3 Update Fees Allowable Values – Request
Data Name
Values
Transport Service
Educational Programs
Excursion / Incursion
Refer to addendum to this document for current production allowable values
Age Group
Period
11.4.4 Update Fees Response Message Data Definition
CCB Approval Interface - Update Fees - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331
2AHJKNMNKLHNN
FDNFLUJKLJ
Unique identifier of the
transaction.
CCB Approval Id
[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval
Authorised Person
First Name
[AuthorisedPersonFirstName]
String
50
N/A
John
Indicates first name of the person
who authorised this record to be
submitted.
Authorised Person
Last Name
[AuthorisedPersonLastName]
String
50
N/A
Doe
Indicates last name of the person
who authorised this record to be
submitted.
Authorised Person Id
[AuthorisedPersonId]
String
20
N/A
AUTH001
Indicates the id of the person who
authorised this record to be
submitted.
0
Return Code for Request Message.
Return Code
[ReturnCode]
Int
-
N/A
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
Version Number: 1.50 v1.0 final
Page 74 of 230
Return Error for Request Message.
OK
Return Message for Request Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Fees - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Last Page
[LastPage]
Boolean
1
N/A
Y
Indicates this is the last page of
data for the query
Fee Header Row Id
[UpdateFeeHeaderResponse].[FeeHeaderRowId
]
String
15
N/A
1-AG47Y
Unique identifier of the Fee Set
record on the FaHCSIA system.
Last Updated On
[UpdateFeeHeaderResponse].[LastUpdatedOn]
ISO D/T
19
YYYY-MMDDThh:mm:ss
2006-0924T12:00:01
Time stamp when this fee structure
is last updated. It should be the
date and time when this call is
made.
Date of Effect
[UpdateFeeHeaderResponse].[DoE]
ISO D
10
YYYY-MM-DD
2006-09-24
When fee structure will take
effect.
Current
[UpdateFeeHeaderResponse].[Current]
Boolean
1
N/A
N
Indicates if this is the current
record in the list of operational
profiles
Expiry Date
[UpdateFeeHeaderResponse].[ExpiryDate]
ISO D
10
YYYY-MM-DD
2006-09-24
The last date when fee is in
effect.
Transport Service
[UpdateFeeHeaderResponse].[TransportServi
ce]
String
30
N/A
Others –
Contact
Service for
Details
Indicates the transport service
provided by service provider
Educational Programs
[UpdateFeeHeaderResponse].[EducationalPro
grams]
String
30
N/A
No
Indicates whether educational
programs are provided
Excursion /
Incursion
[UpdateFeeHeaderResponse].[ExcursionIncur
sion]
String
30
N/A
Information
Not Provided
Indicates whether excursion or
incursion is included.
Additional Comments
[UpdateFeeHeaderResponse].[AdditionalComm
ents]
String
1000
N/A
Contact
service for
more
information.
Additional comments for the fee
structure.
Fee Header
Version Number: 1.50 v1.0 final
Page 75 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Fees - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Additional Levy
[UpdateFeeHeaderResponse].[AdditionalLevy
]
Boolean
1
N/A
Y
Indicates whether additional levy
may apply.
Weekly Levy Amount
[UpdateFeeHeaderResponse].[LevyAmount]
N.2
-
N/A
10.00
Indicates the weekly levy amount.
Email Address for
Publication on
MyChild
[UpdateFeeHeaderResponse].[Email]
String
50
*@*.*
test@test.com
Indicates the email address to be
published on MyChild
Phone Number for
Publication on
MyChild
[UpdateFeeHeaderResponse].[Phone]
String
N/A
1234 5678
Indicates the phone number to be
published on MyChild
Website for
Publication on
MyChild
[UpdateFeeHeaderResponse].[Website]
String
100
N/A
www.test.com
Indicates the website to be
published on MyChild
Additional Comments
for Publication on
MyChild
[UpdateFeeHeaderResponse].[AdditionalComm
entsForPublication]
String
1000
N/A
Contact
service for
more
information.
Additional comments for the fee
structure that may be published on
MyChild (Text for publication will
not be finalised until DEEWR has
processed the fee set).
MyChild Contact
Personnel Id
[UpdateFeeHeaderResponse].[MyChildContact
PersonnelId]
String
15
N/A
EMP001
Indicates who MyChild people can
contact in relation to the fee
structure.
MyChild Contact Last
Name
[UpdateFeeHeaderResponse].[MyChildContact
LastName]
String
50
N/A
Doe
MyChild contact person’s last name
MyChild Contact
First Name
[UpdateFeeHeaderResponse].[MyChildContact
FirstName]
String
50
N/A
John
MyChild contact person’s first name
MyChild Contact
Phone Number
[UpdateFeeHeaderResponse].[MyChildContact
Phone]
String
30
N/A
1234 5678
MyChild contact person’s phone
number
MyChild Contact
Email Address
[UpdateFeeHeaderResponse].[MyChildContact
Email]
String
50
N/A
1234 5678
MyChild contact person’s email
address
Fee Status
[UpdateFeeHeaderResponse].[FeeStatus]
String
30
N/A
Publish
Indicates whether the fee is ready
to publish
Version Number: 1.50 v1.0 final
Page 76 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Fees - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Fee Record Details
[Listing]
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse]
Fee Detail Row Id
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[FeeDet
ailRowId]
Id
15
N/A
1-ABCD
The unique row Id of the fee detail
record issued by the CCMS system.
Age Group
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[AgeGro
up]
String
30
N/A
36 Plus
months
Indicates the type of age group of
the particular fee structure.
Period
[FeeHeader].[ListOfUpdateFeesResponses].[
UpdateFeesResponse].[Period]
String
30
N/A
Weekly
Indicates the charge period.
Standard Rate (Min)
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[RateMi
n]
N.2
-
N/A
10.00
Indicates the minimum rate of
service.
Standard Rate (Max)
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[RateMa
x]
N.2
-
N/A
12.00
Indicates the maximum rate of the
service.
Nappies Included
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[Nappie
sIncluded]
Boolean
1
N/A
N
Indicates if nappies are included.
Breakfast Included
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[Breakf
astIncluded]
Boolean
1
N/A
N
Indicates whether breakfast is
included.
Morning Tea Included
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[Mornin
gTeaIncluded]
Boolean
1
N/A
N
Indicates whether morning tea is
included.
Lunch Included
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[LunchI
ncluded]
Boolean
1
N/A
N
Indicates whether lunch is
included.
Afternoon Tea
Included
[UpdateFeeHeaderResponse].[ListOfUpdateFe
esResponses].[UpdateFeesResponse].[Aftern
oonTeaIncluded]
Boolean
1
N/A
N
Indicates whether afternoon tea is
included.
Version Number: 1.50 v1.0 final
Page 77 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
CCB Approval Interface - Update Fees - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Other Meals Included
[UpdateFeeHeaderResponse].[ListOfFees].[F
ees].[OtherMealsIncluded]
Boolean
1
N/A
N
Indicates whether other meals are
included.
11.4.5 Update Fees Allowable Values – Response Message
Data Name
Values
Transport Service
Educational Programs
Excursion / Incursion
Refer to addendum to this document for current production allowable values
Fee Status
Age Group
Period
Version Number: 1.50 v1.0 final
Page 78 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12
Appendix D – Enrolment Interface
The following section provides specific information about the different Service Provider Enrolment Interfaces.
12.1 Create Enrolment
The Create Enrolment Interface Function is to be used when a Service Provider wishes to submit data to FaHCSIA in order to create an
Enrolment. This interface will take the data submitted by the Service Provider and create an enrolment record in the FaHCSIA System. During
the creation process validation of the data submitted by the Service Provider will be undertaken. If the validation and checking of the data is
unsuccessful an error will be generated and no enrolment record will be created.
12.1.1 Create Enrolment Request Message Data Definition
Enrolment Interface - Create Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction. Ideally it would
be a GUID (Global Unique
Identifier).
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
Authorised Person First
Name
[NewEnrolment].[AuthorisedPers
onFirstName]
N
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[NewEnrolment].[AuthorisedPers
onLastName]
N
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised this transaction
Authorised Person Id
[NewEnrolment].[AuthorisedPers
onId]
N
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
Service Provider
Enrolment Reference
[NewEnrolment].[ServiceProvide
rEnrolmentReference]
Y
String
50
N/A
REF000001
Unique identifier of the
enrolment record on the Service
Provider Software.
Version Number: 1.50 v1.0 final
Page 79 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Type
[NewEnrolment].[Type]
Y
String
30
N/A
Formal
The Enrolment Type.
Child CRN
[NewEnrolment].[ChildCRN]
N
String
10
NNNNNNNNNT
123456789T
Issued by Centrelink for the
child
Child Date Of Birth
[NewEnrolment].[ChildDateOfBir
th]
Y
Date
10
YYYY-MM-DD
1998-05-31
The date of birth of the child
Child Service Client Id
[NewEnrolment].[ChildServiceCl
ientId]
N
String
20
N/A
KRMX0001
The unique identifier of the
child issued by the Service
Provider.
Parent Guardian CRN
[NewEnrolment].[ParentGuardian
CRN]
N
String
10
NNNNNNNNNT
987654321A
Issued by Centrelink for the
parent/guardian
Parent Guardian Date Of
Birth
[NewEnrolment].[ParentGuardian
DateOfBirth]
Y
Date
10
YYYY-MM-DD
1978-05-31
The date of birth of the
parent/guardian
Parent Guardian Service
Client Id
[NewEnrolment].[ParentGuardian
ServiceClientId]
N
String
20
N/A
KRMX0001
The unique identifier of the
parent/guardian issued by the
Service Provider.
Start Date
[NewEnrolment].[StartDate]
Y
Date
10
YYYY-MM-DD
2005-05-10
The start date of the enrolment
End Date
[NewEnrolment].[EndDate]
N
Date
10
YYYY-MM-DD
2006-08-20
The end date of the enrolment
CCB Approval Id
[NewEnrolment].[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
Service Type
[NewEnrolment].[ServiceType]
Y
String
30
N/A
FDC
The Service Type for the
Enrolment, it must exist on the
CCB Approval.
Request Enrolment
Advance
[NewEnrolment].[RequestEnrolme
ntAdvance]
N
String
1
N/A
Y
Indicates if the Service wishes
to request an enrolment advance
for this enrolment.
Indigenous Status
[NewEnrolment].[ChildIndigenou
sStatus]
N
String
30
N/A
Torres Strait
Islander
Indigenous Origin of child if
applicable
Version Number: 1.50 v1.0 final
Page 80 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Disability
[NewEnrolment].[ChildDisabilit
y]
N
String
1
N/A
Y
Indicates if the child has a
disability.
Disability Effective
Date
[NewEnrolment].[ChildDisabilit
yEffectiveDate]
N
ISO D
10
YYYY-MM-DD
2005-05-10
The date the Service became
aware of the disability.
Special Needs
[NewEnrolment].[ChildSpecialNe
eds]
N
String
1
N/A
Y
Indicates if the child has a
special need.
Special Needs Effective
Date
[NewEnrolment].[ChildSpecialNe
edsEffectiveDate]
N
ISO D
10
YYYY-MM-DD
2005-05-10
The date the Service became
aware of the special need.
JFA Eligibility Details
Request
[NewEnrolment].[JFAEligibility
DetailsRequest]
N
String
1
N/A
Y
Indicates if there is an
intention by the family to
claim JFA sessions under this
enrolment and the Service has
seen the approval letter from
CLK.
12.1.2 Create Enrolment Request Data Rules
Enrolment Interface - Create Enrolment - Rules
Comments
Source System must be valid system.
The CCB Approval must match an existing record on the FaHCSIA system.
The CCB Approval must be ‘Approved’ before Enrolment can be created.
Enrolment [Service Type] must be valid for the CCB Approval
Authorised Person First Name, Authorised Person Last Name and Authorised Person Id are mandatory if the registered version of software is
greater than or equal to 1.30.
The Parent/Guardian Service Client Id is mandatory if the registered version of software is greater than or equal to 1.30.
Version Number: 1.50 v1.0 final
Page 81 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Rules
Comments
The Child Service Client Id is mandatory if the registered version of software is greater than or equal to 1.30.
If the Parent/Guardian Service Client Id is not null AND the Child Service Client Id is not null:
There must be no overlapping enrolments of any type (excluding AMEP/Other) for the same Parent/Guardian Service Client Id/Child
Service Client Id and CCB Approval Id combination with a status of ‘New’, ‘Submitted’, ‘Active’, ‘Suspended’ or ‘Exited’.
There must be no overlapping Formal enrolments for the same Parent/Guardian CRN/Child CRN and CCB Approval Id combination with a status
of ‘New’, ‘Submitted’, ‘Active’, ‘Suspended’or ‘Exited’.
If the Enrolment Type is ‘Formal’ the following fields are mandatory:

Child CRN

Parent/Guardian CRN
If the Enrolment Type is not equal to Formal the following fields must be blank:

Child CRN

Parent/Guardian CRN
[Child CRN] and [Child Date Of Birth] must match an existing record on the FaHCSIA system for ‘Formal’ Enrolments.
[Parent Guardian CRN] and [Parent Guardian Date Of Birth] must match an existing record on the FaHCSIA system for ‘Formal’ Enrolments.
There must be a ‘current’ Eligibility record for the Parent Guardian / Child combination for ‘Formal’ Enrolments.
If Enrolment Type is not equal to Formal then:

Parent/Guardian Date of Birth and Child Date of Birth must be less than current system date.

Child Date of Birth must be more recent than Parent/Guardian Date of Birth.
Enrolment [Start Date] must be equal to or greater than [CCB Approval Start Date] and less than or equal to [CCB Approval End Date].
The Enrolment [Start Date] must not be greater than X days time or less than Y days time
Refer to addendum to this document for
current production values for X and Y
[Start Date] must be before or equal to [End Date], if [End Date] is provided.
The Request Enrolment Advance flag is mandatory for ‘Formal’ enrolments. It is not relevant for Enrolments that are not Formal and must NOT be
specified.
If it is specified an Error will be generated.
[Indigenous Status] if populated must exist on the valid list.
Disability Effective Date must be less than or equal to system date.
Disability Effective Date must be greater than the child’s date of birth.
Version Number: 1.50 v1.0 final
Page 82 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Rules
Comments
Disability Effective Date is mandatory if Disability = Y.
Disability Effective Date must be blank is Disability on the inbound message is not equal to Y
Special Needs Effective Date must be less than or equal to system date.
Special Needs Effective Date must be greater than the child’s date of birth.
Special Needs Effective Date is mandatory if Special Needs = Y.
Special Needs Effective Date must be blank is Special Needs on the inbound message is not equal to Y
If Enrolment Type is not equal to Formal, JFA Eligibility Details Request must not equal Y.
JFA Eligibility Details Request must exist in the valid list.
12.1.3 Create Enrolment Allowable Values – Request
Data Name
Values
Type
Service Type
Disability
Special Needs
Refer to addendum to this document for current production allowable values
Indigenous Status
JFA Eligibility Details Request
Version Number: 1.50 v1.0 final
Page 83 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.1.4 Create Enrolment Response Message Data Definition
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the
transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval ID
[Enrolment].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[Enrolment].[FaCSIAEnrolmentId]
String
15
N/A
1-2H0XF
Unique identifier of the enrolment
record on the FaHCSIA System.
Service Provider
Enrolment Reference
[Enrolment].[ServiceProviderEnrolment
Reference]
String
50
N/A
REF000001
Unique identifier of the enrolment
record on the Service Provider
Software.
Type
[Enrolment].[Type]
String
30
N/A
Formal
The Enrolment Type.
Start Date
[Enrolment].[StartDate]
Date
10
YYYY-MMDD
2006-05-01
The start date of the enrolment
End Date
[Enrolment].[EndDate]
Date
10
YYYY-MMDD
2007-08-08
The end date of the enrolment
Deemed Exit Date
[Enrolment].[DeemedExitDate]
Date
10
YYYY-MMDD
Status
[Enrolment].[Status]
String
30
N/A
Submitted
The status of the Enrolment.
Child CRN
[Enrolment].[ChildCRN]
String
10
NNNNNNNN
NT
123456789T
Issued by Centrelink for the child
Version Number: 1.50 v1.0 final
Page 84 of 230
The Return Error for the Request
Message.
The end date of the enrolment deemed
by FaHCSIA.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Child First Name
[Enrolment].[ChildFirstName]
String
50
N/A
John
The first name of the child
Child Middle Name
[Enrolment].[ChildMiddleName]
String
50
N/A
James
The middle name of the child
Child Last Name
[Enrolment].[ChildLastName]
String
50
N/A
Smith
The last name of the child
Child Date of Birth
[Enrolment].[ChildDateOfBirth]
Date
10
YYYY-MMDD
1998-05-31
The date of birth of the child
Child Service Client Id
[Enrolment].[ChildServiceClientId]
String
20
N/A
KRMX0001
The unique identifier of the child
issued by the Service Provider.
Child Gender
[Enrolment].[ChildGender]
String
1
N/A
M
The gender of the child
Parent Guardian CRN
[Enrolment].[ParentGuardianCRN]
String
10
NNNNNNNN
NT
987654321A
Issued by Centrelink for the
parent/guardian
Parent Guardian First
Name
[Enrolment].[ParentGuardianFirstName]
String
50
N/A
Mary
The first name of the
parent/guardian
Parent Guardian Middle
Name
[Enrolment].[ParentGuardianMiddleName
]
String
50
N/A
Lisa
The middle name of the
parent/guardian
Parent Guardian Last
Name
[Enrolment].[ParentGuaridanLastName]
String
50
N/A
Smith
The last name of the parent/guardian
Parent Guardian Date of
Birth
[Enrolment].[ParentGuardianDateOfBirt
h]
Date
10
YYYY-MMDD
1978-05-31
The date of birth of the
parent/guardian
Parent Guardian Service
Client Id
[Enrolment].[ParentGuardianServiceCli
entId]
String
20
N/A
KRMX0001
The unique identifier of the
parent/guardian issued by the
Service Provider.
Parent Guardian Gender
[Enrolment].[ParentGuardianGender]
String
1
N/A
F
The gender of the parent/guardian
CCB Eligible Hours
[Enrolment].[CCBEligibleHours]
String
6
HHH:MM
050:00
The eligible CCB hours for the
parent/guardian.
CCB Method
[Enrolment].[CCBMethod]
String
30
N/A
Fee Reduction
The CCB method for the
Version Number: 1.50 v1.0 final
Page 85 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
parent/guardian.
CCB Type
[Enrolment].[CCBType]
String
30
N/A
CCB
The type of CCB the parent/guardian
is receiving.
CCB Percentage
[Enrolment].[CCBPercentage]
Decimal
-
N/A
38
The calculated one child rate of CCB
the parent is entitled to receive
expressed as % (only for Fee
Reduction).
CCB Parent Child Status
[Enrolment].[CCBParentChildStatus]
String
30
N/A
Current
The CCB Status for the
parent/guardian and child
combination
CCB Parent Child Start
Date
[Enrolment].[CCBParentChildStartDate]
Date
10
YYYY-MMDDT
1998-05-12
The date when the parent guardian/
child eligibility started.
CCB Details Updated
[Enrolment].[CCBDetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-05-12T
12:24:05
The date when the eligibility
details for the parent guardian
/child were updated.
YTD Absences
[Enrolment].[YTDAbsences]
Integer
-
N/A
5
The number of absences used year to
date, across all services that the
child attends.
Request Enrolment
Advance
[Enrolment].[RequestEnrolmentAdvance]
String
1
N/A
Y
Indicates if the Service wishes to
request an enrolment advance for
this enrolment.
Service Type
[Enrolment].[ServiceType]
String
30
N/A
FDC
The Service Type for the enrolment.
Enrolment Advance
Amount
[Enrolment].[EnrolmentAdvanceAmount]
Decimal
-
N/A
50.32
The Enrolment Advance Amount
Calculated for the enrolment
Enrolment Advance
Status
[Enrolment].[EnrolmentAdvanceStatus]
String
30
N/A
Payment Created
The Enrolment Advance Payment Status
for the Enrolment.
Indigenous Status
[Enrolment].[ChildIndigenousStatus]
String
30
N/A
Torres Strait
Islander
Indigenous Origin of child if
applicable
Version Number: 1.50 v1.0 final
Page 86 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Disability
[Enrolment].[ChildDisability]
String
1
N/A
Y
Indicates if the child has a
disability
Disability Effective
Date
[Enrolment].[ChildDisabilityEffective
Date]
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware of
the disability.
Special Needs
[Enrolment].[ChildSpecialNeeds]
String
1
N/A
Y
Indicates if the child has a special
need.
Special Needs Effective
Date
[Enrolment].[ChildSpecialNeedsEffecti
veDate]
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware of
the special need.
Formalised Date
[Enrolment].[FormalisedDate]
ISO D
10
N/A
2005-05-10
The date the Enrolment was
formalised.
JFA Eligibility Details
Request
[Enrolment].[JFAEligibilityDetailsReq
uest]
String
1
N/A
Y
Indicates if there is an intention
by the family to claim JFA sessions
under this enrolment and the Service
has seen the approval letter from
CLK.
CCR Method
[Enrolment].[CCRMethod]
String
30
N/A
Pay to Family
The CCR method for the
parent/guardian. Will not be
provided if the Enrolment Type is
‘Informal’.
FaHCSIA Child ID
[Enrolment].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
FaHCSIA Parent ID
[Enrolment].[FaHCSIAParentId]
String
15
N/A
1-PYT465
The FaHCSIA ID of the parent linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
IS Case [Listing]
[Enrolment].[ListOfISCases].[ISCase]
IS Case ID
[Enrolment].[ListOfISCases].[ISCase].
[ISCaseId]
String
15
N/A
1-XDRE243
The ID of a Case linked to this
Enrolment via the Child
Version Number: 1.50 v1.0 final
Page 87 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
IS Case Start Date
[Enrolment].[ListOfISCases].[ISCase].
[StartDate]
ISO D
10
YYYY-MMDD
2009-07-01
The Date that this Case commences
IS Case End Date
[Enrolment].[ListOfISCases].[ISCase].
[EndDate]
ISO D
10
YYYY-MMDD
2010-06-30
The Date that this Case ends.
IS Case Type
[Enrolment].[ListOfISCases].[ISCase].
[Type]
String
30
N/A
ISS
Will return the type of Case.
IS Case Status
[Enrolment].[ListOfISCases].[ISCase].
[Status]
String
30
N/A
Submitted
The status of the IS Case.
IS Review Date
[Enrolment].[ListOfISCases].[ISCase].
[ReviewDate]
ISO D
10
YYYY-MMDD
2010-05-30
The Date that this Case will next
receive a review
ISF First Name
[Enrolment].[ListOfISCases].[ISCase].
[ISFFirstName]
String
50
N/A
Pauline
The first name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
ISF Last Name
[Enrolment].[ListOfISCases].[ISCase].
[ISFLastName]
String
50
N/A
Smith
The last name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
IS Case Setting
[Enrolment].[ListOfISCases].[ISCase].
[Setting]
String
100
N/A
Wombats
The name of the setting or Home
Based Carer, as determined by the
service during the application for
IS funding. Is not validated, to be
used for information.
ISA Region
[Enrolment].[ListOfISCases].[ISCase].
[ISARegion]
String
50
N/A
Western Sydney
This will display the Region that
this Case belongs to
ISA Organisation Name
[Enrolment].[ListOfISCases].[ISCase].
[ISAOrgName]
String
100
N/A
Western Sydney
ISA
The Name of the organisation that
has endorsed the Case to the
Approving Organisation.
Allowed IS Non Face-toFace Hours
[Enrolment].[ListOfISCases].[ISCase].
[TotalISNonFaceToFaceHrsAllowed]
String
10
HHHHHHH:
MM
0000300:00
The total number of hours allowed
for Non Face to Face Home Based
carer time for the period of the
Case. This can be used if children
are absent but a Home Based carer
Version Number: 1.50 v1.0 final
Page 88 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
was still paid.
IS Non Face-to-Face
Hours Balance
[Enrolment].[ListOfISCases].[ISCase].
[ISNonFaceToFaceHrsBalance]
String
10
HHHHHHH:
MM
0000010:00
The total number of Non Face-to-Face
Hours remaining for this Case during
the approval period.
Primary Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerId]
String
30
N/A
FGER343
The ID of the Primary Home Based
Carer, as listed on the Case
submitted by the Service.
Primary Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerFirstName]
String
50
N/A
Angelina
The First Name of the Primary Home
Based Carer
Primary Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerLastName]
String
50
N/A
Acorn
The Last Name of the Primary Home
Based Carer
Primary Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerPostCode]
String
4
NA
2134
The Post Code for the Primary Home
Based Carer
Backup 1 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerId]
String
30
N/A
FFWE343
The ID of Backup Home Based Carer 1,
as listed on the Case submitted by
the Service.
Backup 1 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerFirstName]
String
50
N/A
Bronwyn
The First Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerLastName]
String
50
N/A
Bailey
The Last Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerPostCode]
String
4
NA
2353
The Post Code for Backup Home Based
Carer 1
Backup 2 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerId]
String
30
N/A
FRE465
The ID of Backup Home Based Carer 2,
as listed on the Case submitted by
the Service.
Backup 2 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerFirstName]
String
50
N/A
Callista
The First Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerLastName]
String
50
N/A
Crown
The Last Name of Backup Home Based
Carer 2
Version Number: 1.50 v1.0 final
Page 89 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Backup 2 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerPostCode]
String
4
NA
4532
The Post Code for Backup Home Based
Carer 2
Backup 3 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerId]
String
30
N/A
DFSE4533
The ID of Backup Home Based Carer 3,
as listed on the Case submitted by
the Service.
Backup 3 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerFirstName]
String
50
N/A
Denise
The First Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerLastName]
String
50
N/A
Donohue
The Last Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerPostCode]
String
4
NA
4535
The Post Code for Backup Home Based
Carer 3
IS Case.DaysOfCare
[Listing] – Care Week
Profile
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day]
FaHCSIA Child ID
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked
to this Enrolment, different to the
Service Provider ID, will be
provided for only the child attached
to this enrolment, will be the same
as the Child ID if the enrolment is
formal, will be different if the
enrolment is not formal.
Day of Care
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[DayOfCare]
String
30
N/A
Monday
The Day for which the care has been
approved - from the Care Week
Profile
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[PaymentType]
String
30
N/A
ISS Regular
The Type of care that has been
approved for this day of care.
Variable Week
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[VariableWeek]
String
30
N/A
Week on Week off
The type of Variable Week
IS Case.CareHours
[Listing] – Profile
Summary
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours]
Version Number: 1.50 v1.0 final
Page 90 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Day of Care
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[DayOfC
are]
String
30
N/A
Monday
The Day for which the care has been
approved – from Care Hours
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[Paymen
tType]
String
30
N/A
ISS Regular
The Payment Rate that has been
approved for this day of care.
Maximum Hours For
Setting
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[Maximu
mHrsForSetting]
String
10
HHHHHHH:
MM
0000008:00
The maximum number of hours that can
be claimed for all children in the
approved care environment for this
day
IS Case.Support Hours
[Listing]
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours]
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
PaymentType]
String
30
N/A
ISS Regular
This field will define the what this
Payment is for, ie Extra Home Based
Carer or Out Of Home
Support Hours Period
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Period]
String
30
N/A
Week
This field will define over what
period these hours apply, weekly or
total period
Support Hours
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Hours]
String
10
HHHHHHH:
MM
0000020:00
This will define the hours approved
for this type of Case for this
period
Support Hours Tolerance
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Tolerance]
String
10
HHHHHHH:
MM
0000010:00
This will define the amount that a
claim can vary and be automatically
approved. Claims over the hours +
tolerance will be approved upto that
amount.
Support Hours Balance
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Balance]
String
10
HHHHHHH:
MM
0000400:00
This field will define the remaining
hours available for this Payment
Rate Type for the whole period.
Will be null if Support Hours Period
= Week.
JFA Eligibility
[Listing]
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility]
Version Number: 1.50 v1.0 final
Page 91 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Create Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
JFA Eligibility ID
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Id]
String
30
N/A
1-3RTD43
The unique ID of the JFA
Eligibility. If the eligibility is
updated by Centrelink, then the ID
will be reset.
JFA Eligibility Start
Date
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[StartDate]
ISO D
10
YYYY-MMDD
2005-05-10
Commencement date of JFA
Eligibility. If this date is prior
to the Enrolment Start Date, the
Enrolment Start Date will be
defaulted here.
JFA Eligibility End
Date
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[EndDate]
ISO D
10
YYYY-MMDD
2005-05-10
End date of JFA Eligibility.
JFA Eligibility Days
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Days]
String
3
N/A
1
Number of JFA eligible days approved
for a child care week within the JFA
approval period.
Comments
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Comments]
String
100
N/A
Sight JFA
Approval from
Customer for
Details
Instructions to the Service where
the JFA eligible days cannot be
determined.
JFA Details Updated
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[JFADetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-05-12T
12:24:05
The date Centrelink last updated the
JFA eligibility.
Version Number: 1.50 v1.0 final
Page 92 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.1.5 Create Enrolment Allowable Values – Response Message
Data Name
Values
CCB Parent Child Status
CCB Method
Status
Gender
CCB Type
Type
Disability
Special Needs
Indigenous Status
Refer to addendum to this document for current production allowable values
JFA Eligibility Details Request
CCR Method
IS Case.IS Case Type
IS Case.Day.Payment Type
IS Case.Day.Variable Week
IS Case.Care Hours.Payment Type
IS Case.Support Hours.Payment Type
IS Case.Support Hours.Period
Version Number: 1.50 v1.0 final
Page 93 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.2 Formalise Enrolment
The Formalise Enrolment Interface Function is to be used when a Service Provider wishes to submit data to FaHCSIA in order to upgrade an
existing ‘Informal’ Enrolment into a ‘Formal’ Enrolment. This interface will take the data submitted by the Service Provider and formalise the
enrolment record in the FaHCSIA System. During the formalisation process validation of the data submitted by the Service Provider will be
undertaken. If the validation and checking of the data is unsuccessful an error will be generated and the enrolment type will not be updated.
12.2.1 Formalise Enrolment Request Message Data Definition
Enrolment Interface - Formalise Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
2006103018331
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
Authorised Person First
Name
[FormaliseEnrolment].[Authoris
edPersonFirstName]
N
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[FormaliseEnrolment].[Authoris
edPersonLastName]
N
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised this transaction
Authorised Person Id
[FormaliseEnrolment].[Authoris
edPersonId]
N
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
CCB Approval ID
[FormaliseEnrolment].[CCBAppro
valId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[FormaliseEnrolment].[FaCSIAEn
rolmentId]
Y
String
15
N/A
REF000001
The unique identifier of the
Enrolment on the FaHCSIA
system.
Child CRN
[FormaliseEnrolment].[ChildCRN
]
Y
String
10
NNNNNNNNNT
123456789T
Issued by Centrelink for the
child
Parent Guardian CRN
[FormaliseEnrolment].[ParentGu
Y
String
10
NNNNNNNNNT
987654321A
Issued by Centrelink for the
Version Number: 1.50 v1.0 final
Page 94 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
ardianCRN]
Comments
parent/guardian
Request Enrolment
Advance
[FormaliseEnrolment].[RequestE
nrolmentAdvance]
Y
String
1
N/A
Y
Indicates if the Service wishes
to request an enrolment advance
for this enrolment.
JFA Eligibility Details
Request
[FormaliseEnrolment].[JFAEligi
bilityDetailsRequest]
N
String
1
N/A
Y
Indicates if there is an
intention by the family to
claim JFA sessions under this
enrolment and the Service has
seen the approval letter from
CLK.
12.2.2 Formalise Enrolment Request Data Rules
Formalise Enrolment Request Data Rules
Comments
Source System must be valid system.
[FaCSIA Enrolment Id] must match an existing record on the FaHCSIA system.
There must be no overlapping Formal enrolments for the same Parent/Guardian CRN/Child CRN and CCB Approval Id combination with a status
of ‘New’, ‘Submitted’, ‘Active’, ‘Suspended’or ‘Exited’.
[Child CRN] and [Child Date Of Birth] must match an existing record on the FaHCSIA system for ‘Formal’ Enrolments.
[Parent Guardian CRN] and [Parent Guardian Date Of Birth] must match an existing record on the FaHCSIA system for ‘Formal’ Enrolments.
There must be a ‘current’ Eligibility record for the Parent Guardian / Child combination for ‘Formal’ Enrolments.
Only ‘Informal’ [Type] Enrolments can be formalised.
The Child and Parent/Guardian Service Client Ids are mandatory if the registered version of software is greater than or equal to 1.30. At the point
these Id’s become mandatory, if the record being formalised does not already contain a Child and Parent/Guardian Service Client Id, theformalise
will be rejected.
Services will need to submit an update
enrolment transaction to update the Service
Client Ids and then submit the formalise
transaction.
Authorised Person First Name, Authorised Person Last Name and Authorised Person Id are mandatory if the registered version of software is
greater than or equal to 1.30.
Version Number: 1.50 v1.0 final
Page 95 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Formalise Enrolment Request Data Rules
Comments
JFA Eligibility Details Request must exist in the valid list.
12.2.3 Formalise Enrolment Allowable Values - Request Message
Refer to addendum to this document for current production allowable values.
12.2.4 Formalise Enrolment Response Message Data Definition
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
200610301833121
234
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval ID
[Enrolment].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaHCSIA.
FaCSIA Enrolment Id
[Enrolment].[FaCSIAEnrolmentId]
String
15
N/A
1-2H0XF
Unique identifier of the enrolment
record on the FaHCSIA System.
Service Provider
Enrolment Reference
[Enrolment].[ServiceProviderEnrolmentR
eference]
String
50
N/A
REF000001
Unique identifier of the enrolment
record on the Service Provider
Software.
Type
[Enrolment].[Type]
String
30
N/A
Formal
The Enrolment Type.
Start Date
[Enrolment].[StartDate]
Date
10
YYYY-MMDD
2006-05-01
The start date of the enrolment.
Version Number: 1.50 v1.0 final
Page 96 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
End Date
[Enrolment].[EndDate]
Date
10
YYYY-MMDD
2007-08-08
The end date of the enrolment.
Deemed Exit Date
[Enrolment].[DeemedExitDate]
Date
10
YYYY-MMDD
Status
[Enrolment].[Status]
String
30
N/A
Submitted
The status of the Enrolment.
Child CRN
[Enrolment].[ChildCRN]
String
10
NNNNNNNNN
T
123456789T
Issued by Centrelink for the child
Child First Name
[Enrolment].[ChildFirstName]
String
50
N/A
John
The first name of the child
Child Middle Name
[Enrolment].[ChildMiddleName]
String
50
N/A
James
The middle name of the child
Child Last Name
[Enrolment].[ChildLastName]
String
50
N/A
Smith
The last name of the child
Child Date of Birth
[Enrolment].[ChildDateOfBirth]
Date
10
YYYY-MMDD
1998-05-31
The date of birth of the child
Child Service Client Id
[Enrolment].[ChildServiceClientId]
String
20
N/A
KRMX0001
The unique identifier of the child
issued by the Service Provider.
Child Gender
[Enrolment].[ChildGender]
String
1
N/A
M
The gender of the child
Parent Guardian CRN
[Enrolment].[ParentGuardianCRN]
String
10
NNNNNNNNN
T
987654321A
Issued by Centrelink for the
parent/guardian
Parent Guardian First
Name
[Enrolment].[ParentGuardianFirstName]
String
50
N/A
Mary
The first name of the parent/guardian
Parent Guardian Middle
Name
[Enrolment].[ParentGuardianMiddleName]
String
50
N/A
Lisa
The middle name of the
parent/guardian
Parent Guardian Last
Name
[Enrolment].[ParentGuaridanLastName]
String
50
N/A
Smith
The last name of the parent/guardian
Parent Guardian Date of
Birth
[Enrolment].[ParentGuardianDateOfBirth
]
Date
10
YYYY-MMDD
1978-05-31
The date of birth of the
parent/guardian
Version Number: 1.50 v1.0 final
Page 97 of 230
The end date of the enrolment deemed
by FaHCSIA.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Parent Guardian Service
Client Id
[Enrolment].[ParentGuardianServiceClie
ntId]
String
20
N/A
KRMX0001
The unique identifier of the
parent/guardian issued by the Service
Provider.
Parent Guardian Gender
[Enrolment].[ParentGuardianGender]
String
1
N/A
F
The gender of the parent/guardian
CCB Eligible Hours
[Enrolment].[CCBEligibleHours]
String
6
HHH:MM
050:00
The eligible CCB hours for the
parent/guardian.
CCB Method
[Enrolment].[CCBMethod]
String
30
N/A
Fee Reduction
The CCB method for the
parent/guardian.
CCB Type
[Enrolment].[CCBType]
String
30
N/A
CCB
The type of CCB the parent/guardian
is receiving.
CCB Percentage
[Enrolment].[CCBPercentage]
Decimal
-
N/A
38
The calculated one child rate of CCB
the parent is entitled to receive
expressed as % (only for Fee
Reduction).
CCB Parent Child Status
[Enrolment].[CCBParentChildStatus]
String
30
N/A
Current
The CCB Status for the
parent/guardian and child combination
CCB Parent Child Start
Date
[Enrolment].[CCBParentChildStartDate]
Date
10
YYYY-MMDDT
1998-05-12
The date when the parent guardian/
child eligibility started.
CCB Details Updated
[Enrolment].[CCBDetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm:
ss
2006-05-12T
12:24:05
The date when the eligibility details
for the parent guardian /child were
updated.
YTD Absences
[Enrolment].[YTDAbsences]
Integer
-
N/A
5
The number of absences used year to
date, across all services that the
child attends.
Request Enrolment
Advance
[Enrolment].[RequestEnrolmentAdvance]
String
1
N/A
Y
Indicates if the Service wishes to
request an enrolment advance for this
enrolment.
Service Type
[Enrolment].[ServiceType]
String
30
N/A
FDC
The Service Type for the enrolment.
Enrolment Advance
[Enrolment].[EnrolmentAdvanceAmount]
Decimal
-
N/A
50.32
The Enrolment Advance Amount
Version Number: 1.50 v1.0 final
Page 98 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Amount
Calculated for the enrolment
Enrolment Advance
Status
[Enrolment].[EnrolmentAdvanceStatus]
Indigenous Status
[Enrolment].[ChildIndigenousStatus]
Disability
[Enrolment].[ChildDisability]
Disability Effective
Date
[Enrolment].[ChildDisabilityEffectiveD
ate]
Special Needs
[Enrolment].[ChildSpecialNeeds]
Special Needs Effective
Date
[Enrolment].[ChildSpecialNeedsEffectiv
eDate]
Formalised Date
Comments
[Enrolment].[FormalisedDate]
String
30
N/A
Payment Created
The Enrolment Advance Payment Status
for the Enrolment.
String
30
N/A
Torres Strait
Islander
Indigenous Origin of child if
applicable
String
1
N/A
Y
Indicates if the child has a
disability
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware of
the disability.
String
1
N/A
Y
Indicates if the child has a special
need.
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware of
the special need.
ISO D
10
N/A
2005-05-10
String
1
N/A
Y
The date the Enrolment was
formalised.
JFA Eligibility Details
Request
[Enrolment].[JFAEligibilityDetailsRequ
est]
CCR Method
[Enrolment].[CCRMethod]
String
30
N/A
Pay to Family
The CCR method for the
parent/guardian.
FaHCSIA Child ID
[Enrolment].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked to
this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
FaHCSIA Parent ID
[Enrolment].[FaHCSIAParentId]
String
15
N/A
1-PYT465
The FaHCSIA ID of the parent linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
IS Case [Listing]
[Enrolment].[ListOfISCases].[ISCase]
Version Number: 1.50 v1.0 final
Page 99 of 230
Indicates if there is an intention by
the family to claim JFA sessions
under this enrolment and the Service
has seen the approval letter from
CLK.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
IS Case ID
[Enrolment].[ListOfISCases].[ISCase].[
ISCaseId]
String
15
N/A
1-XDRE243
The ID of a Case linked to this
Enrolment via the Child
IS Case Start Date
[Enrolment].[ListOfISCases].[ISCase].[
StartDate]
ISO D
10
YYYY-MMDD
2009-07-01
The Date that this Case commences
IS Case End Date
[Enrolment].[ListOfISCases].[ISCase].[
EndDate]
ISO D
10
YYYY-MMDD
2010-06-30
The Date that this Case ends.
IS Case Type
[Enrolment].[ListOfISCases].[ISCase].[
Type]
String
30
N/A
ISS
Will return the type of Case.
IS Review Date
[Enrolment].[ListOfISCases].[ISCase].[
ReviewDate]
ISO D
10
YYYY-MMDD
2010-05-30
The Date that this Case will next
receive a review
IS Case Status
[Enrolment].[ListOfISCases].[ISCase].[
Status]
String
30
N/A
Submitted
The status of the IS Case.
ISF First Name
[Enrolment].[ListOfISCases].[ISCase].[
ISFFirstName]
String
50
N/A
Pauline
The first name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
ISF Last Name
[Enrolment].[ListOfISCases].[ISCase].[
ISFLastName]
String
50
N/A
Smith
The last name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
IS Case Setting
[Enrolment].[ListOfISCases].[ISCase].[
Setting]
String
100
N/A
Wombats
The name of the setting or Home Based
Carer, as determined by the service
during the application for IS
funding. Is not validated, to be
used for information.
ISA Region
[Enrolment].[ListOfISCases].[ISCase].[
ISARegion]
String
50
N/A
Western Sydney
This will display the Region that
this Case belongs to
ISA Organisation Name
[Enrolment].[ListOfISCases].[ISCase].[
ISAOrgName]
String
100
N/A
Western Sydney
ISA
The Name of the organisation that has
endorsed the Case to the Approving
Organisation.
Allowed IS Non Face-to-
[Enrolment].[ListOfISCases].[ISCase].[
String
10
HHHHHHH:M
0000300:00
The total number of hours allowed for
Non Face to Face Home Based carer
Version Number: 1.50 v1.0 final
Page 100 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Face Hours
TotalISNonFaceToFaceHrsAllowed]
IS Non Face-to-Face
Hours Balance
[Enrolment].[ListOfISCases].[ISCase].[
ISNonFaceToFaceHrsBalance]
String
10
HHHHHHH:M
M
0000010:00
The total number of Non Face-to-Face
Hours remaining for this Case during
the approval period.
Primary Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].[
PrimaryCarerId]
String
30
N/A
FGER343
The ID of the Primary Home Based
Carer, as listed on the Case
submitted by the Service.
Primary Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].[
PrimaryCarerFirstName]
String
50
N/A
Angelina
The First Name of the Primary Home
Based Carer
Primary Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].[
PrimaryCarerLastName]
String
50
N/A
Acorn
The Last Name of the Primary Home
Based Carer
Primary Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].[
PrimaryCarerPostCode]
String
4
NA
2134
The Post Code for the Primary Home
Based Carer
Backup 1 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].[
Backup1CarerId]
String
30
N/A
FFWE343
The ID of Backup Home Based Carer 1,
as listed on the Case submitted by
the Service.
Backup 1 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].[
Backup1CarerFirstName]
String
50
N/A
Bronwyn
The First Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].[
Backup1CarerLastName]
String
50
N/A
Bailey
The Last Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].[
Backup1CarerPostCode]
String
4
NA
2353
The Post Code for Backup Home Based
Carer 1
Backup 2 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].[
Backup2CarerId]
String
30
N/A
FRE465
The ID of Backup Home Based Carer 2,
as listed on the Case submitted by
the Service.
Backup 2 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].[
Backup2CarerFirstName]
String
50
N/A
Callista
The First Name of Backup Home Based
Carer 2
Version Number: 1.50 v1.0 final
Data Type
Length
Format
Sample
M
Page 101 of 230
Comments
time for the period of the Case.
This can be used if children are
absent but a Home Based carer was
still paid.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Backup 2 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].[
Backup2CarerLastName]
String
50
N/A
Crown
The Last Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].[
Backup2CarerPostCode]
String
4
NA
4532
The Post Code for Backup Home Based
Carer 2
Backup 3 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].[
Backup3CarerId]
String
30
N/A
DFSE4533
The ID of Backup Home Based Carer 3,
as listed on the Case submitted by
the Service.
Backup 3 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].[
Backup3CarerFirstName]
String
50
N/A
Denise
The First Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].[
Backup3CarerLastName]
String
50
N/A
Donohue
The Last Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].[
Backup3CarerPostCode]
String
4
NA
4535
The Post Code for Backup Home Based
Carer 3
IS Case.DaysOfCare
[Listing] – Care Week
Profile
[Enrolment].[ListOfISCases].[ISCase].[
ListOfDays].[Day]
FaHCSIA Child ID
[Enrolment].[ListOfISCases].[ISCase].[
ListOfDays].[Day].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked to
this Enrolment, different to the
Service Provider ID, will be provided
for only the child attached to this
enrolment, will be the same as the
Child ID if the enrolment is formal,
will be provided if the enrolment is
not formal.
Day of Care
[Enrolment].[ListOfISCases].[ISCase].[
ListOfDays].[Day].[DayOfCare]
String
30
N/A
Monday
The Day for which the care has been
approved - from the Care Week Profile
Payment Type
[Enrolment].[ListOfISCases].[ISCase].[
ListOfDays].[Day].[PaymentType]
String
30
N/A
ISS Regular Hrs
The Type of care that has been
approved for this day of care.
Variable Week
[Enrolment].[ListOfISCases].[ISCase].[
ListOfDays].[Day].[VariableWeek]
String
30
N/A
Week on Week
off
The type of Variable Week
IS Case.CareHours
[Listing] – Profile
[Enrolment].[ListOfISCases].[ISCase].[
Version Number: 1.50 v1.0 final
Page 102 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Summary
ListOfCareHours].[CareHours]
Data Type
Length
Format
Sample
Comments
Day of Care
[Enrolment].[ListOfISCases].[ISCase].[
ListOfCareHours].[CareHours].[DayOfCar
e]
String
30
N/A
Monday
The Day for which the care has been
approved – from Care Hours
Payment Type
[Enrolment].[ListOfISCases].[ISCase].[
ListOfCareHours].[CareHours].[PaymentT
ype]
String
30
N/A
ISS Regular Hrs
The Payment Rate that has been
approved for this day of care.
Maximum Hours For
Setting
[Enrolment].[ListOfISCases].[ISCase].[
ListOfCareHours].[CareHours].[MaximumH
rsForSetting]
String
10
HHHHHHH:M
M
0000008:00
The maximum number of hours that can
be claimed for all children in the
approved care environment for this
day
IS Case.Support Hours
[Listing]
[Enrolment].[ListOfISCases].[ISCase].[
ListOfSupportHours].[SupportHours]
Payment Type
[Enrolment].[ListOfISCases].[ISCase].[
ListOfSupportHours].[SupportHours].[Pa
ymentType]
String
30
N/A
ISS Regular Hrs
This field will define what this
Payment is for.
Support Hours Period
[Enrolment].[ListOfISCases].[ISCase].[
ListOfSupportHours].[SupportHours].[Pe
riod]
String
30
N/A
Week
This field will define over what
period these hours apply, weekly or
total period
Support Hours
[Enrolment].[ListOfISCases].[ISCase].[
ListOfSupportHours].[SupportHours].[Ho
urs]
String
10
HHHHHHH:M
M
0000020:00
This will define the hours approved
for this type of Case for this period
Support Hours Tolerance
[Enrolment].[ListOfISCases].[ISCase].[
ListOfSupportHours].[SupportHours].[To
lerance]
String
10
HHHHHHH:M
M
0000010:00
This will define the amount that a
claim can vary and be automatically
approved. Claims over the hours +
tolerance will be rejected.
Support Hours Balance
[Enrolment].[ListOfISCases].[ISCase].[
ListOfSupportHours].[SupportHours].[Ba
lance]
String
10
HHHHHHH:M
M
0000400:00
This field will define the remaining
hours available for this Payment Rate
Type for the whole period. Will be
null if Support Hours Period = Week.
JFA Eligibility
[Listing]
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility]
Version Number: 1.50 v1.0 final
Page 103 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Formalise Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
JFA Eligibility ID
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility].[Id]
String
30
N/A
1-3RTD43
The unique ID of the JFA Eligibility.
If the eligibility is updated by
Centrelink, then the ID will be
reset.
JFA Eligibility Start
Date
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility].[StartDate]
ISO D
10
YYYY-MMDD
2005-05-10
Commencement date of JFA Eligibility.
If this date is prior to the
Enrolment Start Date, the Enrolment
Start Date will be defaulted here.
JFA Eligibility End
Date
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility].[EndDate]
ISO D
10
YYYY-MMDD
2005-05-10
End date of JFA Eligibility.
JFA Eligibility Days
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility].[Days]
String
3
N/A
3
Number of JFA eligible days approved
for a child care week within the JFA
approval period.
Comments
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility].[Comments]
String
100
N/A
Sight JFA
Approval from
Customer for
Details
Instructions to the Service where the
JFA eligible days cannot be
determined.
JFA Details Updated
[Enrolment].[ListOfJFAEligibility].[JF
AEligibility].[JFADetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm:
ss
2006-05-12T
12:24:05
The date Centrelink last updated the
JFA eligibility.
12.2.5 Formalise Enrolment Allowable Values – Response Message
Data Name
Values
CCB Parent Child Status
CCB Method
Status
Refer to addendum to this document for current production allowable values
Gender
CCB Type
Type
Version Number: 1.50 v1.0 final
Page 104 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Data Name
Values
Disability
Special Needs
Indigenous Status
JFA Eligibility Details Request
CCR Method
IS Case.IS Case Type
IS Case.Day.Payment Type
IS Case.Day.Variable Week
IS Case.Care Hours.Payment Type
IS Case.Support Hours.Payment Type
IS Case.Support Hours.Period
Version Number: 1.50 v1.0 final
Page 105 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.3 Update Enrolment
The Update Enrolment Interface is to be used when a Service Provider wishes to update data relating to an existing enrolment record on the
FaHCSIA system. The data submitted through the Service Provider Interface will attempt to match with an existing record. Where a successful
match is found, the attributes of the accompanying data will be updated accordingly. Where the matching process is unsuccessful or fails to meet
certain rules, an error message will be generated and the enrolment will not be updated.
12.3.1 Update Enrolment Request Message Data Definition
Enrolment Interface - Update Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
Authorised Person First
Name
[EnrolmentUpdate].[AuthorisedP
ersonFirstName]
N
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[EnrolmentUpdate].[AuthorisedP
ersonLastName]
N
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised this transaction
Authorised Person Id
[EnrolmentUpdate].[AuthorisedP
ersonId]
N
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
CCB Approval ID
[EnrolmentUpdate].[CCBApproval
Id]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[EnrolmentUpdate].[FaCSIAEnrol
mentId]
Y
String
15
N/A
1-2H0XF
Unique identifier of enrolment
record on the FaHCSIA System.
Start Date
[EnrolmentUpdate].[StartDate]
N
Date
10
YYYY-MM-DD
1998-03-12
The Start Date of the Enrolment
End Date
[EnrolmentUpdate].[EndDate]
N
Date
10
YYYY-MM-DD
2007-08-12
The End Date of the Enrolment
Version Number: 1.50 v1.0 final
Page 106 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Clear End Date
[EnrolmentUpdate].[ClearEndDat
e]
N
String
1
N/A
N
Flag to indicate that the End
Date should be cleared.
Child Date of Birth
[EnrolmentUpdate].[ChildDateOf
Birth]
N
Date
10
YYYY-MM-DD
-
The updated child date of
birth.If the Enrolment is
Formal, will require to be
linked with Update CRN Flag
below.
Child Service Client Id
[EnrolmentUpdate].[ChildServic
eClientId]
N
String
20
N/A
KRMX0001
The unique identifier of the
child issued by the Service
Provider.
Parent Guardian Date of
Birth
[EnrolmentUpdate].[ParentGuard
ianDateOfBirth]
N
Date
10
YYYY-MM-DD
-
The updated parent/guardian
date of birth. If the Enrolment
is Formal, will require to be
linked with Update CRN Flag
below.
Parent Guardian Service
Client Id
[EnrolmentUpdate].[ParentGuard
ianServiceClientId]
N
String
20
N/A
KRMX0001
The unique identifier of the
parent/guardian issued by the
Service Provider.
Update CRN
[EnrolmentUpdate].[UpdateCRN]
N
String
1
Y/N
Y
Will flag if the CRN needs to
be updated for the child or
parent. If this flag is N, and
CRNs are provided below, they
will be ignored. Also note that
DEEWR will need to flag the
enrolment within CCMS to allow
an update, this will be a
manual process.
Child CRN
[EnrolmentUpdate].[ChildCRN]
N
String
10
NNNNNNNNNT
943584734X
Issued by Centrelink for the
child.
Parent Guardian CRN
[EnrolmentUpdate].[ParentGuard
ianCRN]
N
String
10
NNNNNNNNNT
584943321X
Issued by Centrelink for the
parent/guardian.
Service Provider
Enrolment Reference
[EnrolmentUpdate].[ServiceProv
iderEnrolmentReference]
N
String
50
N/A
REF000001
Unique identifier of the
enrolment record on the Service
Provider Software.
Version Number: 1.50 v1.0 final
Page 107 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Indigenous Status
[EnrolmentUpdate].[ChildIndige
nousStatus]
N
String
30
N/A
Torres Strait
Islander
Indigenous Origin of child if
applicable
Clear Indigenous Status
[EnrolmentUpdate].[ClearIndige
nousStatus]
N
String
1
N/A
N
Flag to indicate that the
Indigenous Status should be
cleared.
Disability
[EnrolmentUpdate].[ChildDisabi
lity]
N
String
1
N/A
Y
Indicates if the child has a
disability
Clear Disability
[EnrolmentUpdate].[ClearDisabi
lity]
N
String
1
N/A
N
Flag to indicate that the
Disability and Disability
Effective Date should be
cleared.
Disability Effective
Date
[EnrolmentUpdate].[ChildDisabi
lityEffectiveDate]
N
ISO D
10
YYYY-MM-DD
2005-05-10
The date the Service became
aware of the disability.
Special Needs
[EnrolmentUpdate].[ChildSpecia
lNeeds]
N
String
1
N/A
Y
Indicates if the child has a
special need.
Clear Special Needs
[EnrolmentUpdate].[ClearSpecia
lNeeds]
N
String
1
N/A
N
Flag to indicate that the
Special Needs and Special Needs
Effective Date should be
cleared.
Special Needs Effective
Date
[EnrolmentUpdate].[ChildSpecia
lNeedsEffectiveDate]
N
ISO D
10
YYYY-MM-DD
2005-05-10
The date the Service became
aware of the special need
JFA Eligibility Details
Request
[EnrolmentUpdate].[JFAEligibli
tyDetailsRequest]
N
String
1
N/A
Y
Indicates if there is an
intention by the family to
claim JFA sessions under this
enrolment and the Service has
seen the approval letter from
CLK.
Version Number: 1.50 v1.0 final
Page 108 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.3.2 Update Enrolment Request Data Rules
Update Enrolment Request Data Rules
Comments
Source System must be valid system.
[FaCSIA Enrolment Id] must match an existing record on the FaHCSIA system.
Authorised Person First Name, Authorised Person Last Name and Authorised Person Id are mandatory if the
registered version of software is greater than or equal to 1.30.
The Child and Parent/Guardian Service Client Ids are mandatory if the registered version of software is greater
than or equal to 1.30. At the point these Id’s become mandatory, if the record being updated does not already
contain a Child and Parent/Guardian Service Client Id, and the update message does not contain Child and
Parent/Guardian Id’s, the update will be rejected
If the Parent/Guardian Service Client Id is not null AND the Child Service Client Id is not null:
There must be no overlapping enrolmentsof any type (excluding AMEP/Other) for the same Parent/Guardian
Service Client Id/Child Service Client Id and CCB Approval Id combination with a status of ‘New’, ‘Submitted’,
‘Active’, ‘Suspended’ or ‘Exited’.
There must be no overlapping Formal enrolments for the same Parent/Guardian CRN/Child CRN and CCB
Approval Id combination with a status of ‘New’, Submitted’, ‘Active’ or ‘Suspended’.
Service Provider Enrolment Reference can be updated regardless of the Status of the Enrolment.
If Service Provider Enrolment Reference is populated, update the Enrolment with the new value.
The Service Provider Enrolment Reference number must be unique for a given Agreement Schedule/CCB
Approval Id
[Start Date] can be updated if the Enrolment is in a [Status] of ‘Submitted’
[Start Date] can be updated when the Enrolment is in the [Status] of ‘Active’ or ‘Suspended’ as long as [Start Date]
it is less than the current [Start Date] on the Enrolment record.
The Start Date can be set to some date in the past as long as it is less than the
current start date.
Enrolment [Start Date] must be equal to or greater than [CCB Approval Start Date] and less than or equal to [CCB
Approval End Date].
[Start Date] must be before or equal to [End Date], if [End Date] is provided.
The Enrolment [Start Date] must not be greater than X days time or less than Y days time.
Refer to addendum to this document for current production values for X and Y
[End Date] cannot be updated or cleared unless the Enrolment is in a [Status] of ‘Submitted’, ‘Active’ or
‘Suspended’
[End Date]must be greater than or equal to the latest week ending date on any active attendance for that
enrolment
The Enrolment [End Date] field in the request message cannot be populated if the [Clear End Date] field is set to
‘Y’.
If the [Clear End Date] field is set to ‘Y’ then the Enrolment End Date will be cleared.
Version Number: 1.50 v1.0 final
Assuming other rules permit update.
Page 109 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Enrolment Request Data Rules
Comments
[Parent/Guardian Date of Birth] and [Child Date of Birth] can be updated as long as the Enrolment Type is
‘Informal’.
Date Of Birth can now be updated for all Enrolment types.
If the following fields are not populated (ie Blank) then no update of the field will be performed.
A blank field means do nothing, rather than clear the field. It is not valid to
clear Start Date, Child DOB, Child Service Client Id, Parent Guardian
DOB,Parent Guardian Service Client Id,Child CRN, Parent Guardian CRN, or
Service Provider Reference Number. To clear the End Date use the Clear End
Date Field.

Start Date

End Date

Child Date of Birth

Child Service Client Id

Parent Date of Birth

Parent Guardian Service Client Id

Child CRN

Parent Guardian CRN

Service Provider Reference Number

Indigenous Status

Clear Indigenous Status

Disability

Disability Effective Date

Clear Disability

Special Needs

Special Needs Effective Date

Clear Special Needs

JFA Eligibility Details Request
Version Number: 1.50 v1.0 final
Page 110 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Enrolment Request Data Rules
Comments
At least one of the following fields must be populated or in the case of [Clear End Date], [Clear Indigenous Status],
[Clear Disability] or [Clear Special Needs] be set ‘Y’.
Something needs to be updated for the update to be valid.

Start Date

End Date

Child Date of Birth

Child Service Client Id

Parent Date of Birth

Parent Guardian Service Client Id

Child CRN

Parent Guardian CRN

Clear End Date – Set to ‘Y’

Service Provider Reference Number

Indigenous Status

Clear Indigenous Status

Disability

Disability Effective Date

Clear Disability

Special Needs

Special Needs Effective Date

Clear Special Needs

JFA Eligibility Details Request
Disability Effective Date must be less than or equal to system date.
Disability Effective Date must be greater than the child’s date of birth.
Disability Effective Date is mandatory if Disability = Y.
Disability Effective Date must be blank on the inbound message if:
Disability = N on the CCMS database AND Disability is not equal to Y on the inbound message
If Disability Effective Date is provided in the inbound message and Disability is not provided in the message, but
Disability = Y on the CCMS database
Disability Effective Date should be updated with the new value on the inbound.
Special Needs Effective Date must be less than or equal to system date.
Special Needs Effective Date must be greater than the child’s date of birth.
Special Needs Effective Date is mandatory if Special Needs = Y.
Version Number: 1.50 v1.0 final
Page 111 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Enrolment Request Data Rules
Comments
If [Clear Indigenous Status] is set ‘Y’, Indigenous Status will be cleared.
If [Clear Disability] is set ‘Y’, Disability and Disability Effective Date will be cleared.
Special Needs Effective Date must be blank on the inbound message if:
Special Needs = N on the CCMS database AND Special Needs is not equal to Y on the inbound
message
If Special Needs Effective Date is provided in the inbound message and Special Needs is not provided in the
message, but Special Needs = Y on the CCMS database
Special Needs Effective Date should be updated with the new value on the inbound.
If [Clear Special Needs] is set ‘Y’, Special Needs and Special Needs Effective Date will be cleared.
JFA Eligibility Details Request must exist in the valid list.
If [Update CRN] is set to ‘Y’, then either [Child CRN] or [Parent Guardian CRN] must be supplied
Please note that the enrolment record must also be marked to allow an update
by the CCMS Support team. Updating CRNs will be done sparingly.
If [Update CRN] is set to ‘N’ then any values supplied in [Child CRN] or [Parent Guardian CRN] is ignored
If [Child CRN] is not null, [Child Date Of Birth] must also be not null
If [Parent Guardian CRN] is not null, [Parent Guardian Date Of Birth] must also be not null
Combination of [Child CRN] and [Child Date Of Birth] must match an existing client record on the FaCSIA system.
Combination of [Parent Guardian CRN] and [Parent Guardian Date Of Birth] must match an existing client record
on the FaCSIA system.
12.3.3 Update Enrolment Allowable Values - Request Message
Refer to addendum to this document for current production allowable values.
Version Number: 1.50 v1.0 final
Page 112 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.3.4 Update Enrolment Response Message Data Definition
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the
transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval ID
[Enrolment].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[Enrolment].[FaCSIAEnrolmentId]
String
15
N/A
1-2H0XF
Unique identifier of the enrolment
record on the FaHCSIA System.
Service Provider
Enrolment Reference
[Enrolment].[ServiceProviderEnrolment
Reference]
String
50
N/A
REF000001
Unique identifier of the enrolment
record on the Service Provider
Software.
Type
[Enrolment].[Type]
String
30
N/A
Formal
The Enrolment Type.
Start Date
[Enrolment].[StartDate]
Date
10
YYYY-MMDD
2006-05-01
The start date of the enrolment
End Date
[Enrolment].[EndDate]
Date
10
YYYY-MMDD
2007-08-08
The end date of the enrolment
Deemed Exit Date
[Enrolment].[DeemedExitDate]
Date
10
YYYY-MMDD
Status
[Enrolment].[Status]
String
30
N/A
Submitted
The status of the Enrolment.
Child CRN
[Enrolment].[ChildCRN]
String
10
NNNNNNNN
NT
123456789T
Issued by Centrelink for the child
Version Number: 1.50 v1.0 final
Page 113 of 230
The Return Error for the Request
Message.
The end date of the enrolment deemed
by FaHCSIA.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Child First Name
[Enrolment].[ChildFirstName]
String
50
N/A
John
The first name of the child
Child Middle Name
[Enrolment].[ChildMiddleName]
String
50
N/A
James
The middle name of the child
Child Last Name
[Enrolment].[ChildLastName]
String
50
N/A
Smith
The last name of the child
Child Date of Birth
[Enrolment].[ChildDateOfBirth]
Date
10
YYYY-MMDD
1998-05-31
The date of birth of the child
Child Service Client Id
[Enrolment].[ChildServiceClientId]
String
20
N/A
KRMX0001
The unique identifier of the child
issued by the Service Provider.
Child Gender
[Enrolment].[ChildGender]
String
1
N/A
M
The gender of the child
Parent Guardian CRN
[Enrolment].[ParentGuardianCRN]
String
10
NNNNNNNN
NT
987654321A
Issued by Centrelink for the
parent/guardian
Parent Guardian First
Name
[Enrolment].[ParentGuardianFirstName]
String
50
N/A
Mary
The first name of the
parent/guardian
Parent Guardian Middle
Name
[Enrolment].[ParentGuardianMiddleName
]
String
50
N/A
Lisa
The middle name of the
parent/guardian
Parent Guardian Last
Name
[Enrolment].[ParentGuaridanLastName]
String
50
N/A
Smith
The last name of the parent/guardian
Parent Guardian Date of
Birth
[Enrolment].[ParentGuardianDateOfBirt
h]
Date
10
YYYY-MMDD
1978-05-31
The date of birth of the
parent/guardian
Parent Guardian Service
Client Id
[Enrolment].[ParentGuardianServiceCli
entId]
String
20
N/A
KRMX0001
The unique identifier of the
parent/guardian issued by the
Service Provider.
Parent Guardian Gender
[Enrolment].[ParentGuardianGender]
String
1
N/A
F
The gender of the parent/guardian
CCB Eligible Hours
[Enrolment].[CCBEligibleHours]
Integer
String
6
HHH:MM
The eligible CCB hours for the
parent/guardian.
Version Number: 1.50 v1.0 final
Page 114 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
CCB Method
[Enrolment].[CCBMethod]
String
30
N/A
Fee Reduction
The CCB method for the
parent/guardian.
CCB Type
[Enrolment].[CCBType]
String
30
N/A
CCB
The type of CCB the parent/guardian
is receiving.
CCB Percentage
[Enrolment].[CCBPercentage]
Decimal
-
N/A
38
The calculated one child rate of CCB
the parent is entitled to receive
expressed as % (only for Fee
Reduction).
CCB Parent Child Status
[Enrolment].[CCBParentChildStatus]
String
30
N/A
Current
The CCB Status for the
parent/guardian and child
combination
CCB Parent Child Start
Date
[Enrolment].[CCBParentChildStartDate]
Date
10
YYYY-MMDDT
1998-05-12
The date when the parent guardian/
child eligibility started.
CCB Details Updated
[Enrolment].[CCBDetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-05-12T
12:24:05
The date when the eligibility
details for the parent guardian
/child were updated.
YTD Absences
[Enrolment].[YTDAbsences]
Integer
-
N/A
5
The number of absences used year to
date, across all services that the
child attends.
Request Enrolment
Advance
[Enrolment].[RequestEnrolmentAdvance]
String
1
N/A
Y
Indicates if the Service wishes to
request an enrolment advance for
this enrolment.
Service Type
[Enrolment].[ServiceType]
String
30
N/A
FDC
The Service Type for the enrolment.
Enrolment Advance
Amount
[Enrolment].[EnrolmentAdvanceAmount]
Decimal
-
N/A
50.32
The Enrolment Advance Amount
Calculated for the enrolment
Enrolment Advance
Status
[Enrolment].[EnrolmentAdvanceStatus]
String
30
N/A
Payment Created
The Enrolment Advance Payment Status
for the Enrolment.
Indigenous Status
[Enrolment].[ChildIndigenousStatus]
String
30
N/A
Torres Strait
Islander
Indigenous Origin of child if
applicable
Version Number: 1.50 v1.0 final
Page 115 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Disability
[Enrolment].[ChildDisability]
String
1
N/A
Y
Indicates if the child has a
disability
Disability Effective
Date
[Enrolment].[ChildDisabilityEffective
Date]
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware of
the disability.
Special Needs
[Enrolment].[ChildSpecialNeeds]
String
1
N/A
Y
Indicates if the child has a special
need.
Special Needs Effective
Date
[Enrolment].[ChildSpecialNeedsEffecti
veDate]
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware of
the special need
[Enrolment].[FormalisedDate]
ISO D
10
N/A
2005-05-10
JFA Eligibility Details
Request
[Enrolment].[JFAEligibilityDetailsReq
uest]
String
1
N/A
Y
Indicates if there is an intention
by the family to claim JFA sessions
under this enrolment and the Service
has seen the approval letter from
CLK.
CCR Method
[Enrolment].[CCRMethod]
String
30
N/A
Pay to Family
The CCR method for the
parent/guardian.
FaHCSIA Child ID
[Enrolment].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
FaHCSIA Parent ID
[Enrolment].[FaHCSIAParentId]
String
15
N/A
1-PYT465
The FaHCSIA ID of the parent linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
IS Case [Listing]
[Enrolment].[ListOfISCases].[ISCase]
IS Case ID
[Enrolment].[ListOfISCases].[ISCase].
[ISCaseId]
String
15
N/A
1-XDRE243
The ID of a Case linked to this
Enrolment via the Child
Formalised Date
Version Number: 1.50 v1.0 final
Page 116 of 230
The date the Enrolment was
formalised.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
IS Case Start Date
[Enrolment].[ListOfISCases].[ISCase].
[StartDate]
ISO D
10
YYYY-MMDD
2009-07-01
The Date that this Case commences
IS Case End Date
[Enrolment].[ListOfISCases].[ISCase].
[EndDate]
ISO D
10
YYYY-MMDD
2010-06-30
The Date that this Case ends.
IS Case Type
[Enrolment].[ListOfISCases].[ISCase].
[Type]
String
30
N/A
ISS
Will return the type of Case.
IS Review Date
[Enrolment].[ListOfISCases].[ISCase].
[ReviewDate]
ISO D
10
YYYY-MMDD
2010-05-30
The Date that this Case will next
receive a review
IS Case Status
[Enrolment].[ListOfISCases].[ISCase].
[Status]
String
30
N/A
Submitted
The status of the IS Case.
ISF First Name
[Enrolment].[ListOfISCases].[ISCase].
[ISFFirstName]
String
50
N/A
Pauline
The first name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
ISF Last Name
[Enrolment].[ListOfISCases].[ISCase].
[ISFLastName]
String
50
N/A
Smith
The last name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
IS Case Setting
[Enrolment].[ListOfISCases].[ISCase].
[Setting]
String
100
N/A
Wombats
The name of the setting or Home
Based Carer, as determined by the
service during the application for
IS funding. Is not validated, to be
used for information.
ISA Region
[Enrolment].[ListOfISCases].[ISCase].
[ISARegion]
String
50
N/A
Western Sydney
This will display the Region that
this Case belongs to
ISA Organisation Name
[Enrolment].[ListOfISCases].[ISCase].
[ISAOrgName]
String
100
N/A
Western Sydney
ISA
The Name of the organisation that
has endorsed the Case to the
Approving Organisation.
Version Number: 1.50 v1.0 final
Page 117 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Allowed IS Non Face-toFace Hours
[Enrolment].[ListOfISCases].[ISCase].
[TotalISNonFaceToFaceHrsAllowed]
String
10
HHHHHHH:
MM
0000300:00
The total number of hours allowed
for Non Face to Face Home Based
carer time for the period of the
Case. This can be used if children
are absent but a Home Based carer
was still paid.
IS Non Face-to-Face
Hours Balance
[Enrolment].[ListOfISCases].[ISCase].
[ISNonFaceToFaceHrsBalance]
String
10
HHHHHHH:
MM
0000010:00
The total number of Non Face-to-Face
Hours remaining for this Case during
the approval period.
Primary Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerId]
String
30
N/A
FGER343
The ID of the Primary Home Based
Carer, as listed on the Case
submitted by the Service.
Primary Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerFirstName]
String
50
N/A
Angelina
The First Name of the Primary Home
Based Carer
Primary Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerLastName]
String
50
N/A
Acorn
The Last Name of the Primary Home
Based Carer
Primary Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerPostCode]
String
4
NA
2134
The Post Code for the Primary Home
Based Carer
Backup 1 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerId]
String
30
N/A
FFWE343
The ID of Backup Home Based Carer 1,
as listed on the Case submitted by
the Service.
Backup 1 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerFirstName]
String
50
N/A
Bronwyn
The First Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerLastName]
String
50
N/A
Bailey
The Last Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerPostCode]
String
4
NA
2353
The Post Code for Backup Home Based
Carer 1
Backup 2 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerId]
String
30
N/A
FRE465
The ID of Backup Home Based Carer 2,
as listed on the Case submitted by
the Service.
Version Number: 1.50 v1.0 final
Page 118 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Backup 2 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerFirstName]
String
50
N/A
Callista
The First Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerLastName]
String
50
N/A
Crown
The Last Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerPostCode]
String
4
NA
4532
The Post Code for Backup Home Based
Carer 2
Backup 3 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerId]
String
30
N/A
DFSE4533
The ID of Backup Home Based Carer 3,
as listed on the Case submitted by
the Service.
Backup 3 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerFirstName]
String
50
N/A
Denise
The First Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerLastName]
String
50
N/A
Donohue
The Last Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerPostCode]
String
4
NA
4535
The Post Code for Backup Home Based
Carer 3
IS Case.DaysOfCare
[Listing] – Care Week
Profile
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day]
FaHCSIA Child ID
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked
to this Enrolment, different to the
Service Provider ID, will be
provided for only the child attached
to this enrolment, will be the same
as the Child ID if the enrolment is
formal, will be provided if the
enrolment is not formal.
Day of Care
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[DayOfCare]
String
30
N/A
Monday
The Day for which the care has been
approved - from the Care Week
Profile
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[PaymentType]
String
30
N/A
ISS Regular Hrs
The Type of care that has been
approved for this day of care.
Version Number: 1.50 v1.0 final
Page 119 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Variable Week
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[VariableWeek]
String
30
N/A
Week on Week off
The type of Variable Week
IS Case.CareHours
[Listing] – Profile
Summary
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours]
Day of Care
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[DayOfC
are]
String
30
N/A
Monday
The Day for which the care has been
approved – from Care Hours
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[Paymen
tType]
String
30
N/A
ISS Regular Hrs
The Payment Rate that has been
approved for this day of care.
Maximum Hours For
Setting
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[Maximu
mHrsForSetting]
String
10
HHHHHHH:
MM
0000008:00
The maximum number of hours that can
be claimed for all children in the
approved care environment for this
day
IS Case.Support Hours
[Listing]
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours]
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
PaymentType]
String
30
N/A
ISS Regular Hrs
This field will define the what this
Payment is for, ie Extra Home Based
Carer or Out Of Home
Support Hours Period
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Period]
String
30
N/A
Week
This field will define over what
period these hours apply, weekly or
total period
Support Hours
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Hours]
String
10
HHHHHHH:
MM
0000020:00
This will define the hours approved
for this type of Case for this
period
Support Hours Tolerance
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Tolerance]
String
10
HHHHHHH:
MM
0000010:00
This will define the amount that a
claim can vary and be automatically
approved. Claims over the hours +
tolerance will be rejected.
Version Number: 1.50 v1.0 final
Page 120 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Update Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Support Hours Balance
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Balance]
String
10
HHHHHHH:
MM
0000400:00
This field will define the remaining
hours available for this Payment
Rate Type for the whole period.
Will be null if Support Hours Period
= Week.
JFA Eligibility
[Listing]
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility]
JFA Eligibility ID
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Id]
String
30
N/A
1-3RTD43
The unique ID of the JFA
Eligibility. If the eligibility is
updated by Centrelink, then the ID
will be reset.
JFA Eligibility Start
Date
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[StartDate]
ISO D
10
YYYY-MMDD
2005-05-10
Commencement date of JFA
Eligibility. If this date is prior
to the Enrolment Start Date, the
Enrolment Start Date will be
defaulted here.
JFA Eligibility End
Date
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[EndDate]
ISO D
10
YYYY-MMDD
2005-05-10
End date of JFA Eligibility.
JFA Eligibility Days
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Days]
String
3
N/A
3
Number of JFA eligible days approved
for a child care week within the JFA
approval period.
Comments
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Comments]
String
100
N/A
Sight JFA
Approval from
Customer for
Details
Instructions to the Service where
the JFA eligible days cannot be
determined.
JFA Details Updated
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[JFADetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-05-12T
12:24:05
The date Centrelink last updated the
JFA eligibility.
Version Number: 1.50 v1.0 final
Page 121 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.3.5 Update Enrolment Allowable Values – Response Message
Data Name
Values
CCB Parent Child Status
CCB Method
Status
Gender
CCB Type
Type
Disability
Special Needs
Indigenous Status
Refer to addendum to this document for current production allowable values
JFA Eligibility Details Request
CCR Method
IS Case.IS Case Type
IS Case.Day.Payment Type
IS Case.Day.Variable Week
IS Case.Care Hours.Payment Type
IS Case.Support Hours.Payment Type
IS Case.Support Hours.Period
Version Number: 1.50 v1.0 final
Page 122 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.4 Cancel Enrolment
The Cancel Enrolment Interface is to be used when a Service Provider wishes to cancel an existing enrolment record on the FaHCSIA system.
The data submitted through the Service Provider Interface will attempt to be matched with an existing record. Where a successful match is found
and the record meets certain business requirements, the enrolment will be cancelled accordingly. Where the matching process is unsuccessful or
fails to meet certain specifications, an error message will be generated and the enrolment will not be cancelled.
12.4.1 Cancel Enrolment Request Message Data Definition
Enrolment Interface - Cancel Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
2006103018331
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
Authorised Person First
Name
[EnrolmentCancellation].[Autho
risedPersonFirstName]
N
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[EnrolmentCancellation].[Autho
risedPersonLastName]
N
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised this transaction
Authorised Person Id
[EnrolmentCancellation].[Autho
risedPersonId]
N
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
CCB Approval ID
[EnrolmentCancellation].[CCBAp
provalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[EnrolmentCancellation].[FaCSI
AEnrolmentId]
Y
String
15
N/A
REF000001
The unique identifier of the
Enrolment on the FaHCSIA
system.
Version Number: 1.50 v1.0 final
Page 123 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.4.2 Cancel Enrolment Request Data Rules
Cancel Enrolment Request Data Rules
Comments
Source System must be valid system.
[FaCSIA Enrolment Id] must match an existing record on the FaHCSIA system.
Enrolments can be cancelled if:

Enrolment Status = Submitted OR

Enrolment Status = Active AND there are no Attendances linked to the Enrolment with Attendance Status <>Cancelled.
Authorised Person First Name, Authorised Person Last Name and Authorised Person Id are mandatory if the registered version of software is
greater than or equal to 1.30.
12.4.3 Cancel Enrolment Allowable Values - Request Message
Refer to addendum to this document for current production allowable values.
12.4.4 Cancel Enrolment Response Message Data Definition
Enrolment Interface - Cancel Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the
transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval ID
[CancelledEnrolment].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
Version Number: 1.50 v1.0 final
Page 124 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Cancel Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
FaCSIA Enrolment Id
[CancelledEnrolment].[FaCSIAEnrolmentI
d]
String
15
N/A
1-2H0XF
Unique identifier of the enrolment
record on the FaHCSIA System.
Status
[CancelledEnrolment].[Status]
String
30
N/A
Cancelled
The status of the Enrolment.
12.4.5 Cancel Enrolment Allowable Values – Response Message
Refer to addendum to this document for current production allowable values.
Version Number: 1.50 v1.0 final
Page 125 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.5 Query Enrolments
The Query Enrolments Interface is used when a Service Provider wishes to query FaHCSIA for information on their enrolments. The query will
be limited to a pre-defined list of arguments, with the combination of fields being used to construct a query. The query will be constructed using
the ‘AND’ operator to combine the query fields.
The CCMS Help Desk can make manual changes to Enrolments. These can include:
 changes to any field on an Enrolment to ensure families receive CCB and/or CCR entitlement. Reasons may include but are not limited
to, software failure, data entry errors, or a service failing to Formalise an Informal Enrolment
 manual transition ofEnrolment Types from one to another, for example from AMEP/Other to Service SCCB
 reactivating Exited Enrolments ie move the Enrolment Status from Exited to Active and clear the Enrolment End Date.
Software must be able to support this changed data in the return interfaces.
12.5.1 Query Enrolment Request Message Data Definition
Enrolment Interface - Query Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FACSIA Enrolment Id
[FACSIAEnrolmentId]
N
String
15
N/A
1-89YG
Unique identifier of enrolment
record on the FAHCSIA system.
Type
[Type]
N
String
30
N/A
Formal
The Enrolment Type.
Service Provider
Enrolment Reference
[ServiceProviderEnrolmentRefer
ence]
N
String
50
N/A
REF000001
Unique identifier of the
enrolment record on the Service
Provider Software System
Version Number: 1.50 v1.0 final
Page 126 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Start Date From
[StartDateFrom]
N
Date
10
YYYY-MM-DD
2006-03-12
The from Start Date of the
Enrolment
Start Date To
[StartDateTo]
N
Date
10
YYYY-MM-DD
2006-05-12
The to Start Date of the
Enrolment
End Date From
[EndDateFrom]
N
Date
10
YYYY-MM-DD
2006-04-12
The from End Date of the
Enrolment
End Date To
[EndDateTo]
N
Date
10
YYYY-MM-DD
2006-06-12
The to End Date of the
Enrolment
End Date Empty
[EndDateEmpty]
N
String
1
N/A
N
If Yes, equivalent to querying
for End Date = NULL.
Status
[Status]
N
String
30
N/A
Submitted
The status of the Enrolment.
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:SS
2006-0612T15:12:34
Indicates that any records,
either enrolment details or
eligibility details, updated
since this date/time stamp are
required.
Eligibility Updated
Since
[EligibilityUpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:SS
2006-0612T15:12:34
Indicates that any records
where the eligibility has been
updated since this date/time
stamp are required.
Return Payments
[ReturnPayments]
N
String
1
N/A
N
If N, payment details will not
be returned in the response
query if they exist.
Otherwise, payment details will
be returned.
Page Size
[PageSize]
N
Integer
-
NNN
10
Maximum number of records
returned.
Page Number
[PageNumber]
N
Integer
-
NNN
2
The page number of records to
return.
Version Number: 1.50 v1.0 final
Page 127 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.5.2 Query Enrolment Request Data Rules
Query Enrolment Request Data Rules
Comments
Source System must be valid system.
Page Size, Page Number > 0
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size <= Maximum Page Size.
Each field will only accept 1 value in the correct format.
Eg. The [Start Date From] field will only accept 1 date in the format YYYY-MM-DD
[Start Date From] must be less than or equal to [Start Date To].
[End Date From] must be less than or equal to [End Date To].
If [Updated Since] is provided in the request, the Last Updated Dates on both the Enrolment and the Eligibility
records are considered if the Enrolment is not Exited.
If [Updated Since] is provided in the request, the Last Updated Dates on the Eligibility records are ignored if the
Enrolment is Exited.
If [Eligibility Updated Since] is provided in the request, only the Eligibility Last Updated Date will be considered in
the query. The Enrolment Last Updated Date will be ignored.
The [Eligibility Updated Since] query will not return Exited Enrolments.
If [Updated Since] and [Eligibility Updated Since] are both provided in the request, the [Eligibility Updated Since]
will be ignored and the [Updated Since] query will be performed against both the Enrolment Last Updated Date
and the Eligibility Last Updated Date.
Note that the enrolment and family eligibility are two separate records in
CCMS. Prior to v1.30 all enrolment queries combined the enrolment touch
date and eligibility touch date as a single query. After v1.30 providers are now
able to distinguish in the query whether they are requesting records based on
a change to an enrolment or a change to the family eligibility.
12.5.3 Query Enrolment Allowable Values – Request Message
Data Name
Values
Maximum Page Size
Default Page Size
Refer to addendum to this document for current production allowable values
Status
Type
Version Number: 1.50 v1.0 final
Page 128 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.5.4 Query Enrolment Response Message Data Definitions
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the
transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if it is the last page
returned
Enrolment [Listing]
[ListOfEnrolments].[Enrolment]
CCB Approval ID
[ListOfEnrolments].[Enrolment].[CCBAp
provalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[ListOfEnrolments].[Enrolment].[FaCSI
AEnrolmentId]
String
15
N/A
1-2H0XF
Unique identifier of the enrolment
record on the FaHCSIA System.
Service Provider
Enrolment Reference
[ListOfEnrolments].[Enrolment].[Servi
ceProviderEnrolmentReference]
String
50
N/A
REF000001
Unique identifier of the enrolment
record on the Service Provider
Software.
Update Authorised
Person First Name
[ListOfEnrolments].[Enrolment].[Updat
eAuthorisedPersonFirstName]
String
50
N/A
John
The first name of the person at the
Service Provider who authorised the
creation and/or update of this
enrolment
Update Authorised
Person Last Name
[ListOfEnrolments].[Enrolment].[Updat
eAuthorisedPersonLastName]
String
50
N/A
Smythe
The last name of the person at the
Service Provider who authorised the
creation and/or update of this
enrolment
Version Number: 1.50 v1.0 final
Page 129 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Update Authorised
Person Id
[ListOfEnrolments].[Enrolment].[Updat
eAuthorisedPersonId]
String
20
N/A
APIDA001
The unique identifier of the person
at the Service Provider who
authorised the creation and/or
update of this enrolment
Formalise Authorised
Person First Name
[ListOfEnrolments].[Enrolment].[Forma
liseAuthorisedPersonFirstName]
String
50
N/A
Terry
The first name of the person at the
Service Provider who authorised
formalising of this enrolment
Formalise Authorised
Person Last Name
[ListOfEnrolments].[Enrolment].[Forma
liseAuthorisedPersonLastName]
String
50
N/A
Towel
The last name of the person at the
Service Provider who authorised the
formalising of this enrolment
Formalise Authorised
Person Id
[ListOfEnrolments].[Enrolment].[Forma
liseAuthorisedPersonId]
String
20
N/A
APIDA002
The unique identifier of the person
at the Service Provider who
authorised the formalising of this
enrolment
Type
[ListOfEnrolments].[Enrolment].[Type]
String
30
N/A
Formal
The Enrolment Type.
Start Date
[ListOfEnrolments].[Enrolment].[Start
Date]
Date
10
YYYY-MMDD
2006-05-01
The start date of the enrolment
End Date
[ListOfEnrolments].[Enrolment].[EndDa
te]
Date
10
YYYY-MMDD
2007-08-08
The end date of the enrolment
Deemed Exit Date
[ListOfEnrolments].[Enrolment].[Deeme
dExitDate]
Date
10
YYYY-MMDD
Status
[ListOfEnrolments].[Enrolment].[Statu
s]
String
30
N/A
Active
The status of the Enrolment.
Child CRN
[ListOfEnrolments].[Enrolment].[Child
CRN]
String
10
NNNNNNNN
NT
123456789T
Issued by Centrelink for the child
Child First Name
[ListOfEnrolments].[Enrolment].[Child
FirstName]
String
50
N/A
John
The first name of the child. May
be included on an informal
enrolment if linked to an IS Case.
Child Middle Name
[ListOfEnrolments].[Enrolment].[Child
MiddleName]
String
50
N/A
James
The middle name of the child
Version Number: 1.50 v1.0 final
Page 130 of 230
The end date of the enrolment
deemed by FaHCSIA.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Child Last Name
[ListOfEnrolments].[Enrolment].[Child
LastName]
String
50
N/A
Smith
The last name of the child. May be
included on an informal enrolment
if linked to an IS Case.
Child Date of Birth
[ListOfEnrolments].[Enrolment].[Child
DateOfBirth]
Date
10
YYYY-MMDD
1998-05-31
The date of birth of the child
Child Service Client Id
[ListOfEnrolments].[ChildServiceClien
tId]
String
20
N/A
KRMX0001
The unique identifier of the child
issued by the Service Provider.
Child Gender
[ListOfEnrolments].[Enrolment].[Child
Gender]
String
1
N/A
M
The gender of the child
Parent Guardian CRN
[ListOfEnrolments].[Enrolment].[Paren
tGuardianCRN]
String
10
NNNNNNNN
NT
987654321A
Issued by Centrelink for the
parent/guardian
Parent Guardian First
Name
[ListOfEnrolments].[Enrolment].[Paren
tGuardianFirstName]
String
50
N/A
Mary
The first name of the
parent/guardian
Parent Guardian Middle
Name
[ListOfEnrolments].[Enrolment].[Paren
tGuardianMiddleName]
String
50
N/A
Lisa
The middle name of the
parent/guardian
Parent Guardian Last
Name
[ListOfEnrolments].[Enrolment].[Paren
tGuaridanLastName]
String
50
N/A
Smith
The last name of the
parent/guardian
Parent Guardian Date of
Birth
[ListOfEnrolments].[Enrolment].[Paren
tGuardianDateOfBirth]
Date
10
YYYY-MMDD
1978-05-31
The date of birth of the
parent/guardian
Parent Guardian Service
Client Id
[ListOfEnrolments].[ParentGuardianSer
viceClientId]
String
20
N/A
KRMX0001
The unique identifier of the
parent/guardian issued by the
Service Provider.
Parent Guardian Gender
[ListOfEnrolments].[Enrolment].[Paren
tGuardianGender]
String
1
N/A
F
The gender of the parent/guardian
CCB Eligible Hours
[ListOfEnrolments].[Enrolment].[CCBEl
igibleHours]
String
6
HHH:MM
String
The eligible CCB hours for the
parent/guardian.
CCB Method
[ListOfEnrolments].[Enrolment].[CCBMe
thod]
String
30
N/A
Fee Reduction
The CCB method for the
parent/guardian.
Version Number: 1.50 v1.0 final
Page 131 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
CCB Type
[ListOfEnrolments].[Enrolment].[CCBTy
pe]
String
30
N/A
CCB
The type of CCB the parent/guardian
is receiving.
CCB Percentage
[ListOfEnrolments].[Enrolment].[CCBPe
rcentage]
Decimal
-
N/A
38
The calculated one child rate of
CCB the parent is entitled to
receive expressed as % (only for
Fee Reduction).
CCB Parent Child Status
[ListOfEnrolments].[Enrolment].[CCBPa
rentChildStatus]
String
30
N/A
Current
The CCB Status for the
parent/guardian and child
combination
CCB Parent Child Start
Date
[ListOfEnrolments].[Enrolment].[CCBPa
rentChildStartDate]
Date
10
YYYY-MMDDT
1998-05-12
The date when the parent guardian/
child eligibility started.
CCB Details Updated
[ListOfEnrolments].[Enrolment].[CCBDe
tailsUpdated]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-05-12T
12:24:05
The date when the eligibility
details for the parent guardian
/child were updated.
YTD Absences
[ListOfEnrolments].[Enrolment].[YTDAb
sences]
Integer
-
N/A
5
The number of absences used year to
date, across all services that the
child attends.
Request Enrolment
Advance
[ListOfEnrolments].[Enrolment].[Reque
stEnrolmentAdvance]
String
1
N/A
Y
Indicates if the Service wishes to
request an enrolment advance for
this enrolment.
Service Type
[ListOfEnrolments].[Enrolment].[Servi
ceType]
String
30
N/A
FDC
The Service Type for the enrolment.
Enrolment Advance
Amount
[ListOfEnrolments].[Enrolment].[Enrol
mentAdvanceAmount]
Decimal
-
N/A
50.32
The Enrolment Advance Amount
Calculated for the enrolment
Enrolment Advance
Status
[ListOfEnrolments].[Enrolment].[Enrol
mentAdvanceStatus]
String
30
N/A
Payment Created
The Enrolment Advance Payment
Status for the Enrolment.
Indigenous Status
[ListOfEnrolments].[Enrolment].[Child
IndigenousStatus]
String
30
N/A
Torres Strait
Islander
Indigenous Origin of child if
applicable
Disability
[ListOfEnrolments].[Enrolment].[Child
Disability]
String
1
N/A
Y
Indicates if the child has a
disability
Version Number: 1.50 v1.0 final
Page 132 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware
of the disability.
String
1
N/A
Y
Indicates if the child has a
special need.
ISO D
10
YYYY-MMDD
2005-05-10
The date the Service became aware
of the special need
ISO D
10
N/A
2005-05-10
String
1
N/A
Y
Disability Effective
Date
[ListOfEnrolments].[Enrolment].[Child
DisabilityEffectiveDate]
Special Needs
[ListOfEnrolments].[Enrolment].[Child
SpecialNeeds]
Special Needs Effective
Date
[ListOfEnrolments].[Enrolment].[Child
SpecialNeedsEffectiveDate]
Formalised Date
[ListOfEnrolments].[Enrolment].[Forma
lisedDate]
JFA Eligibility Details
Request
[ListOfEnrolments].[Enrolment].[JFAEl
igibilityDetailsRequest]
CCR Method
[ListOfEnrolments].[Enrolment].[CCRMe
thod]
String
30
N/A
Pay to Family
The CCR method for the
parent/guardian.
FaHCSIA Child ID
[Enrolment].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
FaHCSIA Parent ID
[Enrolment].[FaHCSIAParentId]
String
15
N/A
1-PYT465
The FaHCSIA ID of the parent linked
to this Enrolment, different to the
Service Provider ID, will only be
provided if Enrolment is Formal
IS Case [Listing]
[Enrolment].[ListOfISCases].[ISCase]
IS Case ID
[Enrolment].[ListOfISCases].[ISCase].
[ISCaseId]
String
15
N/A
1-XDRE243
The ID of a Case linked to this
Enrolment via the Child
IS Case Start Date
[Enrolment].[ListOfISCases].[ISCase].
[StartDate]
ISO D
10
YYYY-MMDD
2009-07-01
The Date that this Case commences
IS Case End Date
[Enrolment].[ListOfISCases].[ISCase].
[EndDate]
ISO D
10
YYYY-MMDD
2010-06-30
The Date that this Case ends.
Version Number: 1.50 v1.0 final
Page 133 of 230
The date the Enrolment was
formalised.
Indicates if there is an intention
by the family to claim JFA sessions
under this enrolment and the
Service has seen the approval
letter from CLK.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
IS Case Type
[Enrolment].[ListOfISCases].[ISCase].
[Type]
String
30
N/A
ISS
Will return the type of Case.
IS Review Date
[Enrolment].[ListOfISCases].[ISCase].
[ReviewDate]
ISO D
10
YYYY-MMDD
2010-05-30
The Date that this Case will next
receive a review
IS Case Status
[Enrolment].[ListOfISCases].[ISCase].
[Status]
String
30
N/A
Submitted
The status of the IS Case.
ISF First Name
[Enrolment].[ListOfISCases].[ISCase].
[ISFFirstName]
String
50
N/A
Pauline
The first name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
ISF Last Name
[Enrolment].[ListOfISCases].[ISCase].
[ISFLastName]
String
50
N/A
Smith
The last name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
IS Case Setting
[Enrolment].[ListOfISCases].[ISCase].
[Setting]
String
100
N/A
Wombats
The name of the setting or Home
Based Carer, as determined by the
service during the application for
IS funding. Is not validated, to
be used for information.
ISA Region
[Enrolment].[ListOfISCases].[ISCase].
[ISARegion]
String
50
N/A
Western Sydney
This will display the Region that
this Case belongs to
ISA Organisation Name
[Enrolment].[ListOfISCases].[ISCase].
[ISAOrgName]
String
100
N/A
Western Sydney
ISA
The Name of the organisation that
has endorsed the Case to the
Approving Organisation.
Allowed IS Non Face-toFace Hours
[Enrolment].[ListOfISCases].[ISCase].
[TotalISNonFaceToFaceHrsAllowed]
String
10
HHHHHHH:
MM
0000300:00
The total number of hours allowed
for Non Face to Face carer time for
the period of the Case. This can
be used if children are absent but
a carer was still paid.
IS Non Face-to-Face
Hours Balance
[Enrolment].[ListOfISCases].[ISCase].
[ISNonFaceToFaceHrsBalance]
String
10
HHHHHHH:
MM
0000010:00
The total number of Non Face-toFace Hours remaining for this Case
during the approval period.
Version Number: 1.50 v1.0 final
Page 134 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Primary Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerId]
String
30
N/A
FGER343
The ID of the Primary Home Based
Carer, as listed on the Case
submitted by the Service.
Primary Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerFirstName]
String
50
N/A
Angelina
The First Name of the Primary Home
Based Carer
Primary Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerLastName]
String
50
N/A
Acorn
The Last Name of the Primary Home
Based Carer
Primary Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[PrimaryCarerPostCode]
String
4
NA
2134
The Post Code for the Primary Home
Based Carer
Backup 1 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerId]
String
30
N/A
FFWE343
The ID of Backup Home Based Carer
1, as listed on the Case submitted
by the Service.
Backup 1 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerFirstName]
String
50
N/A
Bronwyn
The First Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerLastName]
String
50
N/A
Bailey
The Last Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup1CarerPostCode]
String
4
NA
2353
The Post Code for Backup Home Based
Carer 1
Backup 2 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerId]
String
30
N/A
FRE465
The ID of Backup Home Based Carer
2, as listed on the Case submitted
by the Service.
Backup 2 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerFirstName]
String
50
N/A
Callista
The First Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerLastName]
String
50
N/A
Crown
The Last Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup2CarerPostCode]
String
4
NA
4532
The Post Code for Backup Home Based
Carer 2
Version Number: 1.50 v1.0 final
Page 135 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Backup 3 Home Based
Carer ID
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerId]
String
30
N/A
DFSE4533
The ID of Backup Home Based Carer
3, as listed on the Case submitted
by the Service.
Backup 3 Home Based
Carer First Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerFirstName]
String
50
N/A
Denise
The First Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Last Name
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerLastName]
String
50
N/A
Donohue
The Last Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Post Code
[Enrolment].[ListOfISCases].[ISCase].
[Backup3CarerPostCode]
String
4
NA
4535
The Post Code for Backup Home Based
Carer 3
IS Case.DaysOfCare
[Listing] – Care Week
Profile
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day]
FaHCSIA Child ID
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked
to this Enrolment, different to the
Service Provider ID, will be
provided for only the child
attached to this enrolment, will be
the same as the Child ID if the
enrolment is formal, will be
provided if the enrolment is not
formal.
Day of Care
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[DayOfCare]
String
30
N/A
Monday
The Day for which the care has been
approved - from the Care Week
Profile
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[PaymentType]
String
30
N/A
ISS Regular Hrs
The Type of care that has been
approved for this day of care.
Variable Week
[Enrolment].[ListOfISCases].[ISCase].
[ListOfDays].[Day].[VariableWeek]
String
30
N/A
Week on Week off
The type of Variable Week
IS Case.CareHours
[Listing] – Profile
Summary
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours]
Version Number: 1.50 v1.0 final
Page 136 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Day of Care
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[DayOfC
are]
String
30
N/A
Monday
The Day for which the care has been
approved – from Care Hours
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[Paymen
tType]
String
30
N/A
ISS Regular Hrs
The Payment Rate that has been
approved for this day of care.
Maximum Hours For
Setting
[Enrolment].[ListOfISCases].[ISCase].
[ListOfCareHours].[CareHours].[Maximu
mHrsForSetting]
String
10
HHHHHHH:
MM
0000008:00
The maximum number of hours that
can be claimed for all children in
the approved care environment for
this day
IS Case.Support Hours
[Listing]
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours]
Payment Type
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
PaymentType]
String
30
N/A
ISS Regular Hrs
This field will define the what
this Payment is for, ie Extra Home
Based Carer or Out Of Home
Support Hours Period
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Period]
String
30
N/A
Week
This field will define over what
period these hours apply, weekly or
total period
Support Hours
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Hours]
String
10
HHHHHHH:
MM
0000020:00
This will define the hours approved
for this type of Case for this
period
Support Hours Tolerance
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Tolerance]
String
10
HHHHHHH:
MM
0000010:00
This will define the amount that a
claim can vary and be automatically
approved. Claims over the hours +
tolerance will be rejected.
Support Hours Balance
[Enrolment].[ListOfISCases].[ISCase].
[ListOfSupportHours].[SupportHours].[
Balance]
String
10
HHHHHHH:
MM
0000400:00
This field will define the
remaining hours available for this
Payment Rate Type for the whole
period. Will be null if Support
Hours Period = Week.
JFA Eligibility
[Listing]
[ListOfEnrolments].[Enrolment].[ListO
fJFAEligibility].[JFAEligibility]
Version Number: 1.50 v1.0 final
Page 137 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
JFA Eligibility ID
[Enrolment].[ListOfJFAEligibility].[J
FAEligibility].[Id]
String
30
N/A
1-3RTD43
The unique ID of the JFA
Eligibility. If the eligibility is
updated by Centrelink, then the ID
will be reset.
JFA Eligibility Start
Date
[ListOfEnrolments].[Enrolment].[ListO
fJFAEligibility].[JFAEligibility].[St
artDate]
ISO D
10
YYYY-MMDD
2005-05-10
Commencement date of JFA
Eligibility. If this date is prior
to the Enrolment Start Date, the
Enrolment Start Date will be
defaulted here.
JFA Eligibility End
Date
[ListOfEnrolments].[Enrolment].[ListO
fJFAEligibility].[JFAEligibility].[En
dDate]
ISO D
10
YYYY-MMDD
2005-05-10
End date of JFA Eligibility.
JFA Eligibility Days
[ListOfEnrolments].[Enrolment].[ListO
fJFAEligibility].[JFAEligibility].[Da
ys]
String
3
N/A
3
Number of JFA eligible days
approved for a child care week
within the JFA approval period.
Comments
[ListOfEnrolments].[Enrolment].[ListO
fJFAEligibility].[JFAEligibility].[Co
mments]
String
100
N/A
Sight JFA
Approval from
Customer for
Details
Instructions to the Service where
the JFA eligible days cannot be
determined.
JFA Details Updated
[ListOfEnrolments].[Enrolment].[ListO
fJFAEligibility].[JFAEligibility].[JF
ADetailsUpdated]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-05-12T
12:24:05
The date Centrelink last updated
the JFA eligibility.
Payments [Listing]
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment]
Payment Line Item Id
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[PaymentLineItem
Id]
String
15
N/A
1-HJUI
The Payment Request Line Item Id on
the FaHCSIA system.
GST Exclusive Amount
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[GSTExclusiveAmo
unt]
Decimal
-
N/A
55.55
The Amount paid for the Enrolment
Version Number: 1.50 v1.0 final
Page 138 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
GST Inclusive Amount
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[GSTInclusiveAmo
unt]
Decimal
-
N/A
55.55
The Amount paid for the Enrolment,
including GST.
Remittance Description
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[RemittanceDescr
iption]
String
250
N/A
1-HJUI Enrolment
Advance
The Remittance Description for the
Payment.
Payment Type
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[PaymentType]
String
30
N/A
CCB Before
School Care
The Payment Type for the Payment.
Processing Date
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[ProcessingDate]
Date
10
YYYY-MMDD
2006-05-30
The date the Payment Request was
created in the FaHCSIA system.
Clearing Number
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[ClearingNumber]
String
30
N/A
18531697
The clearing number on the FaHCSIA
payment system.
Payee Id
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[PayeeId]
String
15
N/A
1-GHY8Y
The unique identifier for the
Service Provider that the payment
was made to.
Date Paid
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[DatePaid]
Date
10
YYYY-MMDD
2006-09-21
The date the payment was made.
Invoice Number
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[InvoiceNumber]
String
50
N/A
14831681
The document number assigned by the
FaHCSIA payment system.
Financial Year
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[FinancialYear]
String
10
N/A
2005-2006
The Financial Year for the Payment.
Organisation Invoice
Number
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[OrganisationInv
oiceNumber]
String
50
N/A
1-1QS3X
The organisations invoice number.
CCB Approval Id
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
String
15
N/A
Payment
Payment or Refund
Version Number: 1.50 v1.0 final
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[PaymentOrRefund
]
Page 139 of 230
Indicates whether the Payment
Request Line Item is a payment or a
refund.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Enrolment Interface - Query Enrolment - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Offset Indicator
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[OffsetIndicator
]
String
1
N/A
Y
If the Payment Request Line Item is
a refund, this indicates if the
amount has been offset.
Enrolment Id
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[EnrolmentId]
String
15
N/A
1-DF1R4
The reference to the Enrolment Id
on the Payment Request Line Item.
Attendance Id
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[AttendanceId]
String
15
N/A
1-4D5F5
The reference to the Attendance Id
on the Payment Request Line Item.
Case ID
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[CaseId]
String
15
N/A
1-453DF
The reference to the IS Case Id on
the Payment Request Line Item.
Case Claim Id
[ListOfEnrolments].[Enrolment].[ListO
fPayments].[Payment].[CaseClaimId]
String
15
N/A
1-234FE
The reference to the IS Case Claim
Id on the Payment Request Line
Item.
Version Number: 1.50 v1.0 final
Page 140 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
12.5.5 Query Enrolment Allowable Values – Response Message
Data Name
Values
CCB Parent Child Status
CCB Method
Status
Gender
CCB Type
Type
Disability
Special Needs
Indigenous Status
Refer to addendum to this document for current production allowable values
JFA Eligibility Details Request
CCR Method
IS Case.IS Case Type
IS Case.Day.Payment Type
IS Case.Day.Variable Week
IS Case.Care Hours.Payment Type
IS Case.Support Hours.Payment Type
IS Case.Support Hours.Period
Version Number: 1.50 v1.0 final
Page 141 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13
Appendix E – Attendances Interface
The following section provides specific information about the three different Service Provider Attendance Interfaces.
13.1 Create Attendances
The Create Attendances Interface Function is used when a Service Provider wishes to submit Attendance data to FaHCSIA. This interface will
take the data submitted by the Service Provider and create attendance records on the FaHCSIA system. If validation fails, an error message will
be generated and an attendance record will not be created. The interface allows for multiple attendance records to be sent at the same time. Each
attendance record submitted will have its own success or failure information returned in the response.
If a Service has been approved for Inclusion Support then Attendances can include extra sessions that report on the Inclusion Support aspect of
the Attendance. For example if a child attends a 10 hour session, and 5 of those hours are for Inclusion Support, then 1 session will report the 10
regular hours and another session, which can overlap, will report the Inclusion Support session including the IS Case ID as extra information. So
there will be 2 sessions being submitted for the 1 day, one for the purposes of CCB reporting, and one for Inclusion Support purposes.
13.1.1 Create Attendance Request Message Data Definition
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
Authorised Person First
Name
[AuthorisedPersonFirstName]
N
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[AuthorisedPersonLastName]
N
String
50
N/A
Smythe
The last of the person at the
Service Provider who authorised
this transaction
Authorised Person Id
[AuthorisedPersonId]
N
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
Version Number: 1.50 v1.0 final
Page 142 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
CCB Approval Id
[ListOfNewAttendances].[NewAtte
ndance].[CCBApprovalId]
Y
String
15
N/A
1-677EP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[ListOfNewAttendances].[NewAtte
ndance].[FaCSIAEnrolmentId]
Y
String
15
N/A
1-C3PO
Unique identifier of the
enrolment record on the FaHCSIA
System.
Service Provider
Attendance Reference
[ListOfNewAttendances].[NewAtte
ndance].[ServiceProviderAttendn
aceReference]
Y
String
50
N/A
REFA00001
Unique identifier of the
attendance record on the
Service Provider Software.
Service
ProviderAttendance
Batch Number
[ListOfNewAttendances].[NewAtte
ndance].[ServiceProviderAttenda
nceBatch]
N
String
30
N/A
BATCH20061030
Identifier for the batch in
which the Service Provider
grouped and submitted the
particular attendance record.
Week Ending
[ListOfNewAttendances].[NewAtte
ndance].[WeekEnding]
Y
Date
10
YYYY-MM-DD
2006-09-03
The End Date for the week
(should always be a Sunday).
Column A on the current
Statement of Child Care Usage.
Fee For Charged
Standard Hours
[ListOfNewAttendances].[NewAtte
ndance].[FeeForChargedStandardH
ours]
Y
Decimal
-
N/A
20.50
Fee Charged for the Hours of
Standard Child Care. Sum of all
Session Fees for the week for
Standard Sessions.
Fee For Charged Non
Standard Hours
[ListOfNewAttendances].[NewAtte
ndance].[FeeForChargedNonStanda
rdHours]
Y
Decimal
-
N/A
20.50
Fee
Non
all
for
Fee For All Charged
Hours
[ListOfNewAttendances].[NewAtte
ndance].[FeeForAllChargedHours]
Y
Decimal
-
N/A
20.50
Fee Charged for the Hours of
Child Care. Sum of Fee for
Standard Hours and Fee for Non
Standard Hours (i.e. all
Session Fees for the week.)
Attendance Details
Version Number: 1.50 v1.0 final
Page 143 of 230
Charged for the Hours of
Standard Child Care. Sum of
Session Fees for the week
Non Standard Sessions.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Total Fee
[ListOfNewAttendances].[NewAtte
ndance].[TotalFee]
Y
Decimal
-
N/A
30.00
The Total Fee Charged for the
week. Fee Charged for the Hours
of Child Care plus any
additional items that have been
charged. (NB: Additional items
as defined for the purposes of
CCTR).
Charged Standard Hours
[ListOfNewAttendances].[NewAtte
ndance].[ChargedStandardHours]
Y
String
6
HHH:MM
009:00
The Charged Hours or Standard
Hours.
Charged Non Standard
Hours
[ListOfNewAttendances].[NewAtte
ndance].[ChargedNonStandardHour
s]
Y
String
6
HHH:MM
000:00
The Charged Non Standard Hours
(Non Standard Hours for
FDC/IHC).
Increase Entitlement
Reason
[ListOfNewAttendances].[NewAtte
ndance].[IncreaseEntitlementRea
son]
N
String
30
N/A
CRK
Reason if assessed eligible,
for an entitlement increase
(Child at Risk - CRK, Financial
Hardship - TFH. Code is
recorded here. Column H on the
current Statement of Child Care
Usage.
Increase Eligible Hours
Reason
[ListOfNewAttendances].[NewAtte
ndance].[IncreaseEligibleHoursR
eason]
N
String
30
N/A
Number of Absences
[ListOfNewAttendances].[NewAtte
ndance].[NumberofAbsences]
Y
Integer
-
N/A
0
The number of absences used for
the week.
Claimed Periods of 24
Hour Care
[ListOfNewAttendances].[NewAtte
ndance].[ClaimedPeriodsof24Hour
Care]
Y
Integer
-
N/A
0
The number of 24 hour care
periods used for the week.
Charged JFA Standard
Hours
[ListOfNewAttendances].[NewAtte
ndance].[ChargedJFAStandardHour
s]
Y
String
6
HHH:MM
000:00
The Hours of Standard JETCCFA
Child Care charged for. Sum of
all Standard Session Hours that
have been flagged as JFA.
Version Number: 1.50 v1.0 final
Page 144 of 230
Reason if assessed eligible,
for an eligible hour increase
(Exceptional Circumstances –
EXC, Child at Risk - CRK). Code
is recorded here. Column I on
the current Statement of Child
Care Usage.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Charged JFA Non
Standard Hours
[ListOfNewAttendances].[NewAtte
ndance].[ChargedJFANonStandardH
ours]
Y
String
6
HHH:MM
000:00
The Hours of Non-Standard
JETCCFA Child Care charged for.
Sum of all Non-Standard Session
Hours that have been flagged as
JFA.
Fee for Charged JFA
Standard Hours
[ListOfNewAttendances].[NewAtte
ndance].[FeeForChargedJFAStanda
rdHours]
Y
Decimal
-
N/A
0.00
Fee Charged for the Hours of
Standard JETCCFA Child Care.
Sum of all Standard Session
Fees for the week that have
been flagged as JFA.
Fee for Charged JFA Non
Standard Hours
[ListOfNewAttendances].[NewAtte
ndance].[FeeForChargedJFANonSta
ndardHours]
Y
Decimal
-
N/A
0.00
Fee Charged for the Hours of
Non Standard JETCCFA Child
Care. Sum of all Non Standard
Session Fees for the week that
have been flagged as JFA.
Fee For All Charged JFA
Hours
[ListOfNewAttendances].[NewAtte
ndance].[FeeForAllChargedJFAHou
rs]
Y
Decimal
-
N/A
0.00
Fee Charged for the All Hours
of JETCCFA Child Care. Sum of
all Session Fees for the week
that have been flagged as JFA.
(ie Sum of Fee for Charged JFA
Standard Hours and Fee for
Charged JFA Non Standard Hours
Total JFA Fee
[ListOfNewAttendances].[NewAtte
ndance].[TotalJFAFee]
N
Decimal
-
N/A
0.00
The Total JFA Fee Charged for
the week. JFA Fee Charged for
the Hours of Child Care plus
any additional items that have
been charged.
Claimed Multiple Child
Count
[ListOfNewAttendances].[NewAtte
ndance].[ClaimedMultipleChildCo
unt]
Y
Integer
-
N/A
1
The number of children in the
family attending the same type
of approved care in the week
Nominated Hours
[ListOfNewAttendances].[NewAtte
ndance].[NominatedHours]
N
String
6
HHH:MM
020:00
The maximum limit on the number
of hours a family wishes to
claim from this Service
Provider.
Sessions [Listing]
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on]
Version Number: 1.50 v1.0 final
Single Session with In/Out
times
Page 145 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Service Provider
Session Reference
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[ServiceProviderSessionRefe
rnece]
Y
String
50
N/A
REFS00523
Unique identifier of the
Session record on Service
Providers Software.
Session Date
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[SessionDate]
Y
Date
10
YYYY-MM-DD
2006-09-01
The date the Session Starts
Session Type
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[SessionType]
Y
String
30
N/A
LDC Hours
The Session Type. For example
LDC Hrs or BSC Hrs.
IS Case Id
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[ISCaseId]
N
String
15
N/A
1-423HG
The FaHCSIA supplied Case ID
that this session is being
linked to. Only to be supplied
if the Session Type is an IS
Session Type.
Session Hours
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[SessionHours]
Y
String
6
N/A
009:00
The Session Hours and Minutes.
It must be a valid time.
Session Start Time
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[SessionStartTime]
Y
DateTime
19
YYYY-MMDDThh:mm:ss
2006-1230T08:30:00
The Start Time of the session.
Session End Time
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[SessionEndTime]
Y
DateTime
19
YYYY-MMDDThh:mm:ss
2006-1231T17:30:00
The End Time of the session.
Attended Hours
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[AttendedHours]
Y
String
6
N/A
003:00
The actual hours and minutes
the child attended, i.e. this
may be less than the session
length if the child leaves
earlier or arrives later than
the session time.
Fee Charged
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[FeeCharged]
Y
Decimal
-
N/A
20.50
The fee charged for the session
of care.
Version Number: 1.50 v1.0 final
Page 146 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Additional Absence
Reason
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[AdditionalAbsenceReason]
N
String
30
N/A
JFA Session
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[JFASession]
N
String
1
N/A
N
Indicates if the session is for
JETCCFA (JFA).
Home Based Carer Id
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[CarerId]
N
String
30
N/A
C000534A
The Id for a Home Based Carer
for the session.
Time In 1
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeIn1]
N
DateTime
19
YYYY-MMDDThh:mm:ss
2006-0901T08:30:00
The time the child arrives at
the service.
Time Out 1
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeOut1]
N
DateTime
19
YYYY-MMDDThh:mm:ss
2006-0901T11:30:00
The time the child leaves the
service.
Time In 2
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeIn2]
N
DateTime
19
YYYY-MMDDThh:mm:ss
The time the child arrives at
the service.
Time Out 2
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeOut2]
N
DateTime
19
YYYY-MMDDThh:mm:ss
The time the child leaves the
service.
Time In 3
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeIn3]
N
DateTime
19
YYYY-MMDDThh:mm:ss
The time the child arrives at
the service.
Time Out 3
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeOut3]
N
DateTime
19
YYYY-MMDDThh:mm:ss
The time the child leaves the
service.
Time In 4
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeIn4]
N
DateTime
19
YYYY-MMDDThh:mm:ss
The time the child arrives at
the service.
Version Number: 1.50 v1.0 final
Page 147 of 230
Sample
Comments
The reason for the additional
Absence.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Time Out 4
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[TimeOut4]
N
DateTime
19
YYYY-MMDDThh:mm:ss
More Than Four
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[MoreThanFour]
N
String
1
N/A
N
If there are more than 4 Ins
and Outs for the session.
Start of 24 Hour Care
Period
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[Start24HrCarePeriod]
N
String
1
N/A
N
Indicates that this is the
start of a 24 Hour Care Period.
Preschool Indicator
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[PreschoolIndicator]
N
String
30
N/a
Offsite
Indicates if the child attended
preschool during the session of
care.
Preschool Hours
[ListOfNewAttendances].[NewAtte
ndance].[ListOfSessions].[Sessi
on].[PreschoolHours]
N
String
6
N/A
009:00
Indicates the number of hours
the child was booked for
preschool attendance during the
session of care.
The time the child leaves the
service.
13.1.2 Create Attendance Request Data Rules
Create Attendance Request Data Rules
Comments
The Maximum Number of Attendance records that can be submitted per interface call is defined X.
Refer to addendum to this document for current production
value for X
For each CCB Approval, there should only by one attendance per Enrolment per week in the status of ‘New’, ‘Submitted’,
‘Processing’ or ‘Processed’.
There can be more than 1 attendance per enrolment per week if
the Attendance has a status of ‘Cancelling’ or ‘Cancelled’
Authorised Person First Name, Authorised Person Last Name and Authorised Person Id are mandatory if the registered version
of software is greater than or equal to 1.30.
Attendance details
The following fields are mandatory for the attendance component:

[Transaction Code]

[Source System Code]

[CCB Approval Id]
Version Number: 1.50 v1.0 final
Page 148 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules

[FaCSIA Enrolment Id]

[Service Provider Attendance Reference]

[Week Ending]

[Fee For Charged Standard Hours]

[Fee For Charged Non Standard Hours]

[Fee For All Charged Hours]

[Total Fee]

[Charged Standard Hours]

[Charged Non Standard Hours]

[Number of Absences]

[Claimed Periods of 24 Hour Care]

[Charged JFA Standard Hours]

[Charged JFA Non Standard Hours]

[Fee For Charged JFA Standard Hours]

[Fee For Charged JFA Non Standard Hours]

[Fee For All Charged JFA Hours]

[Claimed Multiple Child Count]
Comments
Source System must be valid system.
[FaCSIA Enrolment Id] must match an existing enrolment record on the FaHCSIA system.
The Enrolment must be in the Status of ‘Active’ or ‘Suspended’ or ‘Exited’.
[Service Provider Attendance Reference] must be unique across all Attendances where Status is not equal to Cancelled OR
Cancelling for the CCB Approval.
[Week Ending] must be a Sunday.
[Week Ending] must be less than or equal to system date + 6 days
Fee for charged standard hours
[Fee For Charged Standard Hours] must be greater than or equal to zero.
[Fee For Charged Standard Hours] is the sum of all [Session Fees] for certain Session Types.
Refer to the ‘Sum to [Fee for Charged Standard Hours]’ column
in addendum to this document to identify the Session Types for
which [Session Fees] should be summed.
Fee for charged non standard hours
[Fee For Charged Non Standard Hours] must be greater than or equal to zero.
[Fee For Charged Non Standard Hours] is the sum of all [Session Fees] for certain Session Types.
Version Number: 1.50 v1.0 final
Page 149 of 230
Refer to the ‘Sum to [Fee for Charged Non Standard Hours]’
column in addendum to this document to identify the Session
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules
Comments
Types for which [Session Fees] should be summed.
Fee for all charged hours
The sum of [Fee For Charged Standard Hours] and [Fee For Charged Non Standard Hours] must be equal to the [Fee For All
Charged Hours].
[Fee For All Charged Hours] must be greater thanor equal to zero.
Total fee
[Total Fee] must be greater than or equal to zero.
Charged standard hours
[Charged Standard Hours] must be greater thanor equal tozero
[Charged Standard Hours] must be less than or equal to Max Weekly Std. Hours specified for the Service Type
Refer to addendum to this document for current production
value for Max Weekly Std. Hours
[Charged Standard Hours] is the sum of all [Session Hours] for certain Session Types.
Refer to the ‘Sum to [Charged Standard Hours]’ column in
addendum to this document to identify the Session Types for
which [Session Hours] should be summed.
Charged non standard hours
[Charged Non Standard Hours] must be greater than or equal to zero
[Charged Non Standard Hours] must be less than or equal to Max Weekly Non Std. Hours specified for the Service Type
Refer to addendum to this document for current production
value for Max Weekly Non Std. Hours
[Charged Non Standard Hours] is the sum of all [Session Hours] for certain Session Types.
Refer to the ‘Sum to [Charged Non Standard Hours]’ column in
addendum to this document to identify the Session Types for
which [Session Hours] should be summed.
The sum of [Charged Standard Hours] and [Charged Non Standard Hours] must be greater than or equal to zero.
The sum of [Charged Standard Hours] and [Charged Non Standard Hours] must not exceed 168 Hours.
The calculated total Standard Hours for each day of the week must be less than or equal to the Maximum Standard Daily Hours
value if defined for Service Type
Refer to addendum to this document for current production
value for Maximum Standard Daily Hours
Number of absences
The [Number of Absences] is the Count of all Sessions (i.e. number) for certain Session Types (however, if more than 1 session
exists for a day then it is counted as one absence).
Refer to ‘Count to number of absences’ column in addendum to
this document for current production summing and counting
rules for Attendance to identify the Sessions Types to be
included in this count.
[Number of Absences] must be greater than or equal to zero.
Claimed periods of 24 hour care
Version Number: 1.50 v1.0 final
Page 150 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules
Comments
[Claimed Periods of 24 Hour Care] must be greater than or equal to zero.
Charged jfa standard hours
[Charged JFA Standard Hours] must be greater than or equal to zero.
[Charged JFA Standard Hours] is the sum of all [Session Hours] for certain Session Types where the [JFA Session] flag is
checked on the session.
Refer to the ‘Sum to [Charged JFA Standard Hours]’ column in
addendum to this document to identify the Session Types for
which [Session Hours] should be summed.
Charged jfa non standard hours
[Charged JFA Non Standard Hours] must be greater than or equal to zero.
[Charged JFA Non Standard Hours] is the sum of all [Session Hours] for certain Session Types where the [JFA Session] flag is
checked on the session.
Refer to the ‘Sum to [Charged JFA Non Standard Hours]’
column in addendum to this document to identify the Session
Types for which [Session Hours] should be summed.
The sum of [Charged JFA Standard Hours] and [Charged JFA Non Standard Hours] must be equal to or less than the sum of
[Charged Standard Hours] and [Charged Non Standard Hours].
Fee for charged jfa standard hours
[Fee For Charged JFA Standard Hours] must be greater than or equal to zero.
[Fee for Charged JFA Standard Hours] is the sum of all [Session Fees] for certain Session Types where the [JFA Session] flag is
checked on the session.
Refer to the ‘Sum to [Fee for Charged JFA Standard Hours]’
column in addendum to this document to identify the Session
Types for which [Session Fees] should be summed.
Fee for charged jfa non standard hours
[Fee For Charged JFA Non Standard Hours] must be greater than or equal to zero.
[Fee for Charged JFA Non Standard Hours] is the sum of all [Session Fees] for certain Session Types where the [JFA Session]
flag is checked on the session.
Refer to the ‘Sum to [Fee for Charged JFA Non Standard
Hours]’ column in addendum to this document to identify the
Session Types for which [Session Fees] should be summed.
Fee for all charged jfa hours
The sum of [Fee For Charged JFA Standard Hours] and [Fee For Charged JFA Non Standard Hours] must be equal to the [Fee
For All Charged JFA Hours]
[Fee For All Charged JFA Hours] must be greater than or equal to zero.
Total JFA Fee
[Total JFA Fee] must be greater than or equal to zero if the registered version of software is greater than or equal to 1.30.
[Total JFA Fee] must be less than or equal to [Total Fee] if the registered version of software is greater than or equal to 1.30.
[Total JFA Fee] is mandatory if the registered version of software is greater than or equal to 1.30.
Version Number: 1.50 v1.0 final
Page 151 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules
Comments
If the sum of [Charged JFA Standard Hours] and [Charged JFA Non Standard Hours] = zero, [Total JFA Fee] must = 0 if the
registered version of software is greater than or equal to 1.30.
Nominated hours
[Nominated Hours], if included, must be greater than or equal to zero and less than or equal to 168.
Null value in this field indicates that the family has not indicated
a maximum number of hours to claim from this Service
Provider.
If zero is submitted, this indicates that the family wishes to claim
zero hours from this Service Provider.
Increased entitlement/eligibility
[Increased Entitlement Reason] if populated, must exist on the valid list.
[Increased Eligible Hours Reason] if populated, must exist on the valid list.
Periods of 24 Hour Care
[Claimed Periods of 24 Hour Care] is the count of all Sessions (i.e. number) for certain Session Types which have the [Start of
24 Hour Care Period flagged] as ‘True’.
Refer to the ‘Count to [Claimed Periods of 24 Hour Care]’
column in addendum to this document to identify the Session
Types for which the number of sessions should be counted.
Session details
The Attendance record must have at least one Session record.
The following fields are mandatory for the session component:

[Service Provider Session Reference]

[Session Date]

[Session Hours]

[Session Type]

[Session Start Time]

[Session End Time]

[Attended Hours]

[Fee Charged]
Only one Session record for an Attendance can exist with the same combination of [Session Start Time], [Session End Time]
and [Session Type]
[Service Provider Session Reference] must be unique across all Attendances where Status is not equal to Cancelled
ORCancellingfor the CCB Approval.
[Session Date] must be in a valid date format
[Session Date] must be less than or equal to the [Week Ending] Date
[Session Date] must be greater than or equal to the [Week Ending] Date minus six days
Version Number: 1.50 v1.0 final
Page 152 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules
Comments
[Session Date] cannot be before the Enrolment Start Date or after the Enrolment End Date
[Session Date] cannot be before the CCB Approval Start Date or after the CCB Approval End Date
[Session Hours] and [Attended Hours] must be a valid time with minutes.
[Session Hours] must be greater than zero.
[Session Hours] must not exceed 168 Hours.
[Session Hours] minutes component must not exceed 59.
[Session Hours] must equal the difference between the [Session End Time] and [Session Start Time].
[Session Hours] must not exceed the Maximum Session Hours prescribed by Service Type and Session Type.
Refer to addendum to this document for current production
value for Maximum Session Hours by Service Type and
Session Type
[Session Type] must exist on the valid list.
[Session Type] must be valid for the Attendance.
[Session Type] must be valid for the day of the week on which the session occurred
Refer to addendum to this document for valid days of week for
Session Types
The date component of the [Session Start Time] must equal the [Session Date], i.e. the session must start on the same day as
the Session Date.
The same restriction does not apply to the [Session End Time]
or the various In and Out Times on the Session.
If Session is not an “absence”, [Session Date] can not be greater than FaHCSIA’s current system date.
This allows “absence” sessions to be created in the future but
still less than the week ending date.
The date component of the [Session End Time] must be less than or equal to the CCB Approval End Date.
[Session Start Time] on each Session record must be greater than or equal to the Earliest Start Time specified for the Session
Type (if an Earliest Start Time is specified for the Service Type).
Refer to addendum to this document for current production
value for Earliest Start Time
[Session End Time] must be less than or equal to the Latest End Time specified for the Session Type (if an Latest End Time is
specified for the Service Type)
Refer to addendum to this document for current production
value for Latest End Time
[Session End Time] must be greater than [Session Start Time] for the Session.
[Fee Charged] must be greater than zero if specified for that Session Type.
Refer to the ‘[Fee Charged] must be greater than zero’ column
in addendum to this document to identify the Session Types for
which this rule applies.
[Fee Charged] must equal zero if specified for that Session Type.
Refer to the ‘[Fee Charged] must equal zero’ column in
addendum to this document to identify the Session Types for
which this rule applies.
[Fee Charged] must be greater than or equal to zero if specified for that Session Type.
Refer to the ‘[Fee Charged] must be greater than or equal to
zero’ column in addendum to this document to identify the
Session Types for which this rule applies.
Version Number: 1.50 v1.0 final
Page 153 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules
Comments
[Additional Absences Reason] is mandatory for certain Session Types.
Refer to the ‘[Additional Absence Reason] Required’ column in
addendum to this document to identify the Session Types for
which this field is mandatory.
[Additional Absences Reason] must exist on the valid list.
[Attended Hours] must be greater than zero for certain Session Types.
Refer to the ‘[Attended Hours] must be greater than zero’
column in addendum to this document to identify the Session
Types for which this field must be greater than zero.
[Time In 1] and [Time Out 1] is mandatory for certain Session Types.
Refer to the ‘At Least One In and Out Time Required’ column in
addendum to this document to identify the Session Types for
which these fields are mandatory.
[Time Out 1] is mandatory if [Time In 1] is populated.
[Time In 1] must be less than [Time Out 1].
[Time In 2] cannot be populated until [Time Out 1] is populated.
[Time In 2] must be greater than [Time Out 1].
[Time Out 2] is mandatory if [Time In 2] is populated.
[Time In 2] must be less than [Time Out 2].
[Time In 3] cannot be populated until [Time Out 2] is populated.
[Time In 3] must be greater than [Time Out 2].
[Time Out 3] is mandatory if [Time In 3] is populated.
[Time In 3] must be less than [Time Out 3].
[Time In 4] cannot be populated until [Time Out 3] is populated.
[Time In 4] must be greater than [Time Out 3].
[Time Out 4] is mandatory if [Time In 4] is populated.
[Time In 4] must be less than [Time Out 4].
[More than 4] can only be populated if [Time Out 4] is populated.
[CarerId] is mandatory for FDC and IHC Service Types.
[Preschool Indicator] must exist on the valid list.
If [Preschool Indicator] is not null, [Preschool Hours] must be greater than zero and less than or equal to [Session Hours].
If [Preschool Indicator] is null, [Preschool Hours] must be null.
Version Number: 1.50 v1.0 final
Page 154 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create Attendance Request Data Rules
Comments
If any Session on the Attendance is an IS Session Type and is not linked to a valid IS Case then an error will be raised and the
Attendance record will be rejected.
If an IS Session Type is submitted against an Attendance for FDC or IHC, Carer ID on that Session must be listed on the IS
Case as one of the four Carers (Primary, Backup 1, Backup 2, Backup 3)
13.1.3 Create Attendance Allowable Values - Request Message
Note that each Enrolment is for a particular Service Type. Therefore the Session Type submitted in the Attendance message is checked as being
valid for the Service Type of the Enrolment even though the Service Type itself is not included in the Attendance message.
Service Type
Session Type
FDC
IHC
LDC
OCC
Refer to addendum to this document for current production Session Types
BSC
ASC
VAC
Data name
Values
Increased Entitlement Reason
Increased Eligible Hours Reason
Refer to addendum to this document for current production allowable values
Additional Absence Reason
Preschool Indicator
Version Number: 1.50 v1.0 final
Page 155 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13.1.4 Create Attendance Response Message Data Definition
Attendance Interface - Create Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Number of Attendances
Processed
[NumberOfAttendancesProcessed]
Integer
-
N/A
100
The number of attendance records
submitted in the request message.
Number of Attendances
Successfully Processed
[NumberOfAttendancesSuccessfullyProces
sed]
Integer
-
N/A
64
The number of attendance records
successfully processed that were
submitted in the request message.
Number of Attendances
Unsuccessfully
Processed
Integer
-
N/A
36
[NumberOfAttendancesUnsuccessfullyProc
essed]
The number of attendance records
unsuccessfully processed that were
submitted in the request message.
List Of Attendances
[ListOfAttendances]
Return Code
[ListOfAttendances].[NewAttendance].[R
eturnCode]
Integer
-
N/A
0
The Return Code for the Attendance
record.
Return Error
[ListOfAttendances].[NewAttendance].[R
eturnError]
String
75
N/A
Return Message
[ListOfAttendances].[NewAttendance].[R
eturnMessage]
String
250
N/A
OK
The Return Message for the Attendance
record.
CCB Approval Id
[ListOfNewAttendances].[NewAttendance]
.[CCBApprovalId]
String
15
N/A
1-677EP
Unique identifier of the CCB Approval
issued by FaHCSIA.
FaCSIA Attendance Id
[ListOfAttendances].[NewAttendance].[F
String
15
N/A
1-AG47Y
Unique identifier of the Attendance
record on the FaHCSIA system. Known
Version Number: 1.50 v1.0 final
Page 156 of 230
The Return Error for the Request
Message.
The Return Error for the Attendance
record.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Create Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
aCSIAAttendanceId]
Comments
internally as Attendance Id.
FaCSIA Enrolment Id
[ListOfAttendances].[NewAttendance].[F
aCSIAEnrolmentId]
String
15
N/A
1-C3PO
Unique identifier of the Enrolment
record on the FaHCSIA system. Known
internally as Enrolment Id.
Service Provider
Attendance Reference
[ListOfNewAttendances].[NewAttendance]
.[ServiceProviderAttendanceReference]
String
50
N/A
REFA00001
Unique identifier of Attendance
record on Service Provider’s
Software.
13.1.5 Create Attendance Allowable Values - Response Message
None specified.
Version Number: 1.50 v1.0 final
Page 157 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13.2 Query Attendances
The Query Attendances Interface is used when a Service Provider wishes to query FaHCSIA for information on their attendance records. The
query will be limited to a pre-defined list of arguments, with the combination of fields being used to construct a query. The query will be
constructed using the ‘AND’ operator to combine the query fields.
13.2.1 Query Attendance Request Message Data Definition
Attendance Interface - Query Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A234RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677EP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[FaCSIAEnrolmentId]
N
String
15
N/A
1-C3PO
Unique identifier of enrolment
record on the FAHCSIA system.
FaCSIA Attendance Id
[FaCSIAAttendanceId]
N
String
15
N/A
1-POLK
Unique identifier of the
Attendance record on the
FaHCSIA system.
Service Provider
Attendance Reference
[ServiceProviderAttendanceRefe
rence]
N
String
50
N/A
REFA00001
Unique identifier of Attendance
record on Service Provider’s
Software.
Week Ending
[WeekEnding]
N
Date
10
YYYY-MM-DD
2006-09-24
The End Date for the week
(should always be a Sunday).
Column A on the current
Statement of Child Care Usage.
Attendance Status
[AttendanceStatus]
N
String
30
N/A
Processed
The Status of the Attendance
record.
Version Number: 1.50 v1.0 final
Page 158 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Service Provider
Attendance Batch Number
[ServiceProviderAttendanceBatc
hNumber]
N
String
30
N/A
BATCH20061030
Identifier for the batch in
which the Service Provider
grouped and submitted the
particular attendance record.
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:S
S
2006-0612T15:12:34
Indicates that any records
updated since this date/time
stamp are required.
Page Size
[PageSize]
N
Integer
-
NNN
10
Maximum number of records
returned per query
Page Number
[PageNumber]
N
Integer
-
NNN
2
The page number of records to
return
Return Sessions
[ReturnSessions]
N
String
30
N/A
All Sessions
This option will allow the
nominating of what is returned
in the Query Attendance
Response, all sessions, only IS
Sessions, or no Session
information. Default to all
Sessions returned.
13.2.2 Query Attendance Request Data Rules
Query Attendance Request Data Rules
Comments
Source System must be valid system.
Page Size, Page Number must be greater than zero.
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size must be less than or equal to Maximum Page Size.
Refer to addendum to this document for current production value for Maximum
Page Size
Each field will only accept 1 value in the correct format.
Eg. The ‘Week Ending’ field will only accept one date in the format YYYY-MM-DD
Version Number: 1.50 v1.0 final
Page 159 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13.2.3 Query Attendance Allowable Values – Request Message
Data Name
Values
Attendance Status
Maximum Page Size
Refer to addendum to this document for current production allowable values
Default Page Size
Return Sessions
13.2.4 Query Attendance Response Message Data Definition
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if it is the last page
returned
Attendance [Listing]
[ListOfAttendances].[Attendance]
CCB Approval Id
[ListOfAttendances].[Attendance].[CCBA
pprovalId]
String
15
N/A
1-677EP
Unique identifier of the CCB Approval
issued by FaHCSIA.
FaCSIA Enrolment Id
[ListOfAttendances].[Attendance].[FaCS
IAEnrolmentId]
String
15
N/A
1-POK3
Unique identifier of enrolment record
on the FAHCSIA system.
FaCSIA Attendance Id
[ListOfAttendances].[Attendance].[FaCS
IAAttendanceId]
String
15
N/A
1-AG47Y
Unique identifier of the Attendance
record on the FaHCSIA system.
Version Number: 1.50 v1.0 final
Page 160 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Service Provider
Attendance Reference
[ListOfAttendances].[Attendance].[Serv
iceProviderAttendanceReference]
String
50
N/A
REFA00001
Unique identifier of the attendance
record on the Service Provider
Software System
Create Authorised
Person First Name
[ListOfAttendances].[Attendance].[Crea
teAuthorisedPersonFirstName]
String
50
N/A
John
The first name of the person at the
Service Provider who authorised the
creation of the attendance
Create Authorised
Person Last Name
[ListOfAttendances].[Attendance].[Crea
teAuthorisedPersonLastName]
String
50
N/A
Smythe
The last name of the person at the
Service Provider who authorised the
creation of the attendance
Create Authorised
Person Id
[ListOfAttendances].[Attendance].[Crea
teAuthorisedPersonId]
String
20
N/A
APIDA001
The unique Id of the person at the
Service Provider who authorised the
creation of the attendance- a unique
identifier issued by the Service
Cancel Authorised
Person First Name
[ListOfAttendances].[Attendance].[Canc
elAuthorisedPersonFirstName]
String
50
N/A
Terry
The first name of the person at the
Service Provider who authorised the
cancellation of the attendance
Cancel Authorised
Person Last Name
[ListOfAttendances].[Attendance].[Canc
elAuthorisedPersonLastName]
String
50
N/A
Towel
The last name of the person at the
Service Provider who authorised the
cancellation of the attendance
Cancel Authorised
Person Id
[ListOfAttendances].[Attendance].[Canc
elAuthorisedPersonId]
String
20
N/A
APIDA002
The unique Id of the person at the
Service Provider who authorised the
cancellation of the attendance - a
unique identifier issued by the
Service
Service Provider
Attendance Batch Number
[ListOfAttendances].[Attendance].[Serv
iceProviderAttendanceBatchNumber]
String
30
N/A
BATCH20061030
Identifier for the batch in which the
Service Provider grouped and
submitted the particular attendance
record.
Week Ending
[ListOfAttendances].[Attendance].[Week
Ending]
Date
10
YYYY-MMDD
2006-09-03
The End Date for the week (should
always be a Sunday). Column A on the
current Statement of Child Care
Usage.
Service Exempt
[ListOfAttendances].[Attendance].[Serv
iceExempt]
String
30
N/A
Local Emergency
Any Service Exemptions applicable at
the time of this Attendance
Version Number: 1.50 v1.0 final
Page 161 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Fee For Charged
Standard Hours
[ListOfAttendances].[Attendance].[FeeF
orChargedStandardHours]
Decimal
-
N/A
20.50
Fee Charged for the Hours of Standard
Child Care. Sum of all Session Fees
for the week for Standard Sessions.
Fee For Charged Non
Standard Hours
[ListOfAttendances].[Attendance].[FeeF
orChargedNonStandardHours]
Decimal
-
N/A
20.50
Fee Charged for the Hours of Non
Standard Child Care. Sum of all
Session Fees for the week for Non
Standard Sessions.
Fee For All Charged
Hours
[ListOfAttendances].[Attendance].[FeeF
orAllChargedHours]
Decimal
-
N/A
20.50
Fee Charged for the Hours of Child
Care. Sum of Fee for Standard Hours
and Fee for Non Standard Hours (i.e.
all Session Fees for the week.)
Total Fee
[ListOfAttendances].[Attendance].[Tota
lFee]
Decimal
-
N/A
30.00
The Total Fee Charged for the week.
Fee Charged for the Hours of Child
Care plus any additional items that
have been charged. (NB: Additional
items as defined for the purposes of
CCTR).
Charged Standard Hours
[ListOfAttendances].[Attendance].[Char
gedStandardHours]
String
6
HHH:MM
009:00
The Charged Hours or Standard Hours.
Charged Non Standard
Hours
[ListOfAttendances].[Attendance].[Char
gedNonStandardHours]
String
6
HHH:MM
000:00
The Charged Non Standard Hours (Non
Standard Hours for FDC/IHC).
Increase Entitlement
Reason
[ListOfAttendances].[Attendance].[Incr
easeEntitlementReason]
String
30
N/A
CRK
Reason if assessed eligible, for an
entitlement increase (Child at Risk CRK, Financial Hardship - TFH. Code
is recorded here. Column H on the
current Statement of Child Care
Usage.
Increase Eligible Hours
Reason
[ListOfAttendances].[Attendance].[Incr
easeHoursReason]
String
30
N/A
Number of Absences
[ListOfAttendances].[Attendance].[Numb
erofAbsences]
Integer
-
N/A
Version Number: 1.50 v1.0 final
Page 162 of 230
Reason if assessed eligible, for an
eligible hour increase (Exceptional
Circumstances – EXC, Child at Risk CRK). Code is recorded here. Column I
on the current Statement of Child
Care Usage.
0
The number of absences used for the
week.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Claimed Periods of 24
Hour care
[ListOfAttendances].[Attendance].[Clai
medPeriodsof24HourCare]
Integer
-
N/A
0
The number of 24 hour care periods
used for the week.
Charged JFA Standard
Hours
[ListOfAttendances].[Attendance].[Char
gedJFAStandardHours]
String
6
HHH:MM
000:00
The Hours of Standard JETCCFA Child
Care charged for. Sum of all Standard
Session Hours that have been flagged
as JFA.
Charged JFA Non
Standard Hours
[ListOfAttendances].[Attendance].[Char
gedJFANonStandardHours]
String
6
HHH:MM
000:00
The Hours of Non-Standard JETCCFA
Child Care charged for. Sum of all
Non-Standard Session Hours that have
been flagged as JFA.
Fee for Charged JFA
Standard Hours
[ListOfAttendances].[Attendance].[FeeF
orChargedJFAStandardHours]
Decimal
-
N/A
0.00
Fee Charged for the Hours of Standard
JETCCFA Child Care. Sum of all
Standard Session Fees for the week
that have been flagged as JFA.
Fee for Charged JFA Non
Standard Hours
[ListOfAttendances].[Attendance].[FeeF
orChargedJFANonStandardHours]
Decimal
-
N/A
0.00
Fee Charged for the Hours of Non
Standard JETCCFA Child Care. Sum of
all Non Standard Session Fees for the
week that have been flagged as JFA.
Fee For All Charged JFA
Hours
[ListOfAttendances].[Attendance].[FeeF
orAllChargedJFAHours]
Decimal
-
N/A
0.00
Fee Charged for the All Hours of
JETCCFA Child Care. Sum of all
Session Fees for the week that have
been flagged as JFA. (ie Sum of Fee
for Charged JFA Standard Hours and
Fee for Charged JFA Non Standard
Hours
Total JFA Fee
[ListOfAttendances].[Attendance].[Tota
lJFAFee]
Decimal
-
N/A
0.00
The Total JFA Fee Charged for the
week. JFA Fee Charged for the Hours
of Child Care plus any additional
items that have been charged.
CCB School Child
[ListOfAttendances].[Attendance].[CCBS
choolChild]
String
1
N/A
Y
Identifies if the child attends
school according to Centrelink.
Claimed Multiple Child
Count
[ListOfAttendances].[Attendance].[Clai
medMultipleChildCount]
Integer
-
N/A
1
The number of children in the family
attending the same type of approved
care in the week
Version Number: 1.50 v1.0 final
Page 163 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Nominated Hours
[ListOfAttendances].[Attendance].[Nomi
natedHours]
String
6
HHH:MM
020:00
The maximum limit on the number of
hours a family wishes to claim from
this Service Provider.
Attendance Status
[ListOfAttendances].[Attendance].[Atte
ndanceStatus]
String
30
N/A
Processed
The status of the Attendance.
CCB Payment Status
[ListOfAttendances].[Attendance].[CCBP
aymentStatus]
String
30
N/A
Payment Created
The Status of the CCB Payment.
JFA Payment Status
[ListOfAttendances].[Attendance].[JFAP
aymentStatus]
String
30
N/A
Not Applicable
The Status of the JFA Payment.
Centrelink Interface
Status
[ListOfAttendances].[Attendance].[Cent
relinkInterfaceStatus]
String
30
N/A
Received
The Status of the Attendance record
from the Centrelink Attendance record
perspective.
CCB Total Fee Reduction
[ListOfAttendances].[Attendance].[CCBT
otalFeeReduction]
Decimal
-
N/A
20.50
The dollar amount for the total CCB
Calculation. (Sum of Column F and G).
CCB Adjustments
[ListOfAttendances].[Attendance].[CCBA
djustments]
Decimal
-
N/A
-1.23
The sum of any adjustments to the CCB
Fee Reduction Calculation.
CCB Pay to Service
[ListOfAttendances].[Attendance].[CCBP
ayToService]
Decimal
-
N/A
19.27
The dollar amount to be paid to the
service. This is the CCB Total Fee
Reduction plus any CCB adjustments.
JFA Total Entitlement
[ListOfAttendances].[Attendance].[JFAT
otalEntitlement]
Decimal
-
N/A
0.00
The dollar amount for the total JFA
entitlement. Column O.
JFA Adjustments
[ListOfAttendances].[Attendance].[JFAA
djustments]
Decimal
-
N/A
0.00
The sum of any adjustments to the JFA
Entitlement Calculation.
JFA Pay to Service
[ListOfAttendances].[Attendance].[JFAP
ayToService]
Decimal
-
N/A
0.00
The dollar amount to be paid to the
service. This is the JFA Total
Entitlement plus any JFA adjustments.
CCB Total Hours
[ListOfAttendances].[Attendance].[CCBT
otalHours]
String
6
HHH:MM
009:00
The total hours for the CCB
calculation.
JFA Total Hours
[ListOfAttendances].[Attendance].[JFAT
String
6
HHH:MM
000:00
The total hours for the JFA
Version Number: 1.50 v1.0 final
Page 164 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
otalHours]
Comments
entitlement. Sum of Column L and M.
CCB Type
[ListOfAttendances].[Attendance].[CCBT
ype]
String
30
N/A
CCB
The CCB Entitlement Type (i.e. GCCB
or CCB).
CCB Method
[ListOfAttendances].[Attendance].[CCBM
ethod]
String
30
N/A
Fee Reduction
The method determined by the customer
for the CCB Payment (i.e. Fee
Reduction or Lump Sum).
CCB Percentage
[ListOfAttendances].[Attendance].[CCBP
ercentage]
Decimal
-
N/A
100.00
The CCB Percentage used to calculate
the CCB Fee Reduction.
CCB Standard Hours Fee
Reduction
[ListOfAttendances].[Attendance].[CCBS
tandardHoursFeeReduction]
Decimal
-
N/A
20.50
The dollar amount for the CCB hours
(standard hours for FDC/IHC). Column
F.
CCB Non Standard Hours
Fee Reduction
[ListOfAttendances].[Attendance].[CCBN
onStandardHoursFee Reduction]
Decimal
-
N/A
00.00
The dollar amount for the CCB Non
Standard Hours. Column G.
CCB Standard Hours
[ListOfAttendances].[Attendance].[CCBS
tandardHours]
String
6
HHH:MM
009:00
The hours for the CCB Calculation
(standard hours for FDC/IHC).
CCB Non Standard Hours
[ListOfAttendances].[Attendance].[CCBN
onStandardHours]
String
6
HHH:MM
000:00
The non standard hours for the CCB
calculation (FDC/IHC only).
CCB Calculation Details
[ListOfAttendances].[Attendance].[CCBC
alculationDetails]
String
200
N/A
Eg. Exceeded
Eligible Hours
Further details regarding the CCB
Calculation.
CCB Ineligible
[ListOfAttendances].[Attendance].[CCBI
neligible]
String
1
N/A
N
Identifies if the customer is
ineligible for CCB.
CCB Ineligible Reason
[ListOfAttendances].[Attendance].[CCBI
neligibleReason]
String
200
N/A
CCB LDC Part Time Rate
[ListOfAttendances].[Attendance].[CCBL
DCPartTimeRate]
Decimal
-
N/A
00.00
The part time rate that was applied
by Centrelink for the attendance.
CCB Number of Absences
Paid
[ListOfAttendances].[Attendance].[CCBN
umberOfAbsencesPaid]
Integer
-
N/A
0
The number of absences paid for on
the attendance record.
CCB Periods of 24 Hour
[ListOfAttendances].[Attendance].[CCBP
Integer
-
N/A
0
The number of 24 hour care periods
Version Number: 1.50 v1.0 final
Page 165 of 230
The reason for the CCB ineligibility
(ie. Not Immunisation)
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Care Paid
eriodof24HourCarePaid]
CCB Multiple Child
Count
[ListOfAttendances].[Attendance].[CCBM
ultipleChildCount]
JFA Standard Hours
Entitlement
Data Type
Length
Format
Sample
Comments
paid for on the attendance record.
The multiple child count applied
during the CCB calculation.
Integer
-
N/A
0
[ListOfAttendances].[Attendance].[JFAS
tandardHoursEntitlement]
Decimal
-
N/A
0.00
The dollar amount for the entitlement
for the JFA Standard hours.
JFA Non Standard Hours
Entitlement
[ListOfAttendances].[Attendance].[JFAN
onStandardHoursEntitlement]
Decimal
-
N/A
0.00
The dollar amount for the entitlement
for the non standard JFA hours.
JFA Standard Hours
[ListOfAttendances].[Attendance].[JFAS
tandard Hours]
String
6
HHH:MM
000:00
The hours for the JFA calculation
(standard hours for FDC/IHC).
JFA Non Standard Hours
[ListOfAttendances].[Attendance].[JFAN
onStandardHours]
String
6
HHH:MM
000:00
The non standard hours for the JFA
calculation
JFA Calculation Details
[ListOfAttendances].[Attendance].[JFAC
alculationDetails]
String
200
N/A
NA
Further details regarding the JFA
Calculation.
JFA Ineligible
[ListOfAttendances].[Attendance].[JFAI
neligible]
String
1
N/A
N
Identifies if the customer is
ineligible for JFA.
JFA Ineligible Reason
[ListOfAttendances].[Attendance].[JFAI
neligibleReason]
String
200
N/A
YTD Absences
[ListOfAttendances].[Attendance].[YTDA
bsences]
Integer
-
N/A
42
The number of absences used year to
date, across all services that the
child attends.
Centrelink Processed
Date
[ListOfAttendances].[Attendance].[Cent
relinkProcessedDate]
DateTime
19
YYYY-MMDD
2006-0930T08:30:52
Date/time the attendance record was
processed by Centrelink.
Cancellation Received
[ListOfAttendances].[Attendance].[Canc
ellationReceived]
DateTime
19
YYYY-MMDD
2006-0930T08:30:52
The date the cancellation request was
received.
CCB Recovery
[ListOfAttendances].[Attendance].[CCBR
ecovery]
String
30
N/A
Service
If the Attendance is cancelled, this
field indicates whether the recovery
of the CCB Fee Reduction will be from
the Service or from the family.
CCR Total Fee Reduction
[ListOfAttendances].[Attendance].[CCRT
Decimal
-
N/A
20.50
The dollar amount for the total CCR
Version Number: 1.50 v1.0 final
Page 166 of 230
The reason for the JFA ineligibility
(ie. Not Immunisation)
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
otalFeeReduction]
Comments
Calculation.
CCR Adjustments
[ListOfAttendances].[Attendance].[CCRA
djustments]
Decimal
-
N/A
-1.23
The sum of any adjustments to the CCR
Fee Reduction Calculation.
CCR Pay to Service
[ListOfAttendances].[Attendance].[CCRP
ayToService]
Decimal
-
N/A
19.27
The dollar amount to be paid to the
service. This is the CCR Total Fee
Reduction plus any CCR adjustments.
CCR Method
[ListOfAttendances].[Attendance].[CCRM
ethod]
String
30
N/A
Pay to Service
The method determined by the customer
for the CCR Payment (i.e. Pay to
Family or Pay to Service).
CCR Calculation Details
[ListOfAttendances].[Attendance].[CCRC
alculationDetails]
String
200
N/A
Exceeded
Eligible Hours
Further details regarding the CCR
Calculation.
CCR Ineligible
[ListOfAttendances].[Attendance].[CCRI
neligible]
String
1
N/A
N
Identifies if the customer is
ineligible for CCR.
CCR Ineligible Reason
[ListOfAttendances].[Attendance].[CCRI
neligibleReason]
String
200
N/A
CCR Payment Status
[ListOfAttendances].[Attendance].[CCRP
aymentStatus]
String
30
N/A
Payment Created
The Status of the CCR Payment.
Sessions [Listing]
[ListOfAttendances].[Attendance].[List
OfSessions].[Session]
Service Provider
Session Reference
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[ServiceProvider
SessionRefernece]
String
50
N/A
REFS00523
Unique identifier of the Session
record on Service Provider’s Software
System.
Session Date
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[SessionDate]
Date
10
YYYY-MMDD
2006-09-01
The date the Session Starts
Session Type
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[SessionType]
String
30
N/A
LDC Hours
The Session Type. For example LDC Hrs
or BSC Hrs.
IS Case Id
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[ISCaseId]
String
15
N/A
1-RGR453
The ID of the Case linked to this
session.
Session Hours
[ListOfAttendances].[Attendance].[List
String
6
N/A
009:00
The Session Hours and Minutes. It
Version Number: 1.50 v1.0 final
Page 167 of 230
The reason for the CCR ineligibility
(ie. Not Immunisation)
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
OfSessions].[Session].[SessionHours]
Comments
must be a valid time.
Session Start Time
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[SessionStartTim
e]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-0920T08:30:00
The Start Time of the session.
Session End Time
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[SessionEndTime]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-0920T17:30:00
The End Time of the session.
Attended Hours
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[AttendedHours]
String
6
N/A
003:00
The actual hours and minutes the
child attended, i.e. this may be less
than the session length if the child
leaves early or arrives late.
Fee Charged
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[FeeCharged]
Decimal
-
N/A
20.50
The fee charged for the session of
care.
Additional Absence
Reason
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[AdditionalAbsen
ceReason]
String
30
N/A
JFA Session
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[JFASession]
String
1
N/A
N
Indicates if the session is for
JETCCFA (JFA).
Home Based Carer Id
[ListOfNewAttendances].[NewAttendance]
.[ListOfSessions].[Session].[CarerId]
String
30
N/A
C000534A
The Id for a Home Based Carer for the
session.
Time In 1
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeIn1]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-0920T08:30:00
The time the child arrives at the
service
Time Out 1
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeOut1]
DateTime
19
YYYY-MMDDThh:mm
:ss
2006-0920T11:30:00
The time the child leaves the service
Time In 2
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeIn2]
DateTime
19
YYYY-MMDDThh:mm
:ss
The time the child arrives at the
service
Time Out 2
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeOut2]
DateTime
19
YYYY-MMDDThh:mm
The time the child leaves the service
Version Number: 1.50 v1.0 final
Page 168 of 230
The reason for the additional
Absence.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
:ss
Time In 3
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeIn3]
DateTime
19
YYYY-MMDDThh:mm
:ss
The time the child arrives at the
service
Time Out 3
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeOut3]
DateTime
19
YYYY-MMDDThh:mm
:ss
The time the child leaves the service
Time In 4
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeIn4]
DateTime
19
YYYY-MMDDThh:mm
:ss
The time the child arrives at the
service
Time Out 4
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[TimeOut4]
DateTime
19
YYYY-MMDDThh:mm
:ss
The time the child leaves the service
More Than Four
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[MoreThanFour]
String
1
N/A
N
If there are more than 4 Ins and Outs
for the session
Start of 24 Hour Care
Period
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[Start24HrCarePe
riod]
String
1
N/A
N
Indicates that this is the start of a
24 Hour Care Period.
Preschool Indicator
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[PreschoolIndica
tor]
String
30
N/a
Inhouse
Indicates if the child attended
preschool during the session of care.
Preschool Hours
[ListOfAttendances].[Attendance].[List
OfSessions].[Session].[PreschoolHours]
String
6
N/A
003:00
Indicates if the number of hours the
child was booked for preschool
attendance during the session of
care.
Payments [Listing]
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment]
Payment Line Item Id
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[PaymentLineItem
Id]
String
15
N/A
1-HJUI
The Payment Request Line Item Id on
the FaHCSIA system.
GST Exclusive Amount
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[GSTExclusiveAmo
Decimal
-
N/A
20.50
The Amount paid for the Enrolment
Version Number: 1.50 v1.0 final
Payment details related to the
Enrolment
Page 169 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
N.2
-
N/A
11.12
The amount, including GST, paid for
the Attendance.
unt]
GST Inclusive Amount
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[GSTInclusiveAmo
unt]
Remittance Description
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[RemittanceDescr
iption]
String
250
N/A
1-HJUI CCB
Attended Hours
The Remittance Description for the
Payment.
Processing Date
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[ProcessingDate]
Date
10
YYYY-MMDD
2006-05-30
The date the Payment Request was
created in the FaHCSIA system.
Clearing Number
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[ClearingNumber]
String
30
N/A
18531697
The clearing number on the FaHCSIA
payment system.
Payee Id
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[PayeeId]
String
15
N/A
1-GHY8Y
The unique identifier for the Service
Provider that the payment was made
to.
Date Paid
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[DatePaid]
Date
10
YYYY-MMDD
2006-09-21
The date the payment was made.
Invoice Number
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[InvoiceNumber]
String
50
N/A
14831681
The document number assigned by the
FaHCSIA payment system.
Financial Year
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[FinancialYear]
String
10
N/A
2006-2007
The Financial Year for the Payment.
Organisation Invoice
Number
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[OrganisationInv
oiceNumber]
String
50
N/A
1-1QS3X
The organisations invoice number.
CCB Approval Id
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[CCBApprovalId]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaHCSIA.
Payment or Refund
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[PaymentOrRefund
]
String
15
N/A
Payment
Indicates whether the Payment Request
Line Item is a payment or a refund.
Offset Indicator
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[OffsetIndicator
String
1
N/A
Y
If the Payment Request Line Item is a
refund, this indicates if the amount
Version Number: 1.50 v1.0 final
Page 170 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Attendance Interface - Query Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
]
Comments
has been offset.
Enrolment Id
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[EnrolmentId]
String
15
N/A
1-DF1R4
The reference to the Enrolment Id on
the Payment Request Line Item.
Attendance Id
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[AttendanceId]
String
15
N/A
1-4D5F5
The reference to the Attendance Id on
the Payment Request Line Item.
Case ID
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[CaseId]
String
15
N/A
1-453DF
The reference to the IS Case ID on
the Payment Request Line Item.
Case Claim Id
[ListOfAttendances].[Attendance].[List
OfPayments].[Payment].[CaseClaimId]
String
15
N/A
1-234FE
The reference to the Case Claim Id on
the Payment Request Line Item.
13.2.5 Query Attendance Allowable Values – Response Message
Data Name
Values
Increased Entitlement Reason
Increased Eligible Hours Reason
Attendance Status
CCB Payment Status
JFA Payment Status
Centrelink Interface Status
CCB Method
Refer to addendum to this document for current production allowable values
CCB Type
CCB Recovery
Service Exempt
Preschool Indicator
CCR Method
CCR Payment Status
Version Number: 1.50 v1.0 final
Page 171 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13.3 Cancel Attendance
The Cancel Attendance Interface Function is used when a Service Provider wishes to cancel an attendance record previously submitted to
FaHCSIA through the Create Attendance Interface Function. This function will take the data submitted by the Service Provider, locate the
attendance record within the system and cancel the record. An unsuccessful match will result in an error message and no cancellation of the
attendances.
13.3.1 Cancel Attendance Request Message Data Definition
Attendance Interface - Cancel Attendance - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
Authorised Person First
Name
[AttendanceCancellation].[Auth
orisedPersonFirstName]
N
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[AttendanceCancellation].[Auth
orisedPersonLastName]
N
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised this transaction
Authorised Person Id
[AttendanceCancellation].[Auth
orisedPersonId]
N
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
CCB Approval Id
[AttendanceCancellation].[CCBA
pprovalId]
Y
String
15
N/A
1-677EP
Unique identifier of the CCB
Approval issued by FaHCSIA.
FaCSIA Enrolment Id
[AttendanceCancellation].[FaCS
IAEnrolmentId]
Y
String
15
N/A
1-C3PO
Unique identifier of enrolment
record on the FAHCSIA system.
Known internally as Enrolment
Id.
FaCSIA Attendance Id
[AttendanceCancellation].[FaCS
IAAttendanceId]
Y
String
15
N/A
1-AG47Y
Unique identifier of the
Attendance record on the
FaHCSIA system. Known
internally as Attendance Id.
Version Number: 1.50 v1.0 final
Page 172 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13.3.2 Cancel Attendance Request Data Rules
Cancel Attendance Request Data Rules
Comments
Source System must be valid system.
[FaCSIA Enrolment Id] must match an existing record on the FaHCSIA System.
[FaCSIA Attendance Id] must match an existing record on the FaHCSIA System.
Attendance records that are in the status of ‘Cancelling’ or ‘Cancelled’ cannot be cancelled.
An Attendance record cannot be cancelled twice.
Authorised Person First Name, Authorised Person Last Name and Authorised Person Id are mandatory if the registered
version of software is greater than or equal to 1.30.
13.3.3 Cancel Attendance Allowable Values – Request Message
Data Name
Values
N/A
Refer to addendum to this document for current production allowable values
Version Number: 1.50 v1.0 final
Page 173 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
13.3.4 Cancel Attendance Response Message Data Definitions
Attendance Interface - Cancel Attendance - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval Id
[CancelledAttendance].[CCBApprovalId]
String
15
N/A
1-677EP
Unique identifier of the CCB Approval
issued by FaHCSIA.
FaCSIA Enrolment Id
[CancelledAttendance].[FaCSIAEnrolment
Id]
String
15
N/A
1-POK3
Unique identifier of enrolment record
on the FAHCSIA system.
FaCSIA Attendance Id
[CancelledAttendance].[FaCSIAAttendanc
eId]
String
15
N/A
1-POLK
Unique identifier of the Attendance
record on the FaHCSIA system.
Attendance Status
[CancelledAttendance].[AttendanceStatu
s]
String
30
N/A
Cancelling
The status of the Attendance.
The Return Error for the Request
Message.
13.3.5 Cancel Attendance Allowable Values – Response Message
Data Name
Values
N/A
Refer to addendum to this document for current production allowable values
Version Number: 1.50 v1.0 final
Page 174 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
14
Appendix F – IS Case Interface
The following section provides specific information about the Query IS Case Interface.
14.1 Query IS Case
The Query IS Case Interface is used when a Service Provider wishes to query FaHCSIA for information on there IS Case records. The query will
be limited to a pre-defined list of arguments, with the combination of fields being used to construct a query. The query will be constructed using
the ‘AND’ operator to combine the query fields.
14.1.1 Query IS Case Request Message Data Definition
IS Case Interface - Query IS Case - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A234RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677EP
Unique identifier of the CCB
Approval issued by FaHCSIA.
IS Case ID
[ISCaseId]
N
String
15
N/A
1-2554R
Unique identifier of the IS
Case ID issued by FaHCSIA.
IS Start Date From
[ISStartDateFrom]
N
ISO D
10
YYYY-MM-DD
2006-03-12
The From Start Date of the IS
Case
IS Start Date To
[ISStartDateTo]
N
ISO D
10
YYYY-MM-DD
2006-05-12
The To Start Date of the IS
Case
IS End Date From
[ISEndDateFrom]
N
ISO D
10
YYYY-MM-DD
2006-04-12
The From End Date of the IS
Case
IS End Date To
[ISEndDateTo]
N
ISO D
10
YYYY-MM-DD
2006-06-12
The To End Date of the IS Case
IS End Date Empty
[ISEndDateEmpty]
N
String
1
N/A
N
If Yes, equivalent to querying
Version Number: 1.50 v1.0 final
Page 175 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
IS Case Interface - Query IS Case - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
for IS End Date = NULL.
Status
[Status]
N
String
30
N/A
Submitted
The status of the IS Case
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:S
S
2006-0612T15:12:34
Indicates that any records
updated since this date/time
stamp are required.
Page Size
[PageSize]
N
Int
-
NNN
10
Maximum number of records
returned per query
Page Number
[PageNumber]
N
Int
-
NNN
2
The page number of records to
return
14.1.2 Query IS Case Request Data Rules
Query IS Case Request Data Rules
Comments
Source System must be valid system.
Registered version of software must be greater than or equal to 1.50.
Page Size, Page Number must be greater than zero.
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size must be less than or equal to Maximum Page Size.
Refer to addendum to this document for current production value for Maximum
Page Size
Each field will only accept 1 value in the correct format.
Eg. The ‘Week Ending’ field will only accept one date in the format YYYY-MM-DD
14.1.3 Query IS Case Allowable Values – Request Message
Data Name
Values
IS Case Status
Maximum Page Size
Refer to addendum to this document for current production allowable values
Default Page Size
Version Number: 1.50 v1.0 final
Page 176 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
14.1.4 Query IS Case Response Message Data Definition
IS Case Interface - Query IS Case - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if it is the last page
returned
IS Case [Listing]
[ListOfISCases].[ISCase]
IS Case ID
[ListOfISCases].[ISCase].[ISCaseId]
String
15
N/A
1-XDRE243
The ID of a Case linked to this
Enrolment via the Child
CCB Approval Id
[ListOfISCases].[ISCase].[CCBApprovalI
d]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaCSIA. Known internally as
the Agreement Schedule Id.
IS Case Start Date
[ListOfISCases].[ISCase].[StartDate]
ISO D
10
YYYY-MMDD
2009-07-01
The Date that this Case commences
IS Case End Date
[ListOfISCases].[ISCase].[EndDate]
ISO D
10
YYYY-MMDD
2010-06-30
The Date that this Case ends.
IS Case Type
[ListOfISCases].[ISCase].[Type]
String
30
N/A
ISS
Will return the type of Case.
IS Review Date
[ListOfISCases].[ISCase].[ReviewDate]
ISO D
10
YYYY-MMDD
2010-05-30
The Date that this Case will next
receive a review
IS Case Status
[ListOfISCases].[ISCase].[Status]
String
30
N/A
Approved
The status of the IS case.
ISF First Name
[ListOfISCases].[ISCase].[ISFFirstName
]
String
50
N/A
Pauline
The first name of the Inclusion
Support Facilitator that was
responsible for helping create and
Version Number: 1.50 v1.0 final
Page 177 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
IS Case Interface - Query IS Case - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
endorsing this Case
ISF Last Name
[ListOfISCases].[ISCase].[ISFLastName]
String
50
N/A
Smith
The last name of the Inclusion
Support Facilitator that was
responsible for helping create and
endorsing this Case
IS Case Setting Name
[ListOfISCases].[ISCase].[Setting]
String
100
N/A
Wombats
The name of the setting, as
determined by the service during the
application for IS funding. Is not
validated, to be used for
information.
ISA Region
[ListOfISCases].[ISCase].[ISARegion]
String
50
N/A
Western Sydney
This will display the Region that
this Case belongs to
ISA Organisation Name
[ListOfISCases].[ISCase].[ISAOrgName]
String
100
N/A
Western Sydney
ISA
The Name of the organisation that has
endorsed the Case to the Approving
Organisation.
Allowed IS Non Face-toFace Hours
[ListOfISCases].[ISCase].[TotalISNonFa
ceToFaceHrsAllowed]
String
10
HHHHHHH:
MM
0000300:00
The total number of hours allowed for
Non Face to Face Home Based carer
time for the period of the Case.
This can be used if children are
absent but a Home Based carer was
still paid.
IS Non Face-to-Face
Hours Balance
[ListOfISCases].[ISCase].[ISNonFaceToF
aceHrsBalance]
String
10
HHHHHHH:
MM
0000010:00
The total number of Non Face-to-Face
Hours remaining for this Case during
the approval period.
Primary Home Based
Carer ID
[ListOfISCases].[ISCase].[PrimaryCarer
Id]
String
30
N/A
FGER343
The ID of the Primary Home Based
Carer, as listed on the Case
submitted by the Service.
Primary Home Based
Carer First Name
[ListOfISCases].[ISCase].[PrimaryCarer
FirstName]
String
50
N/A
Angelina
The First Name of the Primary Home
Based Carer
Primary Home Based
Carer Last Name
[ListOfISCases].[ISCase].[PrimaryCarer
LastName]
String
50
N/A
Acorn
The Last Name of the Primary Home
Based Carer
Primary Home Based
Carer Post Code
[ListOfISCases].[ISCase].[PrimaryCarer
PostCode]
String
4
NA
2134
The Post Code for the Primary Home
Based Carer
Version Number: 1.50 v1.0 final
Page 178 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
IS Case Interface - Query IS Case - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Backup 1 Home Based
Carer ID
[ListOfISCases].[ISCase].[Backup1Carer
Id]
String
30
N/A
FFWE343
The ID of Backup Home Based Carer 1,
as listed on the Case submitted by
the Service.
Backup 1 Home Based
Carer First Name
[ListOfISCases].[ISCase].[Backup1Carer
FirstName]
String
50
N/A
Bronwyn
The First Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Last Name
[ListOfISCases].[ISCase].[Backup1Carer
LastName]
String
50
N/A
Bailey
The Last Name of Backup Home Based
Carer 1
Backup 1 Home Based
Carer Post Code
[ListOfISCases].[ISCase].[Backup1Carer
PostCode]
String
4
NA
2353
The Post Code for Backup Home Based
Carer 1
Backup 2 Home Based
Carer ID
[ListOfISCases].[ISCase].[Backup2Carer
Id]
String
30
N/A
FRE465
The ID of Backup Home Based Carer 2,
as listed on the Case submitted by
the Service.
Backup 2 Home Based
Carer First Name
[ListOfISCases].[ISCase].[Backup2Carer
FirstName]
String
50
N/A
Callista
The First Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Last Name
[ListOfISCases].[ISCase].[Backup2Carer
LastName]
String
50
N/A
Crown
The Last Name of Backup Home Based
Carer 2
Backup 2 Home Based
Carer Post Code
[ListOfISCases].[ISCase].[Backup2Carer
PostCode]
String
4
NA
4532
The Post Code for Backup Home Based
Carer 2
Backup 3 Home Based
Carer ID
[ListOfISCases].[ISCase].[Backup3Carer
Id]
String
30
N/A
DFSE4533
The ID of Backup Home Based Carer 3,
as listed on the Case submitted by
the Service.
Backup 3 Home Based
Carer First Name
[ListOfISCases].[ISCase].[Backup3Carer
FirstName]
String
50
N/A
Denise
The First Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Last Name
[ListOfISCases].[ISCase].[Backup3Carer
LastName]
String
50
N/A
Drysdale
The Last Name of Backup Home Based
Carer 3
Backup 3 Home Based
Carer Post Code
[ListOfISCases].[ISCase].[Backup3Carer
PostCode]
String
4
NA
4535
The Post Code for Backup Home Based
Carer 3
IS Case.DaysOfCare
[Listing] – Care Week
[ListOfISCases].[ISCase].[ListOfDays].
[Day]
Version Number: 1.50 v1.0 final
Page 179 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
IS Case Interface - Query IS Case - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
FaHCSIA Child ID
[ListOfISCases].[ISCase].[ListOfDays].
[Day].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked to
this Enrolment, different to the
Service Provider ID, will be provided
for only the child attached to this
enrolment, will be the same as the
Child ID if the enrolment is formal,
will be provided if the enrolment is
not formal.
Day of Care
[ListOfISCases].[ISCase].[ListOfDays].
[Day].[DayOfCare]
String
30
N/A
Saturday
The Day for which the care has been
approved - from the Care Week Profile
Payment Type
[ListOfISCases].[ISCase].[ListOfDays].
[Day].[PaymentType]
String
30
N/A
ISS Regular
The Type of care that has been
approved for this day of care.
Variable Week
[ListOfISCases].[ISCase].[ListOfDays].
[Day].[VariableWeek]
String
30
N/A
??
The type of Variable Week
IS Case.CareHours
[Listing] – Profile
Summary
[ListOfISCases].[ISCase].[ListOfCareHo
urs].[CareHours]
Day of Care
[ListOfISCases].[ISCase].[ListOfCareHo
urs].[CareHours].[DayOfCare]
String
30
N/A
Saturday
The Day for which the care has been
approved – from Care Hours
Payment Type
[ListOfISCases].[ISCase].[ListOfCareHo
urs].[CareHours].[PaymentType]
String
30
N/A
ISS Regular
The Payment Rate that has been
approved for this day of care.
Maximum Hours For
Setting
[ListOfISCases].[ISCase].[ListOfCareHo
urs].[CareHours].[MaximumHrsForSetting
]
String
6
HHH:MM
008:00
The maximum number of hours that can
be claimed for all children in the
approved care environment for this
day
IS Case.Support Hours
[Listing]
[ListOfISCases].[ISCase].[ListOfSuppor
tHours].[SupportHours]
Payment Type
[ListOfISCases].[ISCase].[ListOfSuppor
tHours].[SupportHours].[PaymentType]
String
30
N/A
ISS Regular
This field will define the Payment
Rate type, ie Regular or T1 or Out Of
Home
Support Hours Period
[ListOfISCases].[ISCase].[ListOfSuppor
String
30
N/A
Weekly
This field will define over what
Profile
Version Number: 1.50 v1.0 final
Page 180 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
IS Case Interface - Query IS Case - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
tHours].[SupportHours].[Period]
Comments
period these hours apply, weekly or
total period
Support Hours
[ListOfISCases].[ISCase].[ListOfSuppor
tHours].[SupportHours].[Hours]
String
10
HHHHHHH:
MM
0000020:00
This will define the hours approved
for this type of Case for this period
Support Hours Tolerance
[ListOfISCases].[ISCase].[ListOfSuppor
tHours].[SupportHours].[Tolerance]
String
10
HHHHHHH:
MM
0000010:00
This will define the amount that a
claim can vary and be automatically
approved. Claims over the hours +
tolerance will be rejected.
Support Hours Balance
[ListOfISCases].[ISCase].[ListOfSuppor
tHours].[SupportHours].[Balance]
String
10
HHHHHHH:
MM
0000400:00
This field will define the remaining
hours available for this Payment Rate
Type for the whole period. Will be
null if Support Hours Period =
Weekly.
IS Case.Enrolments
[Listing]
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment]
FaCSIA Enrolment Id
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment].[FaCSIAEnrolment
Id]
String
15
N/A
1-POQE
Unique identifier of enrolment record
on the FACSIA system. Known
internally as Enrolment Id.
Service Provider
Enrolment Reference
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment].[ServiceProvider
EnrolmentReference]
String
50
N/A
REF000001
Unique identifier of the enrolment
record on the Service Provider
Software.
FaHCSIA Child ID
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment].[FaHCSIAChildId]
String
15
N/A
1-DRE453
The FaHCSIA ID of the child linked to
this Enrolment, different to the
Service Provider ID.
Child Service Client Id
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment].[ChildServiceCli
entId]
String
20
N/A
KRMX0001
The unique identifier of the child
issued by the Service Provider.
Child CRN
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment].[ChildCRN]
String
10
NNNNNNNN
NT
123456789T
Issued by Centrelink for the child.
Will not be provided if the Enrolment
Type is ‘Informal’.
Child Date Of Birth
[ListOfISCases].[ISCase].[ListOfISEnro
lments].[ISEnrolment].[ChildDateOfBirt
h]
ISO D
10
YYYY-MMDD
1998-03-12
The date of birth of the child.
Version Number: 1.50 v1.0 final
Page 181 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
14.1.5 Query IS Case Allowable Values – Response Message
Data Name
Values
Service Provision
Refer to addendum to this document for current production allowable values
IS Case Status
Version Number: 1.50 v1.0 final
Page 182 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
15
Appendix G – IS Case Claims Interface
The following section provides specific information about the three different Service Provider IS Case Claim Interfaces.
15.1 Create IS Case Claim
The Create IS Case Claim Interface Function is used when a Service Provider wishes to submit IS Case Claim data to FaHCSIA. This interface
will take the data submitted by the Service Provider and create IS Case Claim records on the FaHCSIA system. If validation fails, an error
message will be generated and an IS Case Claim record will not be created.
15.1.1 Create IS Case Claim Request Message Data Definition
Case Claim Interface - Create IS Case Claim - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
AHJKNMNKLHNNFD
NFLUJKLJ
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered software provider
issued by FaCSIA
CCB Approval ID
[NewISCaseClaim].[CCBApprovalId
]
Y
String
15
N/A
1-23DRW
Unique identifier of the CCB
Approval issued by FaHCSIA.
IS Case ID
[NewISCaseClaim].[ISCaseId]
Y
String
15
N/A
1-234DE
Unique identifier of the Case
issued by FaCSIA.
Service Provider IS
Case Claim Reference
[NewISCaseClaim].[ServiceProvid
erISCaseClaimReference]
Y
String
50
N/A
REF234123
Unique identifier of the IS
Case Claim record on the
Service Provider Software
Week Ending
[NewISCaseClaim].[WeekEnding]
Y
ISO D
10
YYYY-MM-DD
2010-06-30
The date that the service that
is being claimed for completed
IS Payment Type
[NewISCaseClaim].[ISPaymentType
]
Y
String
30
N/A
ISS Regular
The type of IS Payment that is
being claimed for, will be part
of a list, check addendum for
values.
Service Provision
[NewISCaseClaim].[ServiceProvis
Y
String
30
N/A
Face-to-Face
This is the method of delivery
of the claim, whether Face to
Version Number: 1.50 v1.0 final
Page 183 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Create IS Case Claim - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
ion]
Comments
Face, or Not Face to Face
Hours Claimed
[NewISCaseClaim].[HoursClaimed]
Y
String
6
HHH:MM
030:00
The hours being claimed for
this IS Payment Type
Authorised Person First
Name
[NewISCaseClaim].[AuthorisedPer
sonFirstName]
Y
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised the submission of
this transaction
Authorised Person Last
Name
[NewISCaseClaim].[AuthorisedPer
sonLastName]
Y
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised the submission of
this transaction
Authorised Person Id
[NewISCaseClaim].[AuthorisedPer
sonId]
Y
String
20
N/A
APIDA001
The unique Id of the person at
the Service Provider who
authorised the submission of
this transaction - a unique
identifier issued by the
Service
15.1.2 Create IS Case ClaimRequest Data Rules
Create IS Case Claim Request Data Rules
Comments
The following fields are mandatory for the IS Case Claim component:

[Transaction Code]

[Source System Code]

[CCB Approval Id]

[IS Case Id]

[Week Ending]

[IS Payment Type]

[Service Provision]

[Hours Claimed]

[Authorised First Name]

[Authorised Last Name]
Version Number: 1.50 v1.0 final
Page 184 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Create IS Case Claim Request Data Rules

Comments
[Authorised Person Id]
Source System must be valid system.
The combination of [CCB Approval Id] + [IS Case Id] + [Week Ending] + [IS Payment Type] + [Service Provision] must be
unique, if a resubmission is required, cancel and then resubmit.
[IS Case ID] must match a valid Approved IS Case ID, linked to an enrolment
[Week Ending] must be a Sunday
[Week Ending] must be less than or equal to system date + 6 days
[Week Ending] must be greater than (Case Start Date + 6 days) and less than or equal to Case End Date
[IS Payment Type] must be from the valid list
[IS Payment Type] must be a valid payment type on the Case.
[Service Provision] must be from the valid list
[Hours Claimed] must be greater than or equal to zero
15.1.3 Create IS Case Claim Allowable Values
Data name
Values
IS Payment Type
Service Provision
Version Number: 1.50 v1.0 final
Refer to addendum to this document for current production allowable values
Page 185 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
15.1.4 Create IS Case Claim Response Message Data Definition
Case Claim Interface - Create IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
20061030183312AH
JKNMNKLHNNFDNFLU
JKLJ
Unique identifier of the transaction.
Return Code
[ReturnCode]
Int
-
N/A
0
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval ID
[ReceivedISCaseClaim].[CCBApprovalId]
String
15
N/A
1-SF342
Unique identifier of the CCB Approval
issued by FaHCSIA.
IS Case ID
[ReceivedISCaseClaim].[ISCaseId]
String
15
N/A
1-677EP
Unique identifier of the IS Case
issued by FaCSIA.
IS Case Claim Id
[ReceivedISCaseClaim].[ISCaseClaimId]
String
15
N/A
1-6564P
Unique identifier of the IS Case
Claim issued by FaCSIA.
Service Provider IS
Case Claim Reference
[ReceivedISCaseClaim].[ServiceProvider
ISCaseClaimReference]
String
50
N/A
REF234123
Unique identifier of the IS Case
Claim record on the Service Provider
Software
Week Ending
[ReceivedISCaseClaim].[WeekEnding]
ISO D
10
YYYY-MMDD
2010-06-30
The date that the service that is
being claimed for completed
IS Payment Type
[ReceivedISCaseClaim].[ISPaymentType]
String
30
N/A
ISS Regular Hrs
The type of IS Claim that was
provided, will be part of a list,
check addendum for values.
Service Provision
[ReceivedISCaseClaim].[ServiceProvisio
n]
String
30
N/A
Face-to-Face
This is the method of delivery of the
claim, whether Face to Face, or Not
Face to Face
Hours Claimed
[ReceivedISCaseClaim].[HoursClaimed]
String
6
HHH:MM
030:00
The hours being claimed for this IS
Case Payment Type
Version Number: 1.50 v1.0 final
Page 186 of 230
The Return Code for the Request
Message.
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Create IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Hours Paid
[ReceivedISCaseClaim].[HoursPaid]
String
6
HHH:MM
030:00
The hours being paid for this IS Case
Payment Type
GST Exclusive Amount
[ReceivedISCaseClaim].[GSTExclusiveAmo
unt]
Decimal
-
N/A
30.00
The amount being paid for this IS
Case Claim, exclusive of GST
IS Case Claim Status
[ReceivedISCaseClaim].[ISCaseClaimStat
us]
String
30
N/A
Submitted
The current status of the IS Case
claim.
15.1.5 Create IS Case ClaimAllowable Values – Response Message
Data Name
Values
IS Payment Type
Service Provision
Refer to addendum to this document for current production allowable values
IS Case Claim Status
Version Number: 1.50 v1.0 final
Page 187 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
15.2 Query IS Case Claims
The Query IS Case Claims Interface is used when a Service Provider wishes to query FaHCSIA for information on there IS Case Claims records.
The query will be limited to a pre-defined list of arguments, with the combination of fields being used to construct a query. The query will be
constructed using the ‘AND’ operator to combine the query fields.
15.2.1 Query IS Case Claim Request Message Data Definition
Case Claim Interface - Query IS Case Claim - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A234RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677EP
Unique identifier of the CCB
Approval issued by FaHCSIA.
IS Case ID
[ISCaseId]
N
String
15
N/A
1-2554R
Unique identifier of the IS
Case ID issued by FaHCSIA.
IS Case Claim ID
[ISCaseClaimId]
N
String
15
N/A
1-4544R
Unique identifier of the IS
Case Claim ID issued by
FaHCSIA.
Service Provider IS Case
Claim Reference
[ServiceProviderISCaseClaimRef
erence]
N
String
50
N/A
REF234123
Unique identifier of the IS
Case Claim record on the
Service Provider Software
Week Ending
[WeekEnding]
N
ISO D
10
YYYY-MM-DD
2006-09-24
The End Date for the week
(should always be a Sunday).
Column A on the current
Statement of Child Care Usage.
IS Case Claim Status
[ISCaseClaimStatus]
N
String
30
N/A
Processed
The Status of the IS Case Claim
record.
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:S
2006-06-
Indicates that any records
updated since this date/time
Version Number: 1.50 v1.0 final
Page 188 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Query IS Case Claim - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
S
12T15:12:34
stamp are required.
Page Size
[PageSize]
N
Int
-
NNN
10
Maximum number of records
returned per query
Page Number
[PageNumber]
N
Int
-
NNN
2
The page number of records to
return
15.2.2 Query IS Case ClaimRequest Data Rules
Query IS Case Claim Request Data Rules
Comments
Source System must be valid system.
Page Size, Page Number must be greater than zero.
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size must be less than or equal to Maximum Page Size.
Refer to addendum to this document for current production value for Maximum
Page Size
Each field will only accept 1 value in the correct format.
Eg. The ‘Week Ending’ field will only accept one date in the format YYYY-MM-DD
15.2.3 Query IS Case Claim Allowable Values – Request Message
Data Name
Values
IS Case Claim Status
Maximum Page Size
Refer to addendum to this document for current production allowable values
Default Page Size
Version Number: 1.50 v1.0 final
Page 189 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
15.2.4 Query IS Case Claim Response Message Data Definition
Case Claim Interface - Query IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if it is the last page
returned
Case Claim [Listing]
[ListOfISCaseClaims].[ISCaseClaim]
CCB Approval Id
[ListOfISCaseClaims].[ISCaseClaim].[CC
BApprovalId]
String
15
N/A
1-677EP
Unique identifier of the CCB Approval
issued by FaCSIA. Known internally
Agreement Schedule Id.
IS Case ID
[ListOfISCaseClaims].[ISCaseClaim].[IS
CaseId]
String
15
N/A
1-POK3
Unique identifier of the IS Case
issued by FaCSIA.
IS Case Claim Id
[ListOfISCaseClaims].[ISCaseClaim].[IS
CaseClaimId]
String
15
N/A
1-AG47Y
Unique identifier of the IS Case
Claim issued by FaCSIA.
Service Provider IS
Case Claim Reference
[ListOfISCaseClaims].[ISCaseClaim].[Se
rviceProviderISCaseClaimReference]
String
50
N/A
REF234123
Unique identifier of the IS Case
Claim record on the Service Provider
Software
Week Ending
[ListOfISCaseClaims].[ISCaseClaim].[We
ekEnding]
ISO D
10
YYYY-MMDD
2007-06-30
The date that this claim has as its
week-ending
IS Payment Type
[ListOfISCaseClaims].[ISCaseClaim].[IS
PaymentType]
String
30
N/A
ISS Regular Hrs
The type of IS Claim that was
provided, will be part of a list,
check addendum for values.
Service Provision
[ListOfISCaseClaims].[ISCaseClaim].[Se
String
30
N/A
Face-to-Face
This is the method of delivery of the
claim, whether Face-to-Face, or Not
Version Number: 1.50 v1.0 final
Page 190 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Query IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
rviceProvision]
Comments
Face-to-Face
Hours Claimed
[ListOfISCaseClaims].[ISCaseClaim].[Ho
ursClaimed]
String
6
HHH:MM
030:00
The hours being claimed for this IS
Case Payment Type
Hours Paid
[ListOfISCaseClaims].[ISCaseClaim].[Ho
ursPaid]
String
6
HHH:MM
025:00
The amount of hours being paid for
this Case Claim.
GST Exclusive Amount
[ListOfISCaseClaims].[ISCaseClaim].[GS
TExclusiveAmount]
Decimal
-
N/A
430.00
The amount being paid for this Case
Claim, exclusive of GST.
IS Case Claim Status
[ListOfISCaseClaims].[ISCaseClaim].[IS
CaseClaimStatus]
String
30
N/A
Submitted
The status of this IS Claim, uses
FACS_CASE_CLAIM_STATUS
Create Authorised
Person First Name
[ListOfISCaseClaims].[ISCaseClaim].[Cr
eateAuthorisedPersonFirstName]
String
50
N/A
John
The first name of the person at the
Service Provider who authorised the
submission of this transaction
Create Authorised
Person Last Name
[ListOfISCaseClaims].[ISCaseClaim].[Cr
eateAuthorisedPersonLastName]
String
50
N/A
Smythe
The last name of the person at the
Service Provider who authorised the
submission of this transaction
Create Authorised
Person Id
[ListOfISCaseClaims].[ISCaseClaim].[Cr
eateAuthorisedPersonId]
Date Created
[ListOfISCaseClaims].[ISCaseClaim].[Cr
eateDate]
Cancel Authorised
Person First Name
String
20
N/A
APIDA001
The unique Id of the person at the
Service Provider who authorised the
submission of this transaction - a
unique identifier issued by the
Service
ISO D/T
19
YYYY-MMDDThh:mm
:ss
2010-0530T15:0:00
The date that the case claim was
created.
[ListOfISCaseClaims].[ISCaseClaim].[Ca
ncelAuthorisedPersonFirstName]
String
50
N/A
Terry
The first name of the person at the
Service Provider who authorised the
submission of this transaction
Cancel Authorised
Person Last Name
[ListOfISCaseClaims].[ISCaseClaim].[Ca
ncelAuthorisedPersonLastName]
String
50
N/A
Towel
The last name of the person at the
Service Provider who authorised the
submission of this transaction
Cancel Authorised
Person Id
[ListOfISCaseClaims].[ISCaseClaim].[Ca
ncelAuthorisedPersonId]
String
20
N/A
APIDA002
The unique Id of the person at the
Service Provider who authorised the
submission of this transaction - a
Version Number: 1.50 v1.0 final
Page 191 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Query IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
unique identifier issued by the
Service
Date Cancelled
[ListOfISCaseClaims].[ISCaseClaim].[Ca
ncelDate]
Payment [Listing]
[ListOfISCaseClaims].[ISCaseClaim].[ListOfP
ayments].[Payment]
ISO D/T
19
YYYY-MMDDThh:mm
:ss
2010-0630T16:00:00
The date that the IS Case Claim was
cancelled
Payment Line Item Id
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[PaymentLineIt
emId]
String
15
N/A
1-HJUI
The Payment Request Line Item Id on
the FaCSIA system. Known internally
as the Payment Request Line Item.
Clearing Number
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[ClearingNumbe
r]
String
30
N/A
18531697
The clearing number on the FaCSIA
payment system. Known internally as
the IMPACT Clearing Number on the
Payment Request Header.
Payee Id
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[PayeeId]
1-GHY8Y
The unique identifier for the
Organisation that the payment was
paid to. Known internally as the
Payee Id on the Payment Request
Header.
CCB Approval Id
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[CCBApprovalId
]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaCSIA. Known internally as
Agreement Schedule Id on the Payment
Request Header.
Date Paid
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[DatePaid]
ISO D
10
YYYY-MMDD
2006-09-21
The date the payment was made.
Returned from IMPACT. Known
internally as the Date Paid on the
Payment Request Header.
Financial Year
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[FinancialYear
]
String
10
N/A
2005-2006
The Financial Year for the Payment.
Known internally as Financial Year on
the Payment Request Header.
Invoice Number
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[InvoiceNumber
]
String
50
N/A
14831681
The document number assigned by the
FaCSIA payment system. Known
internally as IMPACT Invoice Number
on the Payment Request Header.
Version Number: 1.50 v1.0 final
String
15
Page 192 of 230
N/A
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Query IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Organisation Invoice
Number
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[OrganisationI
nvoiceNumber]
String
50
N/A
1-1QS3X
The organisation’s invoice number.
Known internally as the Organisation
Invoice Number on the Payment Request
Header.
Payment Type
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[PaymentType]
String
30
N/A
Approval Payment
The Payment Type for the Payment
Request. Known internally as the
Payment Type on the Payment Request
Line Item.
Remittance Description
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[RemittanceDes
cription]
String
250
N/A
1-HJUI Enrolment
Advance
The Remittance Description for the
Payment (Appended with information by
the IMPACT interface). Known
internally as the Remittance
Description on the Payment Request
Line Item.
Processing Date
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[ProcessingDat
e]
ISO D
10
YYYY-MMDD
2006-05-30
The date the Payment Request was
created in the FaCSIA system. Known
internally as the Processing Date on
the Payment Request Header.
GST Exclusive Amount
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[GSTExclusiveA
mount]
Decimal
-
N/A
55.55
The Amount paid for the Enrolment.
Known internally as the GST Exclusive
Amount on the Payment Request Line
Item.
N.2
-
N/A
11.12
The GST Inclusive Amount charged.
GST Inclusive Amount
[[ListOfISCaseClaims].[ISCaseClaim].[L
istOfPayments].[Payment].[GSTInclusive
Amount]
Payment or Refund
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[PaymentOrRefu
nd]
String
15
N/A
Payment
Indicates whether the Payment Request
Line Item is a payment or a refund.
Offset Indicator
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[OffsetIndicat
or]
String
1
N/A
Y
If the Payment Request Line Item is a
refund, this indicates if the amount
has been offset.
Enrolment Id
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[EnrolmentId]
String
15
N/A
1-DF1R4
The reference to the Enrolment Id on
the Payment Request Line Item.
Attendance Id
[ListOfISCaseClaims].[ISCaseClaim].[Li
String
15
N/A
1-4D5F5
The reference to the Attendance Id on
Version Number: 1.50 v1.0 final
Page 193 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Query IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
stOfPayments].[Payment].[AttendanceId]
Comments
the Payment Request Line Item.
Case ID
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[CaseId]
String
15
N/A
1-453DF
The reference to the IS Case ID on
the Payment Request Line Item.
Case Claim Id
[ListOfISCaseClaims].[ISCaseClaim].[Li
stOfPayments].[Payment].[CaseClaimId]
String
15
N/A
1-234FE
The reference to the IS Case Claim Id
on the Payment Request Line Item.
15.2.5 Query IS Case Claim Allowable Values – Response Message
Data Name
Values
IS Payment Type
Service Provision
Refer to addendum to this document for current production allowable values
IS Case Claim Status
Version Number: 1.50 v1.0 final
Page 194 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
15.3 Cancel IS Case Claim
The Cancel IS Case Claim Interface Function is used when a Service Provider wishes to cancel an IS Case Claim record previously submitted to
FaHCSIA through the Create IS Case Claim Interface Function. This function will take the data submitted by the Service Provider, locate the
IS Case Claim record within the system and cancel the record. An unsuccessful match will result in an error message and no cancellation of the
IS Case Claim.
15.3.1 Cancel IS Case Claim Request Message Data Definition
Case Claim Interface - Cancel IS Case Claim - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
AHJKNMNKLHNNFD
NFLUJKLJ
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered software provider
issued by FaCSIA.
CCB Approval Id
[ISCaseClaimCancellation].[CCB
ApprovalId]
Y
String
15
N/A
1-677EP
Unique identifier of the CCB
Approval issued by FaCSIA.
Known internally as Agreement
Schedule Id.
IS Case ID
[ISCaseClaimCancellation].[ISC
aseId]
Y
String
15
N/A
1-4542T
Unique Identifier of the Case
issued by FaHCSIA.
IS Case Claim ID
[ISCaseClaimCancellation].[ISC
aseClaimId]
Y
String
15
N/A
1-2362T
Unique Identifier of the Case
Claim issued by FaHCSIA.
Authorised Person First
Name
[ISCaseClaimCancellation].[Aut
horisedPersonFirstName]
Y
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised the submission of
this transaction
Authorised Person Last
Name
[ISCaseClaimCancellation].[Aut
horisedPersonLastName]
Y
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised the submission of
this transaction
Version Number: 1.50 v1.0 final
Page 195 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Case Claim Interface - Cancel IS Case Claim - Request Message Data Definition
Name
Authorised Person Id
Path
[ISCaseClaimCancellation].[Aut
horisedPersonId]
Mandatory
Y
Data Type
String
Length
20
Format
N/A
Sample
Comments
APIDA001
The unique Id of the person at
the Service Provider who
authorised the submission of
this transaction - a unique
identifier issued by the
Service
15.3.2 Cancel IS Case Claim Request Data Rules
Cancel Attendance Request Data Rules
Comments
Source System must be valid system.
[IS Case ID] must match an existing record on the FaHCSIA System.
[Case Claim Id] must match an existing record on the FaHCSIA System.
Version Number: 1.50 v1.0 final
Page 196 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
15.3.3 Cancel IS Case Claim Response Message Data Definitions
Case Claim Interface - Cancel IS Case Claim - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
20061030183312AH
JKNMNKLHNNFDNFLU
JKLJ
Unique identifier of the transaction.
Return Code
[ReturnCode]
Int
-
N/A
0
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval Id
[CancelledISCaseClaim].[CCBApprovalId]
String
15
N/A
1-677EP
Unique identifier of the CCB Approval
issued by FaCSIA. Known internally as
Agreement Schedule Id.
IS Case ID
[CancelledISCaseClaim].[ISCaseId]
String
15
N/A
1-R2D2
Unique identifier of IS Case record
on the FACSIA system.
IS Case Claim ID
[CancelledISCaseClaim].[ISCaseClaimId]
String
15
N/A
1-C3PO
Unique identifier of IS Case claim
record on the FACSIA system.
IS Case Claim Status
[CancelledISCaseClaim].[ISCaseClaimSta
tus]
String
30
N/A
Cancelled
The status of this IS Claim.
The Return Code for the Request
Message.
The Return Error for the Request
Message.
15.3.4 Query IS Case Claim Allowable Values – Response Message
Data Name
Values
IS Case Claim Status
Refer to addendum to this document for current production allowable values
Version Number: 1.50 v1.0 final
Page 197 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
16
Appendix H – Messages Interface
The following section provides specific information about the messages interface.
16.1 Retrieve Messages
The Service Provider Messages Interface Function is used when a Service Provider wishes to retrieve messages from FaHCSIA for a CCB
Approval. This interface will look for messages for a Service Provider that meets the defined search specifications. If messages are found, they
will be sent in the response to the provider. New messages being retrieved for the first time will be marked as delivered. If no messages that meet
the specified criteria have been found then an error message will indicate no messages.
Once messages have been marked as delivered, they are not held on FOFMS indefinitely. A batch job to delete old messages will be run
regularly to archive delivered messages that are more than a month old.
16.1.1 Retrieve Messages Request Message Data Definition
Message Interface - Retrieve Messages - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
1234
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
Unique identifier of the CCB
Approval issued by FaHCSIA.
Only New Messages
[OnlyNewMessages]
Y
Test
1
Y/N
Y
Indicates whether only new
messages (i.e. undelivered)
should be returned.
Start Date
[StartDate]
N
Date
10
YYYY-MM-DD
2006-09-25
Messages generated on or after
this date will be retrieved
End Date
[EndDate]
N
Date
10
YYYY-MM-DD
2006-09-25
Messages generated on or before
this date will be retrieved
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MM-
2006-06-
Indicates that any records
Version Number: 1.50 v1.0 final
Page 198 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Message Interface - Retrieve Messages - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
DDTHH:MM:SS
12T15:12:34
updated since this date/time
stamp are required.
Page Size
[PageSize]
N
Integer
-
NNN
10
Maximum number of records
returned per query
Page Number
[PageNumber]
N
Integer
-
NNN
2
The page number of records to
return
16.1.2 Retrieve Messages Request Data Rules
Retrieve Messages Request Data Rules
Comments
Source System must be valid system.
[CCB Approval Id] and [Source System Code] are mandatory.
Page Size, Page Number must be greater than zero.
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size must be less than or equal to Maximum Page Size.
Refer to addendum to this document for current production value for Maximum
Page Size
If the Only New Messages flag is set to Y only messages that have not been interfaced previously will be returned.
If it is set to N, all held messages would be returned.
If Start Date is provided, only messages that have been generated on or after the start date will be returned.
Start Date parameter will be provided by the Service Provider.
If End Date is provided, only messages that have been generated on or before the end date will be returned.
End Date parameter will be provided by the Service Provider.
If both Start Date and End Date are provided, Start Date must be less than or equal to End Date.
16.1.3 Retrieve Messages Allowable Values – Request Message
Data Name
Values
Maximum Page Size
Refer to addendum to this document for current production allowable values.
Default Page Size
Version Number: 1.50 v1.0 final
Page 199 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
16.1.4 Retrieve Messages Response Message Data Definition
Message Interface - Retrieve Messages - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
2006103018331212
34
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if this is the last page.
CCB Approval Id
[ListOfMessages].[Message].[CCBApprova
lId]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaHCSIA
Message Id
[ListOfMessages].[Message].[MessageId]
String
15
N/A
1-023AP
Unique identifier of the Message.
Generated
[ListOfMessages].[Message].[Generated]
Date
10
YYYY-MMDD
2006-08-20
The date the message was generated by
the system.
Source
[ListOfMessages].[Message].[Source]
String
30
N/A
Enrolment
The area within CCMS that has
generated the message.
Source Id
[ListOfMessages].[Message].[SourceId]
String
15
N/A
1-2H0XF
Id of the source that generated the
message.
Type
[ListOfMessages].[Message].[Type]
String
30
N/A
Deemed Exit
Type of message (e.g. deemed exit).
Date of Effect
[ListOfMessages].[Message].[DateOfEffe
ct]
Date
10
YYYY-MMDD
2006-08-30
The date the message will take effect
from (e.g. The date the enrolment
will be exited).
Comments
[ListOfMessages].[Message].[Comments]
String
200
N/A
Your enrolment
has been exited
Details of the message that is sent
to the Service Provider.
Version Number: 1.50 v1.0 final
Page 200 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
16.1.5 Retrieve Messages Allowable Values - Response Message
Data Name
Values
Source
Refer to addendum to this document for current production allowable values.
Type
Version Number: 1.50 v1.0 final
Page 201 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
17
Appendix I – Vacancy Interface
The Vacancy Interface section was removed in version 1.50 of the docment as it is no longer supported.
18
Appendix J – Care Provided and Vacancy Interface
The following section provides specific information about the care provided and vacancy interface.
18.1 Update Care Provided
The Service Provider Update Care Provided Interface Function is used when a Service Providersubmits or updatescare provided and vacancy
information for their CCB Approval to FaHCSIA. This interface will take the data submitted by the Service Provider and attempt to match it
with an existing record stored on the FaHCSIA system. If found, the care provided information is updated and the vacancy data provided
replaces all existing vacancy data. If the care provided and vacancy does not exist in the system the care provided and vacancy information will
be created.
18.1.1 Update Care Provided Request Message Data Definition
Care Provided and Vacancy Interface - Update Care Provided - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
AHJKNMNKLHNNFD
NFLUJKLJ
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345PF
Unique identifier of the
registered software provider
issued by FaCSIA.
Authorised Person First
Name
CareProvidedUpdate].[Authorise
dPersonFirstName]
Y
String
50
N/A
John
The first name of the person at
the Service Provider who
authorised this transaction
Authorised Person Last
Name
[CareProvidedUpdate].[Authoris
edPersonLastName]
Y
String
50
N/A
Smythe
The last name of the person at
the Service Provider who
authorised this transaction
Version Number: 1.50 v1.0 final
Page 202 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Care Provided and Vacancy Interface - Update Care Provided - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Authorised Person Id
[CareProvidedUpdate].[Authoris
edPersonId]
Y
String
20
N/A
APIDA001
The unique identifier of the
authorised person issued by the
Service Provider
CCB Approval Id
[CareProvidedUpdate].[CCBAppro
valId]
Y
String
15
N/A
1-5672Q
Unique identifier of the CCB
Approval issued by FaCSIA.
Known internally as Agreement
Schedule Id.
Service Email
[CareProvidedUpdate].[ServiceE
mail]
N
String
50
N/A
xyz@def.com.au
The email used by the Service
to received message
notifications from the CCMS and
the CCMS Helpdesk.
Week Ending
[CareProvidedUpdate].[WeekEndi
ng]
Y
ISO D
10
YYYY-MM-DD
2006-08-20
The End Date for the week
(should always be a Sunday).
Service Operational
[CareProvidedUpdate].[ServiceO
perational]
Y
String
1
N/A
Y
Flag which indicates whether
the Service is operational for
the week ending or not. This
flag determines how far in
advance the message can be
submitted.
In Home Care Vacancies
[CareProvidedUpdate].[InHomeCa
reVacancies]
N
String
1
N/A
Y
This field is used by In Home
Care Services to identify if
any vacancies exist for the
week.
Total Vacancies
[CareProvidedUpdate].[TotalVac
ancies]
Y
Integer
-
N/A
5
The number of places available
in the week
Care Provided 0 To 24
Months
[CareProvidedUpdate].[CareProv
ided0To24Months]
N
String
1
N/A
Y
Identifies whether Service
provides care for0 to 24 month
age group.
Care Provided 25 To 35
Months
[CareProvidedUpdate].[CareProv
ided25To35Months]
N
String
1
N/A
Y
Identifies whether Service
provides care for25 to 35 month
age group.
Care Provided 36 Plus
Months Not At School
[CareProvidedUpdate].[CareProv
ided36PlusMonthsNotAtSchool]
N
String
1
N/A
Y
Identifies whether Service
provides care for36 months plus
Version Number: 1.50 v1.0 final
Page 203 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Care Provided and Vacancy Interface - Update Care Provided - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
but not attendance school.
Care Provided School
Child
[CareProvidedUpdate].[CareProv
idedSchoolChild]
N
String
1
N/A
Y
Identifies whether Service
provides care for School Child
age group.
Care Provided Permanent
[CareProvidedUpdate].[CareProv
idedPermanent]
N
String
1
N/A
Y
Identifies whether Service
provides permanent care
positions
Care Provided Casual
[CareProvidedUpdate].[CareProv
idedCasual]
N
String
1
N/A
Y
Identifies whether Service
provides casual care positions
Care Provided Full Day
[CareProvidedUpdate].[CareProv
idedFullDay]
N
String
1
N/A
Y
Identifies whether Service
provides full day care
positions
Care Provided Half Day
[CareProvidedUpdate].[CareProv
idedHalfDay]
N
String
1
N/A
Y
Identifies whether Service
provides half day care
positions
Care Provided Period
Other
[CareProvidedUpdate].[CareProv
idedPeriodOther]
N
String
1
N/A
Y
Identifies whether Service
provides care positions not
already specified
List of Vacancies
[ListOfVacancies]
Vacancy Date
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyDat
e]
Y
ISO D
10
YYYY-MM-DD
2006-08-20
The Date of the vacancy within
the child care week
Vacancy Post Code
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyPos
tcode]
N
String
4
N/A
2900
The Postcode for the vacancy.
Vacancy Home Based Carer
Id
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyCar
erId]
N
String
30
NA
C000534A
The Id for a Home Based Carer.
This field is intended for
future use only and there will
be no validation of the field
initially.
Vacancy 0 To 24 Months
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[Vacancy0To
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be used by a child 0 to 24
Version Number: 1.50 v1.0 final
Page 204 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Care Provided and Vacancy Interface - Update Care Provided - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
24Months]
Comments
months
Vacancy 25 To 35Months
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[Vacancy25T
o35Months]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be used by a child 25 to 35
Months
Vacancy36PlusMonthsNotAt
School
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[Vacancy36P
lusMonthsNotAtSchool]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be used by a child 36 plus
months not attending school
Vacancy School Child
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancySch
oolChild]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be used by a school child
Vacancy Permanent
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyPer
manent]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be filled by a permanent
placement
Vacancy Casual
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyCas
ual]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be filled by a casual placement
Vacancy Full Day
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyFul
lDay]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be for a full day
Vacancy Half Day
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyHal
fDay]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be for a half day
Vacancy Period Other
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyPer
iodOther]
N
Boolean
1
N/A
Y
Indicates that the vacancy can
be for a period other than full
or half day
Vacancy Number of
Vacancies
[CareProvidedUpdate].[ListOfVa
cancies].[Vacancy].[VacancyNum
berofVacancies]
Y
Integer
-
N/A
5
The total number of vacancies
for this combination of care.
Version Number: 1.50 v1.0 final
Page 205 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
18.1.2 Update Care Provided Request Data Rules
Update Care Provided and Vacancy Interface Request Data Rules
Comments
The Source System Id must be for a valid recognised system.
Standard check for all interface messages.
CCB Approval Id (Agreement Schedule) must have been approved, i.e. the Approval Status is ‘Approved’
or ‘Varied’ or ‘Ready for Approval’ and the Approval Date is populated.
The CCB Approval Care Provided and Vacancies report must be for a period within the validity of the CCB
Approval/Agreement Schedule, i.e. the [Week Ending] date on the care provided record minus 6 days is
less than or equal to the CCB Approval End Date.
The following fields are mandatory for all Care Provided reports:

Transaction Id

Source System Code

CCB Approval Id

Week Ending

Service Operational

Authorised Person First Name

Authorised Person Last Name

Authorised Person Id.
The following combination must be unique on Care Provided:

CCB Approval Id

Week Ending.
If data is provided in the message that is not required, the message will be rejected and an error returned.
If the care provided and vacancies report is submitted to CCMS after the defined deadline, the response
message will advise the Service Provider that it was late.
This will ensure that the Service Provider is advised of the timeliness of their care
provided and vacancies reporting at the point of submission, rather than being
surprised at any possible future fine for late submission.
If Age Group Start Date is less than or equal to today and Service Type is not In Home Care, at least one
of the following must equal Y:
This is irrespective of whether the Service Provider is operational or non-operational
for the period.

Care Provided 0 To 24Months

Care Provided 25 To 35 Months

Care Provided 36 Plus Months Not At School

Care Provided SchoolChild
If Basis Effective Date is less than or equal to today and Service Type is not In Home Care, at least one of
the following must equal Y:

Care Provided Permanent

Care Provided Casual.
If Period Start Date is less than or equal to today and Service Type is not In Home Care, at least one of
Version Number: 1.50 v1.0 final
Page 206 of 230
This is irrespective of whether the Service Provider is operational or non-operational
for the period.
This is irrespective of whether the Service Provider is operational or non-operational
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Care Provided and Vacancy Interface Request Data Rules
Comments
the following must equal Y:
for the period.

Care Provided Full Day

Care Provided Half Day

Care Provided Other.
If Total Vacancies = 0, no List of Vacancies can be submitted.
Care Provided Week Ending Rules
[Week Ending] must be a Sunday.
Care Provided Service Operational Rules
If [Service Operational] = ‘N’, the ‘Advance Submission Period for Non-Operational Reporting’ will
determine how far in advance Service Providers can submit their non-operational reports. The ‘Advance
Submission Period for Non-Operational Reporting’ will vary by Service type.
Refer to addendum to this document for Advance Submission Period for NonOperational Reports.
If [Service Operational] = ‘Y’, the ‘Advance Submission Period for Vacancies Reporting’ will determine
how far in advance Service Providers can submit their care provided and vacancies reports. The
‘Advance Submission Period for Vacancies Reporting’ will vary by Service type.
Refer to addendum to this document for Advance Submission Period for Vacancies
Reporting.
If Service Operational = N, List of Vacancies cannot be submitted.
No vacancy data can be submitted by the Service for a non-operational week.
If Service Type is not In Home Care:
Refer to addendum to this document for values.

Care Provided 0 To 24 Months

Care Provided 25 To 35 Months

Care Provided 36 Plus Months Not At School

Care Provided SchoolChild
are mandatory if:
specified by Service Type
AND Age Group Effective Date is less than or equal to today
are optional if:
specified by Service Type
AND Age Group Effective Date is greater than today
else must be null.
Version Number: 1.50 v1.0 final
Page 207 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Care Provided and Vacancy Interface Request Data Rules
Comments
IfService Type is not In Home Care:
Refer to addendum to this document for values.

Care Provided Permanent

Care Provided Casual
are mandatory if:
specified by Service Type
AND Basis Effective Date is less than or equal to today
are optional if:
specified by Service Type
AND Basis Effective Date is greater than today
else must be null.
If Service Type is not In Home Care:

Care Provided Full Day

Care Provided Half Day

Care Provided Period Other
Refer to addendum to this document for values.
are mandatory if:
specified by Service Type
AND Session Period Effective Date is less than or equal to today
are optional if:
specified by Service Type
AND Session Period Effective Date is greater than today
else must be null.
If Service Type is In Home Care:

Care Provided 0 To 24 Months

Care Provided 25 To 35 Months

Care Provided 36 Plus Months Not At School

Care Provided School Child

Care Provided Permanent

Care Provided Casual

Care Provided Full Day

Care Provided Half Day
must be null.
If Service Operational = ‘Y’, and Service Type is equal to In Home Care, Total Vacancies must = 0 and List
of Vacancies cannot be submitted.
If Service Operational = ‘Y’, and Service Type is not In Home Care, and Total Vacancies = 0, List of
Vacancies cannot be submitted.
Version Number: 1.50 v1.0 final
Page 208 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Care Provided and Vacancy Interface Request Data Rules
Comments
If Service Operational = ‘Y’ and Service Type is In Home Care, the following field is mandatory:

[In Home Care Vacancies]
else must be null.
Care Provided Late Submission Rules
If the Care Provided and Vacancy records have been successfully created/updated in FOFMS, the Return
Code will be ‘0’ and the Return Message will be ‘OK’.
Refer to the Addendum for defined deadlines.
If the Care Provided and Vacancy record has been successfully create/updated in FOFMS, but after the
defined deadline for the Service Type, the Return Code will be ‘1’ and the Return Message will be ‘Care
Provided and Vacancy Report Late Submission’.
‘Lateness’ is based on the initial submission for the Week Ending irrespective of
subsequent updates.
Care Provided data cannot be created or updated for a week that has passed, i.e. [Week Ending] is less
than current system date.
List of Vacancies Rules
Vacancy Number of Vacancies must be greater than zero
If Care Provided Total Vacancies is greater than zero, Care Provided Total Vacancies must equal the sum
of all Vacancy Number of Vacancies.
[VacancyDate] must be less than or equal to [Week Ending] and greater than or equal to the ([Week
Ending] minus 6 days).
[VacancyDate] must be less than or equal to CCB Approval End Date
The combination of the following:

Date

Post Code

Carer Id

0 To 24 Months

25 To 35 Months

36 Plus Months Not At School

School

Permanent

Casual

Full Day

Half Day

Other
must be unique.
Post Code is mandatory if required by the service type.
Version Number: 1.50 v1.0 final
This is required for In Home Care, Family Day Care.
Page 209 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Care Provided and Vacancy Interface Request Data Rules
Comments
Carer Id is mandatory if required by the service type.
In the future this will be required for In home Care, Family Day Care, however this is
not mandatory at this stage.
If Care Provided 0 To 24 Months = Nor null, Vacancy 0 To 24 Months must be null
Else if Care Provided 0 To 24 Months = Y, Vacancy 0 To 24 Months must be Y or N
If Care Provided 25 To 35 Months = Nor null, Vacancy 25 To 35 Months must be null
Else if Care Provided 25 To 35 Months = Y, Vacancy 25 To 35 Months must be Y or N
If Care Provided 36 Plus Months Not At School = Nor null, Vacancy 36 Plus Months Not At School must
be null
Else if Care Provided 36 Plus Months Not At School = Y, Vacancy 36 Plus Months Not At Schoolmust be
Y or N
If Care Provided SchoolChild = Nor null, Vacancy School Child must be null
Else if Care Provided School Child = Y, Vacancy School Child must be Y or N
If Care Provided Permanent = Nor null, Vacancy Permanent must be null
Else if Care Provided Permanent = Y, Vacancy Permanent must be Y or N
If Care Provided Casual = Nor null, Vacancy Casual must be null
Else if Care Provided Casual = Y, Vacancy Casual must be Y or N
If Care Provided Full Day = Nor null, Vacancy Full Day must be null
Else if Care Provided Full Day = Y, Vacancy Full Day must be Y or N
If Care Provided Half Day = Nor null, Vacancy Half Day must be null
Else if Care Provided Half Day = Y, Vacancy Half Day must be Y or N
If Care Provided Period Other = Nor null, Vacancy Period Other must be null
Else if Care Provided Period Other = Y, Vacancy Period Other must be Y or N
Vacancy Number of Vacancies must be less than or equal to Max Vacancies Per Item
Refer to addendum to this document for current production value for Max Vacancies
Per Item
At least one of the following must equal Y:

Vacancy 0 To 24 Months

Vacancy 25 To 35 Months

Vacancy Preschool

Vacancies School
At least one of the following must equal Y:

Vacancy Permanent

Vacancy Casual
At least one of the following must equal Y:
Version Number: 1.50 v1.0 final
Page 210 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Update Care Provided and Vacancy Interface Request Data Rules

Vacancy Full Day

Vacancy Half Day

Vacancy Other
Comments
18.1.3 Update Care Provided Allowable Values – Request Message
Data Name
Values
Service Operational
In Home Care Vacancies
Care Provided 0 To 24 Months
Care Provided 25 To 35 Months
Care Provided 36 Plus Months Not At School
Care Provided SchoolChild
Care Provided Permanent
Care Provided Casual
Care Provided Full Day
Care Provided Half Day
Care Provided Period Other
Refer to addendum to this document for current production allowable values
[List of Vacancies] 0 To 24 Months
[List of Vacancies] 25 To 35 Months
[List of Vacancies] Preschool
[List of Vacancies] School
[List of Vacancies] Permanent
[List of Vacancies] Full Day
[List of Vacancies] Half Day
[List of Vacancies] Period Other
Advance Submission Period for Non-Operational Reporting
Deadline
Maximum Daily Vacancies Allowed
Version Number: 1.50 v1.0 final
Page 211 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
18.1.4 Update Care Provided Response Message Data Definition
Care Provided and Vacancy Interface - Update Care Provided - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
String
36
N/A
20061030183312AH
JKNMNKLHNNFDNFLU
JKLJ
Unique identifier of the transaction.
Return Code
[ReturnCode]
Integer
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
CCB Approval Id
[CareProvided].[CCBApprovalId]
String
15
N/A
1-5672Q
Unique identifier of the CCB Approval
issued by FaHCSIA.
Week Ending
[CareProvided].[WeekEnding]
Date
10
YYYY-MMDD
2006-08-20
The End Date for the week (should
always be a Sunday).
Care Provided Report Id
[CareProvided].[CareProvidedReportId]
String
15
N/A
1-YH54R
The unique identifier for the newly
created/updated vacancies report
issued by FaHCSIA.
Time of Submission
[CareProvided].[TimeOfSubmission]
DateTime
19
YYYY-MMDDTHH:MM
:SS
2006-0304T16:30:32
The time of the submission.
Version Number: 1.50 v1.0 final
Page 212 of 230
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
19
Appendix K – Remittance Interface
The following section provides specific information about the remittance interface.
19.1 Query Remittance by Payee
The Query Remittance by Payee Interface is used when the Payee for a Service Provider wishes to query CCMS for information on the
individual payment requests that made up a remittance deposited into their bank based on the Remittance Advice/Clearing Number they have
received. This interface allows for the possibility of a Payee querying for records across potentially multiple CCB Approval Ids as well as other
Programs. Other query arguments are also available for shaping Payment Request Line Item queries. Queries will be constructed using the
‘AND’ operator to combine the query arguments.
19.1.1 Query Remittance by Payee Request Message Data Definition
Remittance Interface - Query Remittance by Payee - Request Message Data Definition
Name
Path
Transaction Id
[TransactionId]
Source System Code
Data Type
Length
Format
Sample
Comments
Y
String
36
N/A
20061030183312
AHJKNMNKLHNNFD
NFLUJKLJ
Unique identifier of the
transaction.
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
Clearing Number
[ClearingNumber]
N
String
30
N/A
18531697
The clearing number on the
FaHCSIA payment system.
CCB Approval Id
[CCBApprovalId]
N
String
15
N/A
1-677ZP
The unique identifier for the
Service Provider.
Date Paid From
[DatePaidFrom]
N
Date
10
YYYY-MM-DD
2006-05-01
The start date of the period
for which Payment Requests are
required.
Date Paid To
[DatePaidTo]
N
Date
10
YYYY-MM-DD
2006-05-31
The end date of the period for
which Payment Requests are
required.
Version Number: 1.50 v1.0 final
Mandatory
Page 213 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Remittance Interface - Query Remittance by Payee - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:S
S
2006-0501T14:45:06
A date/time stamp point for any
updates.
Payment Line Item
[PaymentLineItemId]
N
String
15
N/A
1-HJUI
The Payment Request Line Item
Id on the FaHCSIA system.
Enrolment Id
[EnrolmentId]
N
String
15
N/A
1-DF1R4
The reference to the Enrolment
Id on the Payment Request Line
Item.
Attendance Id
[AttendanceId]
N
String
15
N/A
1-4D5F5
The reference to the Attendance
Id on the Payment Request Line
Item.
Page Size
[PageSize]
N
Integer
-
NNN
10
Maximum number of records
returned.
Page Number
[PageNumber]
N
Integer
-
NNN
1
The page number of records to
return.
19.1.2 Query Remittance by Payee Request Data Rules
Query Remittance by Payee Request Data Rules
Comments
Source System must be valid system.
Page Size, Page Number must be greater than zero.
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size must be less than or equal to Maximum Page Size.
Refer to addendum to this document for current production value for Maximum
Page Size
Each field will only accept 1 value in the correct format.
Eg. The ‘Date Paid’ field will only accept 1 date in the format YYYY-MM-DD
Version Number: 1.50 v1.0 final
Page 214 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
19.1.3 Query Remittance by Payee Allowable Values – Request Message
Data Name
Values
Maximum Page Size
Refer to addendum to this document for current production allowable values
Default Page Size
19.1.4 Query Remittance by Payee Response Message Data Definition
Remittance Interface - Query Remittance by Payee - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
[TransactionId]
String
36
N/A
20061030183312AH
JKNMNKLHNNFDNFLU
JKLJ
Unique identifier of the transaction.
Transaction Id
Return Code
[ReturnCode]
Integer
-
N/A
0
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if it is the last page
returned
Payments [Listing]
[ListOfPayments].[Payment]
Payment Line Item Id
[ListOfPayments].[Payment].[PaymentLin
eItemId]
String
15
N/A
1-HJUI
The Payment Request Line Item Id on
the FaHCSIA system.
Clearing Number
[ListOfPayments].[Payment].[ClearingNu
mber]
String
30
N/A
18531697
The clearing number on the FaHCSIA
payment system.
Payee Id
[ListOfPayments].[Payment].[PayeeId]
String
15
N/A
1-GHY8Y
The unique identifier for the
Organisation that the payment was
paid to.
CCB Approval Id
[ListOfPayments].[Payment].[CCBApprova
lId]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaHCSIA.
Version Number: 1.50 v1.0 final
Page 215 of 230
The Return Code for the Request
Message.
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Remittance Interface - Query Remittance by Payee - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Date Paid
[ListOfPayments].[Payment].[DatePaid]
Date
10
YYYY-MMDD
2006-09-21
The date the payment was made.
Financial Year
[ListOfPayments].[Payment].[FinancialY
ear]
String
10
N/A
2005-2006
The Financial Year for the Payment.
Invoice Number
[ListOfPayments].[Payment].[InvoiceNum
ber]
String
50
N/A
14831681
The document number assigned by the
FaHCSIA payment system.
Organisation Invoice
Number
[ListOfPayments].[Payment].[Organisati
onInvoiceNumber]
String
50
N/A
1-1QS3X
The organisation’s invoice number.
Payment Type
[ListOfPayments].[Payment].[PaymentTyp
e]
String
30
N/A
Approval Payment
The Payment Type for the Payment
Request.
Remittance Description
[ListOfPayments].[Payment].[Remittance
Description]
String
250
N/A
1-HJUI Enrolment
Advance
The Remittance Description for the
Payment.
Processing Date
[ListOfPayments].[Payment].[Processing
Date]
Date
10
YYYY-MMDD
2006-05-30
The date the Payment Request was
created in the FaHCSIA system.
GST Exclusive Amount
[ListOfPayments].[Payment].[GSTExclusi
veAmount]
Decimal
-
N/A
55.55
The Amount paid for the Enrolment.
GST Inclusive Amount
[ListOfPayments].[Payment].[GSTInclusi
veAmount]
Decimal
-
N/A
61.11
This is the GST Inclusive Amount on
the Payment Request Line Item.
GST Code
[ListOfPayments].[Payment].[GSTCode]
String
30
N/A
Tax Free (0%)
This is the GST Code on the Payment
Request Line Item.
Payment or Refund
[ListOfPayments].[Payment].[PaymentOrR
efund]
String
15
N/A
Payment
Indicates whether the Payment Request
Line Item is a payment or a refund.
Offset Indicator
[ListOfPayments].[Payment].[OffsetIndi
cator]
String
1
N/A
Y
If the Payment Request Line Item is a
refund, this indicates if the amount
has been offset.
Enrolment Id
[ListOfPayments].[Payment].[EnrolmentI
d]
String
15
N/A
1-DF1R4
The reference to the Enrolment Id on
the Payment Request Line Item.
Attendance Id
[ListOfPayments].[Payment].[Attendance
String
15
N/A
1-4D5F5
The reference to the Attendance Id on
Version Number: 1.50 v1.0 final
Page 216 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Remittance Interface - Query Remittance by Payee - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Id]
Comments
the Payment Request Line Item.
Case Id
[ListOfPayments].[Payment].[CaseId]
String
15
N/A
1-453DF
The reference to the Case Id on the
Payment Request Line Item.
Case Claim Id
[ListOfPayments].[Payment].[CaseClaimI
d]
String
15
N/A
1-234FE
The reference to the Case Claim Id on
the Payment Request Line Item.
Version Number: 1.50 v1.0 final
Page 217 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
19.2 Query Payments for CCB Approval
The Query Payments for CCB Approval Id Interface is used when the Service Provider wishes to query CCMS for information on the payment
requests for a specific CCB Approval Id. The query will be limited to a pre-defined list of arguments, with the combination of fields being used
to construct a query. The query will be constructed using the ‘AND’ operator to combine the query fields.
19.2.1 Query Payments for CCB Approval Request Message Data Definition
Remittance Interface - Query Payments for CCB Approval - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Transaction Id
[TransactionId]
Y
String
36
N/A
20061030183312
AHJKNMNKLHNNFD
NFLUJKLJ
Unique identifier of the
transaction.
Source System Code
[SourceSystemCode]
Y
String
15
N/A
A2345RD
Unique identifier of the
registered Software Provider
issued by FaHCSIA.
CCB Approval Id
[CCBApprovalId]
Y
String
15
N/A
1-677ZP
The unique identifier for the
Service Provider.
Date Paid From
[DatePaidFrom]
N
Date
10
YYYY-MM-DD
2006-05-01
The start date of the period
for which Payment Requests are
required.
Date Paid To
[DatePaidTo]
N
Date
10
YYYY-MM-DD
2006-05-31
The end date of the period for
which Payment Requests are
required.
Updated Since
[UpdatedSince]
N
DateTime
19
YYYY-MMDDTHH:MM:SS
2006-0501T14:45:06
A date/time stamp point for any
updates.
Clearing Number
[ClearingNumber]
N
String
30
N/A
18531697
The clearing number on the
FaHCSIA payment system.
Payment Line Item
[PaymentLineItemId]
N
String
15
N/A
1-HJUI
The Payment Request Line Item
Id on the FaHCSIA system.
Enrolment Id
[EnrolmentId]
N
String
15
N/A
1-DF1R4
The reference to the Enrolment
Id on the Payment Request Line
Item.
Version Number: 1.50 v1.0 final
Page 218 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Remittance Interface - Query Payments for CCB Approval - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Attendance Id
[AttendanceId]
N
String
15
N/A
1-4D5F5
The reference to the Attendance
Id on the Payment Request Line
Item.
Page Size
[PageSize]
N
Integer
-
NNN
10
Maximum number of records
returned.
Page Number
[PageNumber]
N
Integer
-
NNN
1
The page number of records to
return.
19.2.2 Query Payments for CCB Approval Request Data Rules
Query Payments for CCB Approval Request Data Rules
Comments
Source System must be valid system.
Page Size, Page Number must be greater than zero.
If no Page Size or Page Number are specified, or the specified Page Size
exceeds the Maximum Page Size, the FaHCSIA system default values will be
used instead rather than rejecting the request with an error message.
Page Size must be less than or equal to Maximum Page Size.
Each field will only accept 1 value in the correct format.
Eg. The ‘Date Paid’ field will only accept 1 date in the format YYYY-MM-DD
19.2.3 Query Payments for CCB Approval Allowable Values – Request Message
Data Name
Values
Maximum Page Size
Refer to addendum to this document for current production allowable values
Default Page Size
Version Number: 1.50 v1.0 final
Page 219 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
19.2.4 Query Payments for CCB Approval Response Message Data Definition
Remittance Interface - Query Payments for CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
[TransactionId]
String
36
N/A
20061030183312AH
JKNMNKLHNNFDNFLU
JKLJ
Unique identifier of the transaction.
Transaction Id
Return Code
[ReturnCode]
Integer
-
N/A
0
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
OK
The Return Message for the Request
Message.
Last Page
[LastPage]
String
30
true/fal
se
true
Indicates if it is the last page
returned
Payments [Listing]
[ListOfPayments].[Payment]
Payment Line Item Id
[ListOfPayments].[Payment].[PaymentLin
eItemId]
String
15
N/A
1-HJUI
The Payment Request Line Item Id on
the FaHCSIA system.
Clearing Number
[ListOfPayments].[Payment].[ClearingNu
mber]
String
30
N/A
18531697
The clearing number on the FaHCSIA
payment system.
Payee Id
[ListOfPayments].[Payment].[PayeeId]
String
15
N/A
1-GHY8Y
The unique identifier for the
Organisation that the payment was
paid to.
CCB Approval Id
[ListOfPayments].[Payment].[CCBApprova
lId]
String
15
N/A
1-677ZP
Unique identifier of the CCB Approval
issued by FaHCSIA.
Date Paid
[ListOfPayments].[Payment].[DatePaid]
Date
10
YYYY-MMDD
2006-09-21
The date the payment was made.
Financial Year
[ListOfPayments].[Payment].[FinancialY
ear]
String
10
N/A
2005-2006
The Financial Year for the Payment.
Invoice Number
[ListOfPayments].[Payment].[InvoiceNum
String
50
N/A
14831681
The document number assigned by the
Version Number: 1.50 v1.0 final
Page 220 of 230
The Return Code for the Request
Message.
The Return Error for the Request
Message.
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Remittance Interface - Query Payments for CCB Approval - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
ber]
Comments
FaHCSIA payment system.
Organisation Invoice
Number
[ListOfPayments].[Payment].[Organisati
onInvoiceNumber]
String
50
N/A
1-1QS3X
The organisation’s invoice number.
Payment Type
[ListOfPayments].[Payment].[PaymentTyp
e]
String
30
N/A
Approval Payment
The Payment Type for the Payment
Request.
Remittance Description
[ListOfPayments].[Payment].[Remittance
Description]
String
250
N/A
1-HJUI Enrolment
Advance
The Remittance Description for the
Payment
Processing Date
[ListOfPayments].[Payment].[Processing
Date]
Date
10
YYYY-MMDD
2006-05-30
The date the Payment Request was
created in the FaHCSIA system.
GST Exclusive Amount
[ListOfPayments].[Payment].[GSTExclusi
veAmount]
Decimal
-
N/A
55.55
The Amount paid for the Enrolment.
GST Inclusive Amount
[ListOfPayments].[Payment].[GSTInclusi
veAmount]
Decimal
-
N/A
61.11
This is the GST Inclusive Amount on
the Payment Request Line Item.
GST Code
[ListOfPayments].[Payment].[GSTCode]
String
30
N/A
Tax Free (0%)
This is the GST Code on the Payment
Request Line Item.
Payment or Refund
[ListOfPayments].[Payment].[PaymentOrR
efund]
String
15
N/A
Payment
Indicates whether the Payment Request
Line Item is a payment or a refund.
Offset Indicator
[ListOfPayments].[Payment].[OffsetIndi
cator]
String
1
N/A
Y
If the Payment Request Line Item is a
refund, this indicates if the amount
has been offset.
Enrolment Id
[ListOfPayments].[Payment].[EnrolmentI
d]
String
15
N/A
1-DF1R4
The reference to the Enrolment Id on
the Payment Request Line Item.
Attendance Id
[ListOfPayments].[Payment].[Attendance
Id]
String
15
N/A
1-4D5F5
The reference to the Attendance Id on
the Payment Request Line Item.
Case Id
[ListOfPayments].[Payment].[CaseId]
String
15
N/A
1-453DF
The reference to the Case Id on the
Payment Request Line Item.
Case Claim Id
[ListOfPayments].[Payment].[CaseClaimI
d]
String
15
N/A
1-234FE
The reference to the Case Claim Id on
the Payment Request Line Item.
Version Number: 1.50 v1.0 final
Page 221 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
20
Appendix L – Diagnostic Interface
The following section provides specific information about the diagnostic interface.
20.1 Ping Interface
The Ping Interface Function is a diagnostic interface that can be used to test connectivity and authentication with the CCMS system. The intent
of the interface is to assist in the testing and diagnosis of connection and authentication issues.
From version 1.50, the Source System code and the Agreement Schedule ID are both mandatory fields.
20.1.1 Ping Interface Request Message Data Definition
Diagnostic Interface - Ping Interface - Request Message Data Definition
Name
Path
Mandatory
Data Type
Length
Format
Sample
Comments
Ping Request
[PingRequest]
N
String
SourceSystemCode
[SourceSystemCode]
Y
String
15
TEST1
Unique identifier of the
registered software provider
issued by FaCSIA - OPTIONAL
AgreementScheduleId
[AgreementScheduleId]
Y
String
15
1-XYZ-1234
Unique identifier of the CCB
Approval issued by DEEWR OPTIONAL
Redundant field.
20.1.2 Ping Interface Request Data Rules
Not Applicable.
Version Number: 1.50 v1.0 final
Page 222 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
20.1.3 Ping Interface Response Message Data Definition
Diagnostic Interface - Ping Interface - Response Message Data Definition
Name
Path
Data Type
Length
Format
Sample
Comments
Return Code
[ReturnCode]
Int
-
N/A
0
The Return Code for the Request
Message.
Return Error
[ReturnError]
String
75
N/A
Return Message
[ReturnMessage]
String
250
N/A
Ping Request
[PingRequest]
String
SourceSystemCode
[SourceSystemCode]
String
AgreementScheduleId
[AgreementScheduleId]
String
Version Number: 1.50 v1.0 final
The Return Error for the Request
Message.
OK
Return Message for Request Message.
2008-0915T12:09:11
Current date and time on FaHCSIA’s
server
15
Y
A yes or no response. Where “Y” is a
valid Source System Code. and “N” is
an invalid Source System Code.
15
Y
A yes or no response. Where “Y” is a
valid Agreement Schedule. and “N” is
an invalid Agreement Schedule.
Page 223 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
21
Appendix M – Summing and Counting Rules for Attendance
Refer to addendum to this document for current production summing and counting rules for Attendance.
Version Number: 1.50 v1.0 final
Page 224 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
22
Appendix N – Data Model
Vendor
CCB Approval
Inclusion Support
Plan
Parent Guardian
(Client)
Child
(Client)
CCB Eligiblity
Inclusion Support
Case
All Personnel
Fee Header
Care Provided
Fee Line Items
Vacancy
Accreditations
Places
Operational Profile
Operating Hours
Inclusion Support
Case Claim
Enrolment
Payment
JFA Eligibility
Attendance
Child Care Management System Data Model
Session
Version 0.10
Version Number: 1.50 v1.0 final
Page 225 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
23
Appendix O – Document Change History
The following table outlines changes made to the document.
23.1 Changes from Version 1.40 to 1.50 Draft v0.01
No.
Change Details
1.
Updated descriptions for Child First Name and Child last Name on Query Enrolment.
2.
Update document to include IS Case Status in outbound Enrolment interfaces.
3.
Include additional Inclusion Support rules.
4.
Return GST Inclusive Amounts.
5.
New Query IS Cases interface.
6.
New Query CCB Approval interface.
7.
New Update Profile interface.
8.
New Update All Personnel interface.
9.
New Update Fees interface.
10.
Update CCMS Data Model.
11.
Remove Vacancy Interface.
12.
Remove XML example messages. These will now be provided separately.
13.
Change label references from Carer to Home Based Carer (no updates to XML tags)
14.
New rule that Enrolment Start Date must be before the CCB Approval End Date.
23.2 Changes from Version 1.50 Draft v0.01 to Draft v0.02
No.
Change Details
1.
Correct “Mandatory within Combination” rule to refer to Service Type, rather than Age Group/Period.
2.
Correct rules for Nappies and Meals to refer to Service Type only.
3.
Correct XML tags
4.
New rules to ensure at least one record is submitted in the list of All Personnel, All Fees and Operational
Profile in the update requests.
5.
Change definition of Open and Close times in Operational Profile to String and 24 hour format
6.
Remove Clear Service Phone Number option.
7.
Return both business and postal address for the Service in the CCB Approval Query response.
8.
Return Reject Reason with Status
9.
New rule to prevent an authorised or key person from removing their own authorisation status
10.
New parameter on CCB Approval query to return Profile History
Version Number: 1.50 v1.0 final
Page 226 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
No.
Change Details
11.
New rule to ensure Enrolment Start Dates must fall with the CCB Approval Start and End Dates
12.
Source Code and CCB Approval are now mandatory on the request message for the Diagnostic interface.
13.
Correct all existing Data Type definitions from Text to String
NOTE: these changes are not highlighted in yellow throughout the document as the WSDLs already reflect
the correct Data Type reference.
14.
Add reference to addendum which now includes list of known SOAP faults.
15.
Rename “Educational Program” to “Educational Programs”
16.
Use [UpdateProfile] and [Profile] tags consistently for Fee Sets
17.
Update rules for All Personnel Request Data
23.3 Changes from Version 1.50 Draft v0.02 to Draft v0.03
No.
Change Details
1.
Changes to tag names.
23.4 Changes from Version 1.50 Draft v0.03 to Draft v0.04
No.
Change Details
1.
Change field types for:

Pending Closure Date

Accreditation Issued Date

Accreditation End Date

Accreditation Last Updated Date.
2.
Updated definition of address on personnel for Home Based Carer.
3.
Update Data Model to include Organisation.
4.
New explicit business rule that the start and end date for personnel cannot both be provided when the
person does not exist in CCMS.
5.
Remove left over business rule relating to Clear Service Phone Number (field removed in version 1.50.2).
6.
Clarify references to Organisation and Service Provider.
7.
Remove Carer Status from inbound message on Update Personnel.
8.
Correct format from Time to String for Open and Close in response to Update Profile.
9.
Update example for phone number fields as they will be returned with a +61 prefix (default country code) if
not supplied on the inbound message.
10.
Update [Profile] Postal and Business address tags – Building, Street and Suburb.
11.
Change to the description of the Diagnostic interface.
12.
Correct references from Mon.-Sun and Mon.-Fri to Mon.-Sun. and Mon.-Fri. respectively.
Version Number: 1.50 v1.0 final
Page 227 of 230
Revision Date: 13/12/2012
FaHCSIA
CCMS – Service Provider Interface Technical Specifications
No.
Change Details
13.
Update Diagnostic descriptions and field definitions to match WSDLs.
14.
Query CCB Approval - Update XML tag Fee Detail Row Id.
15.
Update Fees - Update XML tag Last Updated to Last Updated On.
16.
Include FaHCSIA Child Id in IS Case Query list of enrolments.
23.5 Changes from Version 1.50 Draft v0.04 to Draft v0.05
No.
Change Details
1.
Update Diagnostic Interface to match existing WSDL.
2.
Update description for Query Remittance by Payee Id.
3.
Remove reference to the list of Known SOAP Faults in the Addendum to this document.
4.
Weeks Open Per Year must be a whole number >= 0 and <= 52
5.
Change tag name for Additional Comments for Publication in Update Fees outbound message to match
WSDL.
23.6 Changes from Version 1.50 Draft v0.05 to Draft v0.06
No.
Change Details
1.
Clarify rules for submission of update transactions for Authorised Person Id.
2.
Update Allowable Values for CCB Approval, Operational Status and Places in Addendum
23.7 Changes from Version 1.50 Draft v0.06 to Draft v0.07
No.
Change Details
1.
Allow Authorised Person to update their own SP Personnel Id
2.
Change length of Status to 30 characters in Update Profile Response Message, which matches the length in
the update WSDL.
Note: length of Status in Query CCB Approval Response Message Data Definition should also be 30
characters (not 10) – but this will need to be resolved in a future release because the query WSDL also has
the incorrect length and needs to be modified.
Version Number: 1.50 v1.0 final
Page 228 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Appendix P – Special Characters
The following characters are tested and can be used in data submitted via the CCMS
Service Provider Interface:
Char ANSI Number
0
1
2
3
4
5
6
7
8
9
!
#
$
%
&
.
/
:
;
?
@
\
_
`
{
|
}
+
A
a
B
b
C
c
D
d
E
e
F
f
G
g
H
h
I
i
J
j
K
k
L
48
49
50
51
52
53
54
55
56
57
45
33
35
36
37
38
46
47
58
59
63
64
92
95
96
123
124
125
43
65
97
66
98
67
99
68
100
69
101
70
102
71
103
72
104
73
105
74
106
75
107
76
Version Number: 1.50 v1.0 final
Usage in CCMS
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
Page 229 of 230
Revision Date: 13/12/2012
CCMS – Service Provider Interface Technical Specifications
FaHCSIA
Char ANSI Number
l
M
m
N
n
O
o
P
p
Q
q
R
r
S
s
T
t
U
u
V
v
W
w
X
x
Y
y
Z
z
Usage in CCMS
108
77
109
78
110
79
111
80
112
81
113
82
114
83
115
84
116
85
117
86
118
87
119
88
120
89
121
90
122
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
The following characters cannot be used in data submitted via the CCMS Service
Provider Interface:
Char ANSI Number
'
"
(
)
*
,
[
]
^
~
<
=
>
39
34
40
41
42
44
91
93
94
126
60
61
62
Usage in CCMS
Do
Do
Do
Do
Do
Do
Do
Do
Do
Do
Do
Do
Do
not
not
not
not
not
not
not
not
not
not
not
not
not
use
use
use
use
use
use
use
use
use
use
use
use
use
Any characters not referred to in the above lists have not been tested and therefore are
not recommended for use in data submitted via the CCMS Service Provider Interface.
Version Number: 1.50 v1.0 final
Page 230 of 230
Revision Date: 13/12/2012