Equipment and Supply Order Format...

Community Care Access Centre (CCAC)

Equipment and Supply Order Format Specification

Organization: Ontario Association of Community Care Access Centres (OACCAC)

Division: IS/IT

Version:

Schema Version: 2.15

Version Date: February 18, 2014

Prepared By: Ion Moraru

Updated By: Arthur Bydon

Ellen Hsu

Version: 2.14

Equipment and Supply Order Format Specification Version Date: May 5, 2010

Revision LogVersion No.

Version Date Summary of Change Changed by / Input from

0.1 October 26, 2007 First draft Guy Fortin

1.1 November 1, 2007

Changed valid value list for OrderActionLineItemUnitCode changed from mandatory to optionalItemChargeAmount changed from mandatory to optional (only valid for Finance types of orders)

Nasreen Pirani

1.2 December 4, 2007

Change VendorContractCode to ContractCodeMove VerbalOrder and ClientPickUp attributes from EquipmentAndSupplyOrder element to EquipmentAndSupplyItem elementRemove School elementMake RentalStartDate optional and add comment that its : optional (preferred blank) if "EndItem" OrderAction and Mandatory if OrderAction is "Initial"

Make RentalEndDate optional and add comment that its : optional (preferred blank) if "Initial" OrderAction and Mandatory if OrderAction is "EndItem"

Valid values for ItemStatus reduced to include only: "Ordered", "Cancelled", "Removed"

Add a Date and Time description in Chapter 2

Add Appendix that lists all valid language codes and reduced PreferredLanguage attribute to 3 bytes

Rename OrderAction to RequestType (so its consistent with Referral RequestType)

Guy Fortin

2.0 Jan. 23, 2008 Combined DeliveryDate and DeliveryTime into DeliveryDateTime in

Guy Fortin

Date: April 10, 2014 2

Version: 2.14


Version No.


EquipmentAndSupplyOrder elementAdded ShippingAddress to EquipmentAndSupplyOrder elementMoved ContractCode from EquipmentAndSupplyOrder element to EquipmentAndSupplyItem elementMoved GeopgraphicalArea from Client element to EquipmentAndSupplyItem elementRemoved ContactType and IsPrimary from PhoneContact elementChange TelephoneNumber from an element to a single Alpha / NumChanged ItemDescription from Mandatory to optional in EquipmentAndSupplyItem elementAdd StatusChangeDate to EquipmentAndSupplyItem element

2.1 Feb 7, 2008 Added OrganizationCode to EquipmentAndSupplyOrder elementDeleted Vendor Element from EquipmentAndSupplyOrder elementAdded Requestor Element, moved CCACContact element into it, changed fields within CCACContact element, and added a new ProviderContact elementAdded VerbalOrderConfirmation, SentDateTime and LastSentDateTIme to EquipmentAndSupplyOrder elementAdded Delivery element, with an IsClientPickup attribute, to encapsulate all of the delivery fields; deleted ClientPickupInstructionsAdded ResidenceCode, Province and AddtionalInfo fields to Address element and made StreetNumber, StreetName.

Guy Fortin


Version: 2.14


Version No.


PostalCode, and City mandatoryDeleted PreferredNamefrom ClientDemographicsAdd Contact element within PrimaryContacts element to hold all of the Contact fieldsMade ClientRelationship, Role, and LegalRole mandatory in ClientContactsChanged SpecialtyCode to SpecialtyDescription in Physician elementMoved VerbalOrder and ClientPickup attributes from line itme to top ElementMade ContractCode Mandatory, added ContractDescription to line itemAdded RentalPeriod element to contain all rental period fields; added FollowUpDate to RentalPeriod

2.2 Feb 7, 2008 Synch version number with XML file version

2.3 Feb 22, 2008 Made ReferalCaseloadTeam, ContactName Optional in CcacContact and ProviderContact

Changed IsVeteran and IsSmoker from a field to an attribute of the Client element (removed SpecialStatus and clientCharacteristics)Deleted ClientDemographics elements, and promoted all fields to Client elementMade DateOfBirth, Gender, MaritalStatus, and LivingArrangement Mandatory in Client elementAdded Comments to Address elementMade ContactAddress, ContactPhone, adn RiscCode OptionalMade LineItemUnitCode, RentalStartDate


Version: 2.14


Version No.


MandatoryAdded VendorAction element, move field ActionRequired into it and added ActionDate

2.4 Feb 22, 2008 Added updated diagrams for condensed XML

2.5 March 3, 2008 Reflect feedback from CHRIS Team Review- Renamed ProviderName to

OrganizationName in ProvidedContact element

- Made LastSendDateTime optional- Added EnRentalPickupAddress- In Address element: deleted

Comments; Renamed FreeLine to AddressSummary;

- Deleted RecordType and ItemOrderType attributes, and GeographicalArea from EquipementAndSupplyItem element

- Deleted FollowUpDate from RetalPeriod element

2.6 March 7, 2008 Renamed ClientReferralCode to BillingReferenceNumber

2.7 May 27, 2008 Added RecordType attribute at the Line Item levelMoved EndRentalPickUpAddress element from the Order level to the line item level.

Ion Moraru

2.8 June 12, 2008 Renamed PurchaseOrderDate to PurchaseOrderDateTime and PurchaseOrderCancelDate to PurchaseOrderCancelDateTime.Added TransimissionDateTime.Removed SendDateTime and

Ion Moraru


Version: 2.14


Version No.


LastSendDateTime.Moved CaseloadCaseManagerName and ReferralCaseloadTeam into a new element – CCACContact.Turned the Requestor complex element into an element choice (ProviderRequestor and CCACRequestor).Renamed the Delivery element to DeliveryOrPickup and turned it into a choice element for: Delivery, ClientPickUp and EndRentalPickUp (removed the EndRentalPickup address from the line item level). It is assumed that many (one or more) end rental items can be sent within the same transmittal as long as the pickup address is the same.Removed Client Attributes: IsVeteran, IsSmokerRemoved Client Elements: ClientAdmitDate, LivingArrangements, MaritalStatus, DateOfBirth and PersonalContacts.Removed LineItem elements: VendorAction, EndRentalPickUpAddress, BillingMethod.

2.10 May 4, 2009 Reorganized the Order elements.Added HealthCard element.Removed ItemInstructions (Line Item level)Added VendorInstructions (Line Item level)Added EquipmentDischargeDisposition (Line item level)

Ion Moraru

2.11 June 9, 2009 Added AdditionalInformation (Line Item level)

Nasreen Pirani


Version: 2.14


Version No.


2.12 August 19, 2009 Change the RequestType, Address.Type and PhoneLocation values to be in sync with CHRIS values

Ion Moraru

2.13 December 9, 2009

Add Sender and Destination elements that describe the participants in the message exchange

Arthur Bydon

2.14 May 5, 2010 Add Extension to Client Phone and Medical ContactAddress:- Change Type “Alternate” to “Other”;- Remove Residence Code;- Add room number and country

Ellen Hsu

February 6, 2014 Section 2.2 – added CCACReferenceNumber element

Ted JinTFS# 162529


Version: 2.14


Table of Contents1. Equipment and Supply Order....................................................................................8

1.1 Brief Description 81.2 High Level Structure of the EquipmentAndSupplyOrder 8

2. Equipment and Supply Order Elements (version 2.15)..............................................92.1 EquipmentAndSupplyOrder element detail 92.2 Order element detail 112.3 CCAC Contact element detail 132.4 Client element detail 14

2.4.1 Address element detail 172.5 EquipmentAndSupplyItem element detail 19

3. Appendix A - ISO 639-2 Language Codes..............................................................21

4. Appendix A - Distilled XML Schema........................................................................354.1 Equipment And Supply Order 35

1.Equipment and Supply Order1.1 Brief Description

Once the Service Plan for a Client has been determined, the CCAC will issue Equipment and Medical Supply orders to the appropriate vendors to implement the plan.

This document specifies the information and associated format of the Equipment And Supply Order that flows from the CCAC to the Vendor.

1.2 High Level Structure of the EquipmentAndSupplyOrderThe EquipmentAndSupplyOrder is an XML document with the following high level element structure:

Figure 1 Equipment and Supply Order Structure


Version: 2.14


As the diagram above depicts, a EquipmentAndSupplyOrder element contains a single Client element and one or more EquipmentAndSupplyItem elements. These are the primary elements that make up the Equipment & Supply Order and below there is a section for each of them that describes all of the information they contain.


Version: 2.14


2.Equipment and Supply Order Elements (version 2.15)

The following tables detail the fields contained within the elements that make up a Equipment and Supply Order as outlined in the structure diagram in the previous section.

A note about Date and Time specification:All dates and times contained in the specification adhere to the W3C Universal Time Code (UTC) standard and are formatted as follows:

date: yyyy-mm-dd (size 10 bytes); e.g. 2007-11-21

datetime: yyyy-mm-ddThh:mm[:ssTZD]; (size 16 bytes - if omitting ss and TZD - and 25 bytes with ss and TZD); e.g. 2007-11-21T14:56:19-05:00 (for EST timezone)

time: hh:mm[:ssTZD] (size 5 - if omitting ss and TZD - and 14 bytes with ss and TZD); e.g. 14:56:19-05:00

Where "yyyy" represents the year, "mm" the month from 01 through 12, "dd" the day of the month, "T" separates the date from the time, "hh" the hour from 00 through 24, "mm" the minutes, "ss" the seconds and TZD represents the timezone which reflect the times difference relative to GMT, so it can range from +12:00 to -13:00; both "ss" and TZD are optional; TZD is not yet supported by this specification.

2.1 EquipmentAndSupplyOrder element detail

Name Field Length (bytes)

Type

Mandatory

Description

Version (Attribute of EquipmentAndSupplyOrder

element)

Max 10 Alpha / num

Yes The version of the Schema that this EquipmentAndSupplyOrder element adheres to. E.g. "1.0". This is required for the receiving provider to correctly interpret the information being provided by the CCAC

MessageTrackingId 36 Alpha/Num

(GUID)

Yes The unique identifier of the message that can be used for tracking

Date: April 10, 2014 10

Version: 2.14


Sender (parent element) - - Yes A group of elements and attributes identifying the sender of the document.

Destination (parent element) - - Yes A group of elements and attributes identifying the recipient of the document

Organization (child element of Sender or Destination)

- - 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

Yes Specifies the type of the sender organization. Valid content is:“CCAC”“Provider”“Vendor”

Name (child of Organization) 250 Alpha No The name of the sender or the recipient organization

OwnerOrganization (child of Organization)

- - 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

Date: April 10, 2014 11

Version: 2.14


CcacCode 2 - 4 Alpha Yes A unique number for the CCAC. Valid values are:

"ES"“SW""WW""HNHB""CW""MH""TC""CENT""CE""SE""CHAM""NSM""NE""NW"

TransimissionDateTime 20 DateTime

Yes Date when the transmittal was sent

2.2 Order element detail

Order (element) - Element Yes The order header information

PurchaseOrderNumber Max 15 Alpha / num

Yes The Purchase Order number provided by the CCAC

PurchaseOrderDateTime 20 DateTime

Yes Date when the Purchase Order was created

PurchaseOrderCancelDateTime 20 DateTime

No The date when the Purchase Order was cancelled, if applicable

RequestType 25 Alpha / num

Yes Defines the type of action for the Order; can be set to one of the following values:

"E & S - Initial Order""E & S - Cancel Order""E & S - Resending PO""E & S - Cancel Line Item""E & S - End Rental""E & S - Finance Charge Update"

Date: April 10, 2014 12

Version: 2.14


OrganizationCode 10 Num Yes A unique number assigned to Vendor by local CCAC. Reference may be “vendor” organization

Requestor (element) Element (Choice)

Yes The party who is requesting this equipment or supply. This may be either a CCAC person or a Provider

RequestorType Attribute Yes “CCAC” or “Provider”

ProviderRequestor Element No The Provider requesting the items

OrganizationName 25 Alpha / num

Yes The name of the Provider Organization who is requesting the order

ContactName 25 Alpha / num

No The name of the person who is requesting the order

ContactPhoneNumber 15 Alpha / Num

No The telephone number for the contact person.

CCACRequestor Element No Indicates the CCAC is requesting the items

ContactName 25 Alpha / num

Yes The name of the CCAC person who is requesting the order

ContactPhoneNumber 15 Alpha / Num

No The telephone number.

VerbalOderConfirmation 1 Boolean Yes Indicates if this order has had a verbal confirmation with the supplier

Date: April 10, 2014 13

Version: 2.14


DeliveryOrPickUp (element) Element (Choice)

Yes This element wraps the entire Delivery or Pickup information. This is a choice of: Delivery content if the order is to be delivered to a certain address, Client Pickup content in case the order will be picked up by the Client or EndRentalPickup content in case of an EndRental transmittal which will be used by the Vendor for their pickup process.

Delivery Element Yes Indicates the order will be delivered by the vendor.

DeliveryDateTime 20 DateTime

Yes Date and Time the equipment is to be delivered.

DeliveryTimeInstructions 250 Alpha / num

No Additional delivery instructions

DeliveryPriority 25 Alpha / num

YesThe overall priority of this order. Can be set to one of the following values: "Normal""Same Day""Urgent"

DeliveryPriorityInstructions 250 Alpha / num

No Additional instructions associated with the Delivery Priority

ShippingAddress (element) - Element Yes The shipping address (see Address element below for details)

ClientPickUp Element Yes Indicates the order will be picked up by the client.

PickUpDateTime 25 DateTime

Yes The date and time the client is supposed to pick up the items.

PickUpInstructions 250 Alpha / Num

No Pick Up Instructions associated with the Client

Date: April 10, 2014 14

Version: 2.14


CCACReferenceNumber 20 Alpha / Num

No A number assigned by a local CCAC to reference a client’s file. For the requisitions submitted by providers, this will display the provider’s requisition number.

2.3 CCAC Contact element detail

Name Field Length (bytes)

Type Mandatory

Description

CcacContact (element) - Element

Yes The contact in the CCAC for this order

CaseloadCaseManagerName 25 Alpha / num

Yes The Case Manager associated with this Order

ReferalCaseloadTeam 25 Alpha / num

Yes The CCAC Team associated with this Order

Date: April 10, 2014 15

Version: 2.14


2.4 Client element detail The Client element provides information about the person that is to receive the equipment or medical supply.

Name Field Lengt

h (byte

s)

Type Mandatory

Description

ClientIdentifier 15 Alpha / num

Yes An identifier that uniquely identifies this client to the CCAC

BillingReferenceNumber 12 Alpha / num

Yes A code that identifies the Client Referral that is associated with this order.

FirstName 25 Alpha Yes Client’s legal first name

SurName 25 Alpha Yes Client legal last name / surname

PreferredLanguage 3 Alpha No Language in which the client would prefer to communicate for service provision; see Appendix A for a list of valid ISO 639-2 language codes

Gender 25 Alpha Yes One of :

"Male""Female""Undifferentiated""Unknown"

HealthCard (element) - element No Client's Health Card information (will be blank until approved)

HCN 10 Numeric Yes Health Card Number

VC 2 Alpha Yes Version Code

ExpiryDate - DateTime

No HC expiry date

Date: April 10, 2014 16

Version: 2.14


Name 50 Alpha No Client name if different than Surname

ClientAddress (element) - element Yes The client's address (see Address element below for details)

ClientPhone (element) - element Yes Contains a list of client phone numbers

Phone element Yes

PhoneLocation 20 Alpha Yes One of

"Home”“Work”“Mobile”“Other"

TelephoneNumber 15 Alpha / Num

Yes The telephone number.

Extension 10 Alpha / Num

No Extension for the telephone number

MedicalContacts (element)

- element No The list of medical contacts (Physicians or Practitioner Nurses) that are attending to the client.

Physician (element) element

TypeOfContact (attribute)

25 Alpha No The type of Physician; one of:"Family""Attending""Referring""Specialist"

ContactFirstName

25 Alpha Yes Contacts first name

ContactSurName

25 Alpha Yes Contacts last name

ContactAddress (subelement)

- element No The contact's address (see Address element below for details)

ContactPhone - element No The contact's phone number

Date: April 10, 2014 17

Version: 2.14


TelephoneNumber 15 Alpha / Num

Yes The telephone number.

Extension 10 Alpha / Num

No Extension for the telephone number

Specialities (subelement)

- element No A list of the Physician's specialties (from a provincially maintained table of specialties); Each Specialty contains the following attributes...

SpecialtyDescription

50 Alpha / num

No A description of the specialty

ActiveClientRiskCodes (element)

- element No The list of client active Risk Codes.

RiskCodeItem (collection element)

element No

RiskCode 10 Alpha / num

Yes Risk code that identifies a risk of importance related to the client (only active codes are being sent)

AdditionalInformation 250 Alpha No

Date: April 10, 2014 18

Version: 2.14


2.4.1 Address element detail The Address element defines all of the fields available for specifying a physical address.

Name Field Lengt

h (bytes)

Type Mandatory

Description

AddressSummary 250 Alpha / num

No If the address cannot be specified for any reason this allow manual entry of address; may also contain a summary of the address below.

Type 50 Alpha Yes The type of address that is being specified; one of:

"Home""Mailing""Shipping""Other"

E&S Order Release 1.0 will use only “Home”

BuildingName 50 Alpha No Used for organizational addresses

Name of LTC home / Retirement home / hospital in which the client resides

RoomNumber 6 Alpha / num

No The room number if applicable

SuiteNumber 6 Alpha / num

No The suite number if applicable

StreetNumber 6 Alpha / num

Yes The associated street number

StreetName 100 Alpha / num

Yes The name of the street the client resides at

PostalCode 10 Alpha / num

Yes The associated postal code

Date: April 10, 2014 19

Version: 2.14


City 50 Alpha / num

Yes The associated city

Province 25 Alpha / num

No Assumed to be Ontario if not present

Country 50 Alpha / num

No The associated country

Directions 250 Alpha / num

No The intent is to provide any necessary information to assist the service provider to drive to the client address. This could include closest major intersection to the address being recorded or other driving instructions

AdditionalInfo 250 Alpha / num

No Additional information about the location

Date: April 10, 2014 20

Version: 2.14


2.5 EquipmentAndSupplyItem element detail

Name Field Lengt

h (byte

s)

Type Mandatory

Description

LineItemType (attribute of EquipmentAndSupplyItem)

Max 10

Alpha YesIdentifies this Line Item as either a "Rental""Purchase"“Finance Charge”

RecordType (attribute of EquipmentAndSupplyItem)

Max 10

Alpha YesIdentifies this Line Item as either an "Equipment""Supply"

PurchaseOrderLineNumber Max 15

Alpha / num

Yes The code that identifies this Line Number to the CCAC; provided by the CCAC at time of order

ContractCode Max 15 Num Yes Contract Number assigned to the Vendor by the CCAC when the contract was entered into

ContractName No The description of the Contract

VendorItemCode Max 15 Alpha / num

Yes The code that identifies the specific item ordered

ItemClass Max 15 Alpha / num

Yes Identifies this item as either a

"Normal""Exception"

LineItemUnitCode Max 10 Alpha Yes FUTURE (always set to "unit" initially)Code for the units in which the item is to be delivered (e.g., EACH, CASE, BOX, SET, DOZ, GROSS)

ItemDescription Max 50 Alpha Yes A description of the item

RentalPeriod element No

Date: April 10, 2014 21

Version: 2.14


RentalStartDate

10 DateTime

Yes Date rental is to start; optional (preferred blank) if "EndItem" OrderAction and Mandatory if OrderAction is "Initial"

RentalEndDate

10 DateTime

No Date rental is to end; optional (preferred blank) if "Initial" OrderAction and Mandatory if OrderAction is "EndItem"

ItemStatus 15 Alpha Yes Identifies this item as

"Ordered""Cancelled""Removed"

ItemStatusChangeDateTime

25 DateTime

Yes The date the ItemStatus was last changed. Optional on “Ordered”.

OrderedDateTime 25 DateTime

Yes The date the item was ordered initially.

ItemQuantity Max 10 Num Yes The number of items ordered. If the item type is rental or finance-charge the quantity will always be 1.

ItemChargeAmount Max 20 Num No The amount the item costs; Sent only if LineItemType is "Finance Charge"

VendorInstructions 512 Alpha No Future use (CHRIS 1.3)

EquipmentDischargeDisposition

- element No Future use (CHRIS 1.3). Carries additional information about End Rental items.

DispositionCode 20 Alpha / Num

Yes Future use (CHRIS 1.3)

DispositionDescription 100 Alpha Yes Future use (CHRIS 1.3)

AdditionalInformation 300 Alpha / Num

No This is matching the Additional Information in CHRIS (line items).

Date: April 10, 2014 22

Version: 2.14


3.Appendix A - ISO 639-2 Language Codes

ValueCode ISO 639-2

Afar AARAbkhazian ABKAchinese ACEAcoli ACHAdangme ADAAdyghe ADYAfrihili AFHAfrikaans AFRAfro-Asiatic (Other) AFAAinu AINAkan AKAAkkadian AKKAlbanian SQIAleut ALEAlgonquian Languages ALGAltaic (Other) TUTAmharic AMHAngika ANPApache Languages APAArabic ARAAramaic ARCArapaho ARPAraucanian ARNArawak ARWArgonese ARGArmenian HYEAromanian RUPArtificial (Other) ARTAssamese ASMAsturian ASTAthapascan Languages ATHAustralian Languages AUS

Date: April 10, 2014 23

Version: 2.14


ValueCode ISO 639-2

Austronesian (Other) MAPAvaric AVAAvestan AVEAwadhi AWAAymara AYMAzerbaijani AZEBalinese BANBaltic (Other) BATBaluchi BALBambara BAMBamileke Languages BAIBanda BADBantu (Other) BNTBasa BASBashkir BAKBasque EUSBatak (Indonesia) BTKBeja BEJBelarusian BELBemba BEMBengali BENBerber (Other) BERBhojpuri BHOBihari BIHBikol BIKBini BINBislama BISBlin BYNBokmål, Norwegian NOBBosnian BOSBraj BRABreton BREBuginese BUGBulgarian BULBuriat BUA

Date: April 10, 2014 24

Version: 2.14


ValueCode ISO 639-2

Burmese MYACaddo CADCantonese QYUCarib CARCatalan CATCaucasian (Other) CAUCebuano CEBCeltic (Other) CELCentral American Indian (Other) CAIChagatai CHGChamic Languages CMCChamorro CHAChechen CHECherokee CHRCheyenne CHYChibcha CHBChichewa NYAChinese ZHOChinook Jargon CHNChipewyan CHPChoctaw CHOChuukese CHKChuvash CHVClassical Nepal Bhasa NWCCoptic COPCornish CORCorsican COSCree CRECreek MUSCreoles And Pidgins (Other) CRPCreoles And Pidgins, English-Based (Other)

CPE

Creoles And Pidgins, French-Based (Other)

CPF

Creoles And Pidgins, Portuguese-Based (Other)

CPP

Date: April 10, 2014 25

Version: 2.14


ValueCode ISO 639-2

Crimean Tatar CRHCroatian HRVCushitic (Other) CUSCzech CESDakota DAKDanish DANDargwa DARDari PRSDayak DAYDelaware DELDhivehi DIVDinka DINDogri DOIDogrib DGRDravidian (Other) DRADuala DUADutch NLDDyula DYUDzongkha DZOEastern Frisian FRSEfik EFIEgyptian (Ancient) EGYEkajuk EKAElamite ELXEnglish ENGErzya MYVEsperanto EPOEstonian ESTEwe EWEEwondo EWOFang FANFanti FATFaroese FAOFijian FIJFilipino; Pilipino FIL

Date: April 10, 2014 26

Version: 2.14


ValueCode ISO 639-2

Finnish FINFinno-Ugrian (Other) FIUFon FONFrench FRAFriulian FURFulah FULGa GAAGaelic GLAGallegan GLGGanda LUGGayo GAYGbaya GBAGeez GEZGeorgian KATGerman DEUGermanic (Other) GEMGikuyu KIKGilbertese GILGondi GONGorontalo GORGothic GOTGrebo GRBGreek ELLGuarani GRNGujarati GUJGwich'in GWIHaida HAIHaitian Creole HATHausa HAUHawaiian HAWHebrew HEBHerero HERHiligaynon HILHimachali HIMHindi HIN

Date: April 10, 2014 27

Version: 2.14


ValueCode ISO 639-2

Hiri Motu HMOHittite HITHmong HMNHungarian HUNHupa HUPIban IBAIcelandic ISLIdo IDOIgbo IBOIjo IJOIloko ILOInari Sami SMNIndic (Other) INCIndo-European (Other) INEIndonesian INDIngush INHInterlingua (International Auxiliary Lang. Assoc.)

INA

Interlingue ILEInuktitut IKUInupiaq IPKIranian (Other) IRAIrish GLEIroquoian Languages IROItalian ITAJapanese JPNJavanese JAVJudeo-Arabic JRBJudeo-Persian JPRKabardian KBDKabyle KABKachin KACKalaallisut KALKalmyk XALKamba KAM

Date: April 10, 2014 28

Version: 2.14


ValueCode ISO 639-2

Kannada KANKanuri KAUKarachay-Balkar KRCKara-Kalpak KAAKarelian KRLKaren KARKashmiri KASKashubian CSBKawi KAWKazakh KAZKhasi KHAKhmer KHMKhoisan (Other) KHIKhotanese KHOKimbundu KMBKinyarwanda KINKirghiz KIRKlingon TLHKomi KOMKongo KONKonkani KOKKorean KORKosraean KOSKpelle KPEKru KROKumyk KUMKurdish KURKurukh KRUKutenai KUTKwanyama KUALadino LADLahnda LAHLamba LAMLao LAOLatin LAT

Date: April 10, 2014 29

Version: 2.14


ValueCode ISO 639-2

Latvian LAVLezghian LEZLimburgish LIMLingala LINLithuanian LITLojban JBOLow German NDSLower Sorbian DSBLozi LOZLuba-Katanga LUBLuba-Lulua LUALuiseno LUILule Sami SMJLunda LUNLuo (Kenya And Tanzania) LUOLushai LUSLuxembourgish LTZMacedonian MKDMadurese MADMagahi MAGMaithili MAIMakasar MAKMalagasy MLGMalay MSAMalayalam MALMaltese MLTManchu MNCMandar MDRMandarin QCMMandingo MANManipuri MNIManobo Languages MNOManx GLVMaori MRIMarathi MAR

Date: April 10, 2014 30

Version: 2.14


ValueCode ISO 639-2

Mari CHMMarshall MAHMarwari MWRMasai MASMayan Languages MYNMende MENMicmac MICMinangkabau MINMirandese MWLMiscellaneous Languages MISMohawk MOHMoksha MDFMoldavian MOLMongo LOLMongolian MONMon-Khmer (Other) MKHMossi MOSMultiple Languages MULMunda Languages MUNNahuatl NAHNauru NAUNavajo NAVNdonga NDONeapolitan NAPNepal Bhasa NEWNepali NEPNias NIANiger-Kordofanian (Other) NICNilo-Saharan (Other) SSANiuean NIUN'Ko NQONo linguistic content ZXXNogai NOGNorse, Old NONNorth American Indian (Other) NAI

Date: April 10, 2014 31

Version: 2.14


ValueCode ISO 639-2

North Ndebele NDENorthern Frisian FRRNorthern Sami SMENorthern Sotho NSONorwegian NORNorwegian Nynorsk NNONubian Languages NUBNyamwezi NYMNyankole NYNNyoro NYONzima NZIOccitan OCIOjibwa OJIOld Church Slavonic CHUOriya ORIOromo ORMOsage OSAOssetic OSSOtomian Languages OTOPahlavi PALPalauan PAUPali PLIPampanga PAMPangasinan PAGPapiamento PAPPapuan (Other) PAAPersian FASPhilippine (Other) PHIPhoenician PHNPohnpeian PONPolish POLPortuguese PORPrakrit Languages PRAPunjabi PANPushto PUS

Date: April 10, 2014 32

Version: 2.14


ValueCode ISO 639-2

Quechua QUERaeto-Romance ROHRajasthani RAJRapanui RAPRarotongan RARRomance (Other) ROARomanian RONRomany ROMRundi RUNRussian RUSSalishan Languages SALSamaritan Aramaic SAMSami Languages SMISamoan SMOSandawe SADSango SAGSanskrit SANSantali SATSardinian SRDSasak SASScots SCOSelkup SELSemitic (Other) SEMSerbian SRPSerer SRRShan SHNShona SNASichuan Yi IIISicilian SCNSidamo SIDSign Languages SGNSiksika BLASindhi SNDSinhalese SINSino-Tibetan (Other) SIT

Date: April 10, 2014 33

Version: 2.14


ValueCode ISO 639-2

Siouan Languages SIOSkolt Sami SMSSlave (Athapascan) DENSlavic (Other) SLASlovak SLKSlovenian SLVSogdian SOGSomali SOMSonghai SONSoninke SNKSorbian Languages WENSouth American Indian (Other) SAISouth Ndebele NBLSouthern Altai ALTSouthern Sami SMASouthern Sotho SOTSpanish SPASranan Togo SRNSukuma SUKSumerian SUXSundanese SUNSusu SUSSwahili SWASwati SSWSwedish SWESwiss German GSWSyriac SYRTagalog TGLTahitian TAHTai (Other) TAITajik TGKTamashek TMHTamil TAMTatar TATTelugu TEL

Date: April 10, 2014 34

Version: 2.14


ValueCode ISO 639-2

Tereno TERTetum TETThai THATibetan BODTigre TIGTigrinya TIRTimne TEMTiv TIVTlingit TLITok Pisin TPITokelau TKLTonga (Nyasa) TOGTonga (Tonga Islands) TONTsimshian TSITsonga TSOTswana TSNTumbuka TUMTupi languages TUPTurkish TURTurkmen TUKTuvalu TVLTuvinian TYVTwi TWIUdmurt UDMUgaritic UGAUkrainian UKRUmbundu UMBUndetermined UNDUpper Sorbian HSBUrdu URDUyghur UIGUzbek UZBVai VAIVenda VENVietnamese VIE

Date: April 10, 2014 35

Version: 2.14


ValueCode ISO 639-2

Volapuk VOLVotic VOTWakashan Languages WAKWalamo WALWalloon WLNWaray WARWasho WASWelsh CYMWestern Frisian FRYWolof WOLXhosa XHOYakut SAHYao YAOYapese YAPYiddish YIDYoruba YORYupik Languages YPKZande ZNDZapotec ZAPZazaki ZZAZenaga ZENZhuang ZHAZulu ZULZuni ZUN

Date: April 10, 2014 36

Version: 2.13


Version Date: Dec 9, 2009

4.Appendix A - Distilled XML Schema4.1 Equipment And Supply OrderThe following provides a distilled view of the XML document schema. The intent is to provide a concise view of the document layout. The full XML schema specification is contained in file: EquipmentAndSupplyOrder.xsd<xs:element name="EquipmentAndSupplyOrder">

<xs:complexType><xs:sequence>

<xs:element name="CcacCode" type="xs:string"/><xs:element name="TransmissionDateTime" type="xs:dateTime"/><xs:element name="Order">


<xs:element name="OrganizationCode" type="xs:string"/><xs:element name="PurchaseOrderNumber" type="xs:string"/><xs:element name="PurchaseOrderDateTime" type="xs:dateTime">

<xs:annotation><xs:documentation>Changed to date and time

Rename Date to DateTime</xs:documentation></xs:annotation>

</xs:element><xs:element name="PurchaseOrderCancelDateTime" type="xs:dateTime" minOccurs="0">

<xs:annotation><xs:documentation>Changed to date and time

Rename Date to DateTime</xs:documentation></xs:annotation>

</xs:element><xs:element name="RequestType" type="xs:string"> <xs:annotation>

Date: April 10, 2014 37

Version: 2.13



<xs:documentation>Defines the type of action for the Order; can be set to one of the following values: "InitialOrder", "CancelOrder", "ResendDuplicatePO", "CancelLineItem", "EndRental", "FinanceChargeUpdate"</xs:documentation>

</xs:annotation></xs:element><xs:element name="DeliveryOrPickup">


<xs:element name="Delivery" minOccurs="0"><xs:complexType>

<xs:sequence><xs:element name="DeliveryDateTime"

type="xs:dateTime"/><xs:element name="DeliveryTimeInstructions"

type="xs:string" minOccurs="0"/><xs:element name="DeliveryPriority"

type="xs:string"/><xs:element name="DeliveryPriorityInstructions"

type="xs:string" minOccurs="0"><xs:annotation><xs:documentation>Delivery Priority instructions

if it's a delivery</xs:documentation></xs:annotation>

</xs:element><xs:element name="ShippingAddress">

<xs:annotation><xs:documentation>2.8 Removed

RoomNumber</xs:documentation></xs:annotation><xs:complexType>

<xs:sequence><xs:element

Date: April 10, 2014 38

Version: 2.13



name="AddressSummary" type="xs:string" minOccurs="0"/><xs:element name="Type"

type="xs:string"/><xs:element

name="BuildingName" type="xs:string" minOccurs="0"/><xs:element name="SuiteNumber"

type="xs:string" minOccurs="0"/><xs:element

name="StreetNumber" type="xs:string"/><xs:element name="StreetName"

type="xs:string"/><xs:element name="PostalCode"

type="xs:string"/><xs:element name="City"

type="xs:string"/><xs:element name="Province"

type="xs:string" minOccurs="0"/><xs:element name="Directions"


name="AdditionalInfo" type="xs:string" minOccurs="0"/></xs:sequence>

</xs:complexType></xs:element>

</xs:sequence></xs:complexType>

</xs:element><xs:element name="ClientPickUp" minOccurs="0">


<xs:element name="PickUpDateTime"

Date: April 10, 2014 39

Version: 2.13



type="xs:dateTime"/><xs:element name="PickUpInstructions"

type="xs:string" minOccurs="0"/></xs:sequence>

</xs:complexType></xs:element><xs:element name="EndRentalPickUp" minOccurs="0">

<xs:annotation><xs:documentation>This is the pickup information for an

EndRental transaction</xs:documentation></xs:annotation><xs:complexType>

<xs:sequence><xs:element name="PickUpAddress">

<xs:annotation><xs:documentation>2.8 Removed

RoomNumber</xs:documentation></xs:annotation><xs:complexType>


name="AddressSummary" type="xs:string" minOccurs="0"/><xs:element name="Type"

type="xs:string"/><xs:element




Date: April 10, 2014 40

Version: 2.13






type="xs:string" minOccurs="0"/><xs:element name="Directions"


name="AdditionalInfo" type="xs:string" minOccurs="0"/></xs:sequence>

</xs:complexType></xs:element><xs:element name="PickUpInstructions"

type="xs:string" minOccurs="0"><xs:annotation>

<xs:documentation>This is matching the Item comments in CHRIS at the End Rental Item level</xs:documentation>

</xs:annotation></xs:element>


</xs:element></xs:sequence>

</xs:complexType></xs:element><xs:element name="VerbalOrderConfirmation" type="xs:boolean"/><xs:element name="Requestor">


Date: April 10, 2014 41

Version: 2.13



<xs:element name="ProviderRequestor" minOccurs="0"><xs:complexType>

<xs:sequence><xs:element name="OrganizationName"

type="xs:string"><xs:annotation>

<xs:documentation>2.5 Renamed to OrgE.g. "Commrehab"</xs:documentation>

</xs:annotation></xs:element><xs:element name="ContactName" type="xs:string"

minOccurs="0"/><xs:element name="ContactPhoneNumber"


</xs:complexType></xs:element><xs:element name="CCACRequestor" minOccurs="0">


<xs:element name="ContactName" type="xs:string"/><xs:element name="ContactPhoneNumber"



</xs:sequence><xs:attribute name="RequestorType" use="required">

<xs:annotation><xs:documentation>CCAC or Provider</xs:documentation>

</xs:annotation>

Date: April 10, 2014 42

Version: 2.13



</xs:attribute></xs:complexType>


</xs:complexType></xs:element><xs:element name="CCACContact">


<xs:element name="CaseloadCaseManagerName" type="xs:string"/><xs:element name="ReferralCaseloadTeam" type="xs:string"/>


</xs:element><xs:element name="Client">


<xs:element name="ClientIdentifier" type="xs:string"/><xs:element name="BillingReferenceNumber" type="xs:string"/><xs:element name="FirstName" type="xs:string"/><xs:element name="SurName" type="xs:string"/><xs:element name="PreferredLanguage" type="xs:string" minOccurs="0"/><xs:element name="Gender" type="xs:string" minOccurs="0"/><xs:element name="ClientAddress">

<xs:annotation><xs:documentation>2.5 Deleted Comment</xs:documentation>

</xs:annotation><xs:complexType>

<xs:sequence><xs:element name="AddressSummary" type="xs:string" minOccurs="0"/><xs:element name="Type" type="xs:string">

Date: April 10, 2014 43

Version: 2.13



<xs:annotation><xs:documentation>Home, Mailing,

Other</xs:documentation></xs:annotation>

</xs:element><xs:element name="ResidenceCode" type="xs:string" minOccurs="0"/><xs:element name="BuildingName" type="xs:string" minOccurs="0"/><xs:element name="SuiteNumber" type="xs:string" minOccurs="0"/><xs:element name="StreetNumber" type="xs:string"/><xs:element name="StreetName" type="xs:string"/><xs:element name="PostalCode" type="xs:string"/><xs:element name="City" type="xs:string"/><xs:element name="Province" type="xs:string" minOccurs="0"/><xs:element name="Directions" type="xs:string" minOccurs="0"/><xs:element name="AdditionalInfo" type="xs:string" minOccurs="0"/>


</xs:element><xs:element name="ClientPhone">

<xs:annotation><xs:documentation>2.8 Changed the Phone number to

collection</xs:documentation></xs:annotation><xs:complexType>

<xs:sequence><xs:element name="Phone" maxOccurs="unbounded">


<xs:element name="TelephoneNumber" type="xs:string"/>

<xs:element name="PhoneLocation" type="xs:string">

Date: April 10, 2014 44

Version: 2.13



<xs:annotation><xs:documentation>Home, work, mobile,

other</xs:documentation></xs:annotation>




</xs:element><xs:element name="MedicalContacts" minOccurs="0">


<xs:element name="MedicalContact" minOccurs="0" maxOccurs="unbounded">


<xs:element name="ContactFirstName" type="xs:string">

<xs:annotation><xs:documentation>renamed added

Contact</xs:documentation></xs:annotation>

</xs:element><xs:element name="ContactSurName"

type="xs:string"><xs:annotation>

<xs:documentation>renamed added Contact</xs:documentation>

</xs:annotation>

Date: April 10, 2014 45

Version: 2.13



</xs:element><xs:element name="ContactAddress" minOccurs="0">

<xs:annotation><xs:documentation>2.5 Deleted

Comments</xs:documentation></xs:annotation><xs:complexType>


name="AddressSummary" type="xs:string" minOccurs="0"><xs:annotation>

<xs:documentation>2.5 Renamed</xs:documentation></xs:annotation>

</xs:element><xs:element








Date: April 10, 2014 46

Version: 2.13



<xs:documentation>2.4 Optional</xs:documentation></xs:annotation>

</xs:element><xs:element name="Directions"


<xs:documentation>2.5 Optional</xs:documentation></xs:annotation>


</xs:complexType></xs:element><xs:element name="ContactPhone" type="xs:string"

minOccurs="0"/><xs:element name="Specialties" minOccurs="0">


<xs:element name="SpecialtyDescription" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>


</xs:element></xs:sequence><xs:attribute name="TypeOfContact">

<xs:annotation><xs:documentation> "Family" "Attending"

"Referring" "Specialist"Added Jan 31</xs:documentation>

</xs:annotation></xs:attribute>

Date: April 10, 2014 47

Version: 2.13





</xs:element><xs:element name="ActiveRiskCodes" minOccurs="0">


<xs:element name="RiskCodeItem" minOccurs="0" maxOccurs="unbounded">


<xs:element name="RiskCode" type="xs:string"/><xs:element name="AditionalInformation"

type="xs:string" nillable="true" minOccurs="0"/></xs:sequence>



</xs:element><xs:element name="HealthCard" minOccurs="0">


<xs:element name="HCN" type="xs:string"><xs:annotation>

<xs:documentation>Health Card Number</xs:documentation></xs:annotation>

</xs:element><xs:element name="VC" type="xs:string">

<xs:annotation>

Date: April 10, 2014 48

Version: 2.13



<xs:documentation>Version Code</xs:documentation></xs:annotation>

</xs:element><xs:element name="ExpiryDate" type="xs:dateTime" minOccurs="0"/><xs:element name="Name" type="xs:string" minOccurs="0">

<xs:annotation><xs:documentation>optional if the same as client

name</xs:documentation></xs:annotation>




</xs:element><xs:element name="EquipmentAndSupplyItem">


<xs:element name="LineItem" maxOccurs="unbounded"><xs:complexType>

<xs:sequence><xs:element name="PurchaseOrderLineNumber" type="xs:string"/><xs:element name="ContractCode" type="xs:string"/><xs:element name="ContractName" type="xs:string" minOccurs="0">

<xs:annotation><xs:documentation>2.8 Associated with migration

requiemrements</xs:documentation></xs:annotation>

</xs:element><xs:element name="VendorItemCode" type="xs:string"/>

Date: April 10, 2014 49

Version: 2.13



<xs:element name="ItemClass" type="xs:string"><xs:annotation>

<xs:documentation>Normal or Exception (for non-contracted item)</xs:documentation>

</xs:annotation></xs:element><xs:element name="LineItemUnitCode" type="xs:string" default="unit">

<xs:annotation><xs:documentation>always set to "unit"</xs:documentation>

</xs:annotation></xs:element><xs:element name="ItemDescription" type="xs:string"/><xs:element name="RentalPeriod" minOccurs="0">


<xs:element name="RentalStartDate" type="xs:date"/><xs:element name="RentalEndDate" type="xs:date"

minOccurs="0"/></xs:sequence>

</xs:complexType></xs:element><xs:element name="OrderedDateTime" type="xs:dateTime">

<xs:annotation><xs:documentation>2.8 New Element

Indicates when the item was ordered originally</xs:documentation></xs:annotation>

</xs:element><xs:element name="ItemQuantity" type="xs:decimal">

<xs:annotation><xs:documentation>2.8 Changed to decimal

type</xs:documentation>

Date: April 10, 2014 50

Version: 2.13



</xs:annotation></xs:element><xs:element name="ItemChargeAmount" type="xs:decimal"

minOccurs="0"><xs:annotation>

<xs:documentation>This will be populated for finance charges</xs:documentation>

</xs:annotation></xs:element><xs:element name="VendorInstructions" type="xs:string" minOccurs="0">

<xs:annotation><xs:documentation>required for CHRIS

1.3</xs:documentation></xs:annotation>

</xs:element><xs:element name="ItemStatus" type="xs:string">

<xs:annotation><xs:documentation>Ordered, Cancellled,

Removed</xs:documentation></xs:annotation>

</xs:element><xs:element name="ItemStatusChangeDateTime" type="xs:dateTime"

minOccurs="0"><xs:annotation>

<xs:documentation>2.8 RenamedThe date when the item status was last changed</xs:documentation>

</xs:annotation></xs:element><xs:element name="EquipmentDischargeDisposition" minOccurs="0">

<xs:annotation><xs:documentation>required for CHRIS 1.3

Date: April 10, 2014 51

Version: 2.13



only used for End Rentals</xs:documentation></xs:annotation><xs:complexType>

<xs:sequence><xs:element name="DispositionCode"

type="xs:string"/><xs:element name="DispositionDescription"

type="xs:string"/></xs:sequence>


</xs:sequence><xs:attribute name="RecordType" type="xs:string" use="required">

<xs:annotation><xs:documentation>Equipment or Supply</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LineItemType" type="xs:string" use="required">

<xs:annotation><xs:documentation>Rental, Purchase, Finance</xs:documentation>

</xs:annotation></xs:attribute>



</xs:element></xs:sequence><xs:attribute name="Version" type="xs:decimal" use="required"/>

</xs:complexType>

Date: April 10, 2014 52

Version: 2.13



</xs:element>

Date: April 10, 2014 53

Equipment and Supply Order Format...

Documents

Transcript of Equipment and Supply Order Format...