Community Care Access Centre (CCAC)
Equipment and Supplies Requisition Request Format Specification
Organization: / Ontario Association of Community Care Access Centres (OACCAC)Division: / Business Solutions
Version: / 3.0
Schema Version: / 1.0
Version Date: / March 26, 2014
Prepared By: / Ted Jin
Updated By:
Date: April 10, 2014 1
Community Care Access Centre (CCAC) / Version: 1.0Provider Report Format Specification / Version Date: August 26, 2010
Revision Log
Version No. / Version Date / Summary of Change / Changed by/Input from /0.1 / January 15, 2014 / Initial draft / Ted Jin
1.0 / January 28, 2014 / Published as v1.0 / Ted Jin
TFS# 159556
2.0 / January 30, 2014 / Section 3.1 – added the following elements:
· RequisitionNumber
· RequisitionStatusCode
· RequisitionStatus / Ted Jin
TFS# 160623
3.0 / March 25, 2014 / Section 2.1 – updated ProviderContactNumber field to only accept the phone number containing exact 10 digits / Ted Jin
TFS# 167593
Table of Contents
1 High Level Message Flow 4
1.1 Overview 4
1.2 High Level Message Flow 4
2 Add Equipment and Supplies Requisition Request Elements (version 1.0) 6
2.1 Add Equipment and Supplies Requisition Request 6
2.2 Sender and Destination 10
2.2.1 Owner Organization 11
3 Add Equipment and Supplies Requisition Response Elements (version 1.0) 13
3.1 Add Equipment and Supplies Requisition Response 13
4 Appendix 15
4.1 Business Error Messages 15
1 High Level Message Flow
This document defines the types of messages that will be exchanged between the Providers and CCACs to facilitate the provider systems submitting an Equipment and Supplies (E&S) Requisition order.
1.1 Overview
An authorized service provider can submit an Add Equipment and Supplies Requisition Request message to the CCAC. After the successful submission, the requisition is saved to the CCAC system.
1.2 High Level Message Flow
The message exchange between the provider and the CCAC system is initiatied by the provider system submitting an Add Equipment and Supplies Requisition Request message.
Upon receiving the message, the CCAC system conducts the following mandatory validations:
· The provider is authorized to submit the request
· All the required fields are provided
· All the supplied fields comply with the schema definition
· The supplied Service Assignment Guid must exist and represent an active Provider Assignment in the CCAC system
· The supplied delivery/pickup date must not be in the past
· If the delivery method is pickup at CCAC depot, the supplied CCAC depot GUID must represent an active CCAC depot in the CCAC system
· If a delivery address is supplied in the requisition, it must comply with Canada Post’s standard format
· Each submitted Master Catalogue Item Guid must represent a master catalogue item that is currently active in the CCAC system
· Each submitted Master Catalogue Item Guid must represent a master catalogue item that is currently related to at least one active vendor contract in the CCAC system
· Each submitted Master Catalogue Item Guid must represent a master catalogue item that is configured as “Orderable by Provider” in the CCAC system
· If the submitted line item is of “Purchase” type, the corresponding Master Catalogue Item Guid must not repeat in the requisition
· If the submitted line item is of “Rental” type, the quantity must be equal to 1
· The submitted line item quantity must be greater than 0
The system returns an error message in the response should the request fails any of the validation rules (see Error Messages).
If the request validation succeeds, the CCAC system processes the message, saves the requisition to the internal database, and returns a unique CCAC requisition identifer in the response message.
All the steps above are executed synchronously by the CCAC system.
2 Add Equipment and Supplies Requisition Request Elements (version 1.0)
2.1 Add Equipment and Supplies Requisition Request
The following is a top level (root) view of the Add Equipment and Supplies Requisition Request message and its main components.
Name / Field Length (bytes) / Type / Mandatory? / Description /MessageTrackingId / 36 / Alpha / Num (GUID) / Yes / A unique identifier of the message that can be used for message tracking.
Note: although resubmitting failed messages with the same tracking ID is possible, it is recommended that each submission contains a unique tracking ID.
Sender / - / Complex / Yes / See Sender and Destination section.
Destination / - / Complex / Yes / See Sender and Destination section
ServiceAssignmentId / 36 / Alpha / Num (GUID) / Yes / A CCAC assigned number that uniquely identifies service assignment for the referral. This number can be retrieved from the ServiceReferral and ServiceFrequencyUpdate messages
BillingReferenceNumber / 12 / Num / No / A code that identifies this Referral and quoted by the provider in their Billing Invoice
SubmittedByStaffName / 50 / Alpha / Yes / Name of the provider user submitting the request
EquipmentAndSuppliesRequisition / - / - / Yes
RequisitionHeader / - / - / Yes
ExternalReferenceNumber / 20 / Alpha / Num / Yes / Reference number provided by the provider, which represents the requisition in the provider system.
ExternalSystemId / 50 / Alpha / Num / No / System reference number provided by the provider, which represents the requisition database record in the provider system.
ExternalRequisitionDate / - / Date / Yes / The date the requisition is requested by the provider
ProviderContactName / 50 / Alpha / Yes / The provider contact name
ProviderContactNumber / 10 / Num / Yes / The provider contact phone number, which contains exact 10 digits.
DeliveryOrPickup / - / Choice / Yes / One of the following:
· ClientPickupFromCCACDepot
· ClientPickupFromVendor
· Delivery
ClientPickupFromCCACDepot / - / - / Yes
CCACDepotGuid / 36 / Alpha / Num (GUID) / Yes / A unique identifier representing the CCAC depot in the CCAC system
PickupDate / - / Date / Yes / A date the line items can be picked up by the client
PickupTimeInstructions / 20 / Alpha / Num / No / An estimated time when the line items can be picked up by the client
PickupInstructions / 300 / Alpha / Num / No / Pick-up instructions
ClientPickupFromVendor / - / - / Yes
PickupDate / - / Date / Yes / A date the line items can be picked up by the client
PickupTimeInstructions / 20 / Alpha / Num / No / An estimated time the line items can be picked up by the client
PickupInstructions / 300 / Alpha / Num / No / Pick-up instructions
Delivery / - / - / Yes
DeliveryAddress / - / - / Yes
BuildingName / 50 / Alpha / Num / No / Building name in the delivery address
SuiteNumber / 12 / Alpha / Num / No / Suite number in the delivery address
StreetNumber / 12 / Alpha / Num / Yes / Street number in the delivery address
StreetName / 100 / Alpha / Num / Yes / Street name in the delivery address
AddressFreeLine / 250 / Alpha / Num / No / Free line in the delivery address
City / 50 / Alpha / Yes / City in the delivery address
Province / 50 / Alpha / Yes / Province in the delivery address
PostalCode / 10 / Alpha / Yes / Postal code in the delivery address
Country / 50 / Alpha / No / Country in the delivery address
DeliveryDate / - / Date / Yes / Date the order is required to be delivered.
DeliveryTimeInstructions / 20 / Alpha / Num / No / An estimated time the line items can be delivered to the client
DeliveryInstructions / 300 / Alpha / Num / No / Pick-up instructions
LineItem / - / - / Yes / Repeatable node
Cadinality – one to many
ExternalReferenceNumber / 50 / Alpha / Num / Yes / Reference number provided by the provider, which represents the line item in the provider system.
ExternalSystemId / 50 / Alpha / Num / No / System reference number provided by the provider, which represents the line item database record in the provider system.
MasterItemGuid / 36 / Alpha/Num (GUID) / Yes / A unique identifier representing the master item in the CCAC system
Quantity / - / Int / Yes / A line item order quantity
Quantity must be 1 for the line item of Rental type.
AdditionalInformation / 250 / Alpha / Num / No / Additional information on the line item order
Version (Attribute of GetEquipmentAndSuppliesMasterItemCatalogueRequest element) / - / Decimal / Yes / The version of the schema that this message adheres to. E.g. "1.0". This is required to correctly interpret the information being provided by the Provider or CCAC
2.2 Sender and Destination
Name / Field Length (bytes) / Type / Mandatory? / Description /Organization (child element of Sender or Destination) / - / Complex / Yes / Identifies the organization sending or receiving the document
Code (attribute of Organization) / 50 / Alpha / Num / Yes / Specifies the unique code of the sender or the recipient organization
Type (attribute of Organization) / 150 / Alpha / Num / No / Specifies the type of the sender organization. Valid content is:
“CCAC” “Provider” “Vendor”. Defaults to CCAC if not specified.
Name (child of Organization) / 250 / Alpha / No / The name of the sender or the recipient organization
2.2.1 Owner Organization
Name / Field Length (bytes) / Type / Mandatory? / Description /OwnerOrganization (child of Organization) / - / Complex / Yes / Specifies the owner organization of the sender or the recipient
Code (attribute of OwnerOrganization) / 50 / Alpha / Num / Yes / Specifies the unique code of the sender or the recipient owner organization
Type (attribute of OwnerOrganization) / 150 / Alpha / Num / No / Specifies the type of the sender or the recipient owner organization. Valid content is “CCAC”, “Provider” or “Vendor”. If not provided the “CCAC” type is assumed.
Name (child element of OwnerOrganization) / 250 / Alpha / No / The name of the sender or the recipient owner organization
3 Add Equipment and Supplies Requisition Response Elements (version 1.0)
3.1 Add Equipment and Supplies Requisition Response
The following is a top level (root) view of the Add Equipment and Supplies Requisition Response message and its main components.
Name / Field Length (bytes) / Type / Mandatory? / Description /MessageTrackingId / 36 / Alpha/Num (GUID) / Yes / The same unique identifier of the corresponding request message
RequisitionGuid / 36 / Alpha/Num (GUID) / Yes / A unique identifier representing the new E&S requisition database record in the CCAC system
RequisitionNumber / 50 / Alpha / Num / Yes / Unique requisition number that represents the E&S requisition in the CCAC system
RequisitionStatusCode / 10 / Alpha / Num / Yes / Unique code that represents the requisition’s status
RequisitionStatus / 250 / Alpha / Num / Yes / Requisition’s status
Version (Attribute of GetEquipmentAndSuppliesMasterItemCatalogueResponse element) / - / Decimal / Yes / The version of the schema that this message adheres to. E.g. "1.0". This is required to correctly interpret the information being provided by the Provider or CCAC
4 Appendix
4.1 Business Error Messages
Code / Description /ERR-ADDESREQUISITION-001 / [The supplied parameter] is either not found or not in the valid format
ERR-ADDESREQUISITION-002 / The supplied Business Reference Number does not exist in the system
ERR-ADDESREQUISITION-003 / The supplied Service Assignment Guid does not exist in the system
ERR-ADDESREQUISITION-004 / The supplied Service Assignment Guid does not represent an active Provider Assignment in the system
ERR-ADDESREQUISITION-005 / The supplied Business Reference Number and Service Assignment Guid are not associated with the supplied provider Institution
ERR-ADDESREQUISITION-006 / The supplied delivery/pickup date is in the past
ERR-ADDESREQUISITION-007 / The supplied CCAC depot institution Guid does not exist in the system
ERR-ADDESREQUISITION-008 / The supplied Master Catalogue Item Guid is not currently active in the system
ERR-ADDESREQUISITION-009 / The supplied Master Catalogue Item Guid is not currently related to any active vendor contract
ERR-ADDESREQUISITION-010 / The supplied Master Catalogue Item Guid is not currently configured as “Orderable by Provider”
ERR-ADDESREQUISITION-011 / The submitted Purchase line item is duplicate in the requisition
ERR-ADDESREQUISITION-012 / The submitted line item quantity must be greater than 0
ERR-ADDESREQUISITION-013 / The submitted delivery address is invalid – [validation error details]
ERR-ADDESREQUISITION-014 / The submitted Rental line item quantity must be equal to 1
1.
Date: April 10, 2014 4