NEHTA Standard Message Implementation Guidelines for Health e-Procurement

Part 3: GS1 XML Despatch Messages
Version 1 - 12/05/2008 Final Release

National E-Health Transition Authority

NEHTA Standard Message Implementation Guidelines for Health e-Procurement

Part 3: GS1 XML Despatch Messages

National E-Health Transition Authority Ltd Level 25 56 Pitt Street Sydney, NSW, 2000 Australia. www.nehta.gov.au

Disclaimer NEHTA makes the information and other material (“Information”) in this document available in good faith but without any representation or warranty as to its accuracy or completeness. NEHTA cannot accept any responsibility for the consequences of any use of the Information. As the Information is of a general nature only, it is up to any person using or relying on the Information to ensure that it is accurate, complete and suitable for the circumstances of its use. Security The content of this document is confidential. The information contained herein must only be used for the purpose for which it is supplied and must not be disclosed other than explicitly agreed in writing with NEHTA. Copyright © 2007, NEHTA. This document contains information which is protected by copyright. All Rights Reserved. No part of this work may be reproduced or used in any form or by any means without the permission of NEHTA. All copies of this document must include the copyright and other information contained on this page.

ii

Final Release

v1

Table of contents

Table of contents
1 Introduction ..............................................................................................1 1.1 Format - Data Sections .......................................................................... 1 1.2 XML Document Structure and Layers ....................................................... 2 1.3 Global Trade Item Numbers - GTINs ........................................................ 3 1.4 Reference documents ............................................................................ 3 Header Elements .......................................................................................4 2.1 Header Version..................................................................................... 4 2.2 Sender ................................................................................................ 5 2.3 Authority ............................................................................................. 5 2.4 Sender Name ....................................................................................... 6 2.5 Sender Email Address............................................................................ 7 2.6 Sender Fax Number .............................................................................. 8 2.7 Sender Phone Number ........................................................................... 8 2.8 Receiver .............................................................................................. 9 2.9 Authority ........................................................................................... 10 2.10 Receiver Name ................................................................................... 11 2.11 Receiver Email Address........................................................................ 11 2.12 Receiver Fax Number .......................................................................... 12 2.13 Receiver Phone Number ....................................................................... 13 2.14 Message Document Standard................................................................ 13 2.15 Message Document Type Version .......................................................... 14 2.16 Message Document Identification .......................................................... 15 2.17 Message Document Type ..................................................................... 16 2.18 Message Document Multiple Types Included............................................ 17 2.19 Message Document Creation Date ......................................................... 17 2.20 Business Scope Type ........................................................................... 18 2.21 Business Scope Identifier ..................................................................... 19 2.22 “Any” ................................................................................................ 19 Message Layer Elements .......................................................................... 21 3.1 Message ............................................................................................ 22 3.1.1 Message: <any>..................................................................... 22 3.1.2 Message: Identifier.................................................................. 22 3.1.3 Message: Owner ..................................................................... 23 3.2 Transaction ........................................................................................ 24 3.2.1 Transaction: Command ............................................................ 24 3.2.2 Transaction: Identifier ............................................................. 24 3.2.3 Transaction: Owner ................................................................. 25 3.3 Document Command ........................................................................... 26 3.3.1 Document Command element ................................................... 26 3.3.2 Document Command: Business Document .................................. 26 3.3.3 Document Command: Type ...................................................... 27 3.3.4 Document Command: Identifier ................................................ 28 3.3.5 Document Command: Owner .................................................... 28 Business Document Layer Message Elements........................................... 30 4.1 Comments ......................................................................................... 30 4.1.1 Item Perspective vs Packaging Perspective.................................. 30 4.1.2 Expiry Dates, Lot Numbers etc. ................................................. 30 4.1.3 Original Purchase Order Reference............................................. 31 4.1.4 Despatch Advice vs Advance Shipping Notice .............................. 31 4.1.5 Supporting Documents............................................................. 31 4.2 Message Function ............................................................................... 31
Final Release iii

2

3

4

v1

.....................................................1 Delivery Note (Header Level) ..7 Latest Delivery Date/Time .... Unique Product Identifier ...................................20..3 Actual Ship Date ...... 4............................................................10 4......................................12. Requested Item Identifier .2 Transport Mode ................................... 4.................................................. 4..5 Latest Delivery Date ..... 4........... Order Date ....5..................... 4...............................................4 Delivery Note Date (Detail Level) ............5....... 4.............................................................20..... Quantity per Package . 4................ Additional Information......................................... 4...................... 4......17 4............12 4...............................5.................... 4................. Order Number ....30 Last Update Date..........................6 Earliest Delivery Date/Time .......... Package Identification .21 4....20 4.........11...............12...................................... 4................................................................................................................................................12...23 4........5. Packaging Type .7 Consignment Note Date (Header Level).......5........................................11........................... Buyer........................................... Order Creator................5 Delivery Note Line Number (Detail Level) ..........18 4.................. 4.6 4..5.......................................................................................................... Supplier Product Code .....................11.......4 4......................................................3 Bill of Lading ..............................................................2 Delivery Note Date (Header Level)............20. 4..27 4........................................................3 4............... Despatched Quantities......9 4........................................16 4..7 4.......... 4................................14 4........................... Ordered Quantity.........................................13 4... 4......................................................................11............................15 4...... Despatch Advice Reference Number ..................................................................................... Equipment Details ............3 Delivery Note (Detail Level).... Package Measurements ........ 4.............................................................5......................................... 4........................ 4........................12....................................1 Parent Packaging Level .........................24 4. Packaging Level........................ 4..........18................................................. 4................11....17.....NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4............................1 Comments .................................................................................12.. Despatch Advice Date .........11 4...........................................................................5........20..........................4 Earliest Delivery Date ......... 33 35 36 38 39 39 40 41 42 42 43 44 44 45 46 47 48 48 49 49 50 50 51 52 52 53 54 54 55 56 57 58 59 60 61 61 62 63 64 64 65 66 67 68 69 69 70 71 74 74 77 80 82 82 83 84 84 iv Final Release v1 ...............................1 Child Package Type .............. 4................................................................................................... Additional Product Information .......................11.... 4......8 Consignment Note (Detail Level) ...................................6 Package Types.................................................... Ship To Location.......... Carrier ...............10 Consignment Note Line Number (Detail Level)...5 4............3 Package: Measurement Type ............................. Line Number ........................5............................... Despatch Advice Creator...... 4...29 4.......5 Number of Packages..........1 Package Lineal Dimensions ....2 Delivery Date ............................................. 4.................22 4......................................... 4.............................8 4.................................12............................................ Delivery and Despatch Dates.... Supplier ............................26 4..............................................................9 Consignment Note Date (Detail Level)....................1 Truck Identifier ...............................................28 4................ Additional Product Information Type ...........19 4..........................6 Consignment Note (Header Level) ................................................................................................................................................................. 4...................25 4..................11.......4 Package: Unit of Measure ................................ Number of Packages ..........................................................................................................4 Bill of Lading Date ............... 4................................. 4...........................................................................................................5................................................... 4....................2 Package: Other Measurements.................................................................................................................................

.....................................................................36 4.................32 4................................................................33 4............................................. 85 Serial Numbers........................................................................................ 95 References ......... 88 Best Before Dates ........35.....................37 4.............39 5 Batch Number ....Table of contents 4..................................................................... 97 v1 Final Release v ......................... 91 4................. 94 Delivery Date: Variances........................................................35........................ 89 Order Line Number ............................... 93 Quantity Variances....................... 94 Variance Reason .....................2 Order Date .........................................1 Order Number ...................................... 86 Expiry Date ... 92 Order Creator.................................................................................................................................38 4................35 4................34 4..................31 4.................................................................................................................... 90 4.

vi Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages This page has been left blank intentionally.

v1 Final Release 1 . the data elements are listed as “subject to a change request” as there are plans to incorporate them into the GS1 XML standard. the AS5023 standard for Health Supply Chain Messaging. This document will be updated when that occurs. or are related to.2-2003 document. The GS1 XML data elements in this document are limited to those which have an equivalent in.1 Introduction This document describes the elements of the GS1 XML Order Response message that will be used by Health Jurisdictions and is intended for technical staff who have the responsibility of implementing these messages in their local systems. are specifically excluded for the sake of simplification. Group: The title in the first column of the AS5023 table. It is presumed that readers have an understanding of XML and an overview of the messages defined in Australian Standard AS5023 and GS1 XML. In some cases. Business rules may impose additional constraints. Higher level elements need to be taken into consideration in determining whether or not the element is required in a particular circumstance. Element: The Element name as given in the third column of the AS5023 table. Prefixes etc. o Section: This will be one of “Header”. or “End of Message” as per the headings of the major tables for each data set in the AS5023 document. 1.Data Sections AS5023 related information is yellow Basic GS1 XML information is green Constraint information is blue Co-requisite and optional elements are unshaded In the following sections the table cells are colour coded as follows The table headings are: • AS5023 Reference This provides a link to the specific data element in the AS5023. The cardinality listed is the cardinality of the actual element or attribute at the lowest level. Note also that the constraints are based on technical rules. The GS1 XML path root is “orderResponse” and all XML paths will assume this starting point unless otherwise stated. • GS1 XML path This is a pseudo XPath to the element that will assist in locating the element within the XML tree.1 Format . “Detail”. This information will assist technical staff to correctly populate the Purchase OrderResponse message. o o • Description/Comment This is a transcription of parts of the Description and Comments columns from the AS5023 table where they help clarify the intent of the data element.

o o • Co-requisites Other elements and attributes which MUST be used if this element is used. as they all define control information about the document.) • Schema Constraints Any restrictions on the use of the data element. Sometimes they are external rules imposed by GS1 or NEHTA standards. Data Type Where possible. etc. The data type is listed after the name of the element/attribute. 2 Final Release . then typically there will be a subsection following that identifies the Attributes and Elements of that Complex Type. In some cases it is the Complex Type with further details of the component attributes and elements provided in other sections of the document. o o Mandatory An item can be mandatory based on external GS1 or NEHTA rules in addition to the schema rules. orderHeaderIndicator. Details of these elements are given Header Elements section. Cardinality The cardinality of the specific element. or “Complex Type”. the Message Layer elements must be wrapped in the UN/CEFACT Standard Business Document. • Comments Any other information that will assist in the population of the data element. the allowable values of a list element. • Optional Elements Other data elements and attributes which MAY be used if this element is used. (In some cases. AS5023 information is not relevant to the Header or Message Layer elements. “Element”. the co-requisites for documentStatus included contentVersion. this is the simple XML data type. For example. For example. Sometimes these constraints are inherent within the schema. multiShipmentOrderLIneItem was not included even though it is a mandatory element and is at the same XML level as it defined the contents of the document. When related elements are referred to. Other constraints are listed following the Cardinality restraint. Note that the cardinality of parent elements also influence how the element is used. Message Layer elements. a functional bias has been taken in deciding which elements to include or exclude. The data type is listed after the name of the element/attribute. In turn.2 XML Document Structure and Layers The Order Response Message elements must be wrapped in the Message Layer element: message. the source of these comments come from NEHTA documents. 1.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages • Basic Type One of “Attribute”. particularly in the Co-requisites and Optional Elements sections. The following diagram shows the relationship between the Header elements. and the Order Response Message elements. If it is a Complex Type.

For example. 9312345678901 becomes 09312345678901.GTINs Global Trade Item Numbers are used extensively to identify items.3 Global Trade Item Numbers . v1 Final Release 3 . This field MUST contain a 14 digit number.4 Reference documents The information in this document is based the documents identified in the Reference Section. or 13 digit GTINs. 12.Standard Business Document Standard Business Document Header Message Transaction Command Despatch Advice Message 1. so a ‘filler 0’ must be added to the front of the number if they are 8. This does not change the number at all. 1. it is simply a non-significant digit added so this will pass schema validation.

GS1 has specified additional constraints to those in the UN/CEFACT schema when being used in the GS1 XML context. the GS1 XML path root is: StandardBusinessDocument (XPath: StandardBusinessDocument) All XML paths will assume this starting point unless otherwise stated. String 1.1 Header Version Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader HeaderVersion Element This is the version number of the SBDH standard. 2. and used by GS1 to envelope the business documents such as the Multi Shipment Order. The Standard Business Document Header schema is specified by UN/CEFACT.0’ Co-requisites StandardBusinessDocumentHeader StandardBusinessDocumentHeader StandardBusinessDocumentHeader StandardBusinessDocumentHeader Sender (Partner) Receiver (Partner) DocumentIdentification (DocumentIdentification) BusinessScope (BusinessScope) Optional Elements 4 Final Release v1 . NEHTA has further specified additional constraints to both of these for use in Health Sector Supply Chain messaging..1 Must be set to ‘1. Mandatory: Data Type: Cardinality: Yes – GS1 constraint.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 2 Header Elements In this section.

Header Elements

2.2

Sender
Section: Group: Element:

AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints

StandardBusinessDocumentHeader Sender Identifier

Element GS1 places additional constraints on the original UN/CEFACT schema definition.
Mandatory: Data Type: Cardinality:

Yes Global Location Number 1..1

Only one Sender element can be used even though the schema allows for multiple elements. The Sender Identifier must be the GLN of the sending organisation. The optional ContactInformation element should be used although optional in the UN/CEFACT schema definition, and should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.
Co-requisites (Relative to StandardBusinessDocumentHeader Sender)

Identifier Authority (Attribute - string) ContactInformation Contact (string) ContactInformation EmailAddress (string) ContactInformation FaxNumber (string) ContactInformation TelephoneNumber (string)
Optional Elements (Relative to StandardBusinessDocumentHeader Sender)

ContactInformation ContactTypeIdentifier (string)

2.3

Authority
Section: Group: Element:

AS5023 Reference Description/Comments

v1

Final Release

5

NEHTA Standard Message Implementation Guidelines for Health e-Procurement

Part 3: GS1 XML Despatch Messages

GS1 XML Path Basic Type Comments Schema Constraints

StandardBusinessDocumentHeader Sender Identifier Authority

Attribute This attribute must be used according to GS1 standards.
Mandatory: Data Type: Cardinality:

Yes string 1..1

Must be set to “EAN.UCC”
Co-requisites Optional Elements

None
None

2.4

Sender Name
Section: Group: Element:

AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints

StandardBusinessDocumentHeader Sender ContactInformation Contact

Element Should be used even though it is optional in the UN/CEFACT schema definition.
Mandatory: Data Type: Cardinality:

Yes string 1..1

Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.

6

Final Release

v1

Header Elements

Co-requisites

(Relative to StandardBusinessDocumentHeader Sender ContactInformation)

EmailAddress (string) FaxNumber (string) TelephoneNumber (string)
Optional Elements

ContactTypeIdentifier (string)

2.5

Sender Email Address
Section: Group: Element:

AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints

StandardBusinessDocumentHeader Sender ContactInformation

EmailAddress

Element Should be used even though it is optional in the UN/CEFACT schema definition.
Mandatory: Data Type: Cardinality:

Yes string 1..1

Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.
Co-requisites (Relative to StandardBusinessDocumentHeader Sender ContactInformation)

Contact (string) FaxNumber (string) TelephoneNumber (string)
Optional Elements

ContactTypeIdentifier (string)

v1

Final Release

7

.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 2.6 Sender Fax Number Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Sender ContactInformation FaxNumber Element Should be used even though it is optional in the UN/CEFACT schema definition.1 Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.7 Sender Phone Number Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Sender ContactInformation TelephoneNumber Element Should be used even though it is optional in the UN/CEFACT schema definition. Co-requisites (Relative to StandardBusinessDocumentHeader Sender ContactInformation) Contact (string) EmailAddress (string) TelephoneNumber (string) Optional Elements ContactTypeIdentifier (string) 2. Mandatory: Data Type: Cardinality: Yes string 1. Mandatory: Yes 8 Final Release v1 .

1 Only one Receiver element can be used even though the schema allows for multiple elements.8 Receiver Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Receiver Identifier Element GS1 places additional constraints on the original UN/CEFACT schema definition.Header Elements Data Type: Cardinality: string 1. The optional ContactInformation element should be used although optional in the UN/CEFACT schema definition. and should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery. v1 Final Release 9 .. Co-requisites (Relative to StandardBusinessDocumentHeader Sender ContactInformation) Contact (string) EmailAddress (string) FaxNumber (string) Optional Elements ContactTypeIdentifier (string) 2.. The Receiver Identifier must be the GLN of the sending organisation. Mandatory: Data Type: Cardinality: Yes Global Location Number 1.1 Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.

9 Authority Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Receiver Identifier Authority Attribute This attribute must be used according to GS1 standards. Mandatory: Data Type: Cardinality: Yes string 1.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to StandardBusinessDocumentHeader Receiver) Identifier Authority (Attribute ..1 Must be set to “EAN.UCC” Co-requisites Optional Elements None None 10 Final Release v1 .string) ContactInformation Contact (string) ContactInformation EmailAddress (string) ContactInformation FaxNumber (string) ContactInformation TelephoneNumber (string) Optional Elements (Relative to StandardBusinessDocumentHeader Receiver) ContactInformation ContactTypeIdentifier (string) 2.

10 Receiver Name Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Receiver ContactInformation Contact Element Should be used even though it is optional in the UN/CEFACT schema definition. Mandatory: Data Type: Cardinality: Yes string 1.. Mandatory: Yes v1 Final Release 11 . Co-requisites (Relative to StandardBusinessDocumentHeader Receiver ContactInformation) EmailAddress (string) FaxNumber (string) TelephoneNumber (string) Optional Elements ContactTypeIdentifier (string) 2.1 Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.Header Elements 2.11 Receiver Email Address Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Receiver ContactInformation EmailAddress Element Should be used even though it is optional in the UN/CEFACT schema definition.

1 Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery.1 Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery. Co-requisites (Relative to StandardBusinessDocumentHeader Receiver ContactInformation) Contact (string) EmailAddress (string) TelephoneNumber (string) Optional Elements ContactTypeIdentifier (string) Final Release v1 12 ... Co-requisites (Relative to StandardBusinessDocumentHeader Receiver ContactInformation) Contact (string) FaxNumber (string) TelephoneNumber (string) Optional Elements ContactTypeIdentifier (string) 2.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Data Type: Cardinality: string 1.12 Receiver Fax Number Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Receiver ContactInformation FaxNumber Element Should be used even though it is optional in the UN/CEFACT schema definition. Mandatory: Data Type: Cardinality: Yes string 1.

13 Receiver Phone Number Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader Receiver ContactInformation TelephoneNumber Element Should be used even though it is optional in the UN/CEFACT schema definition. Co-requisites (Relative to StandardBusinessDocumentHeader Receiver ContactInformation) Contact (string) EmailAddress (string) FaxNumber (string) Optional Elements ContactTypeIdentifier (string) 2. Mandatory: Data Type: Cardinality: Yes string 1.Header Elements 2.14 Message Document Standard Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments StandardBusinessDocumentHeader DocumentIdentification Standard Element GS1 places additional constraints on the original UN/CEFACT schema definition..1 Should hold details of a technical contact in the sending organisation who is able to address issues concerning message delivery. Final Release 13 v1 .

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Schema Constraints Mandatory: Data Type: Cardinality: Yes string 1.4” 14 Final Release v1 .1 Must be set to the version number of the despatchAdvice schema e.g.UCC” Co-requisites (Relative to StandardBusinessDocumentHeader DocumentIdentification) TypeVersion (string) InstanceIdentifier (string) Type (string) MultipleType (boolean) CreationDateAndTime (dateTime) Optional Elements None 2.. “2.15 Message Document Type Version Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader DocumentIdentification TypeVersion Element GS1 places additional constraints on the original UN/CEFACT schema definition..1 Must be set to “EAN. Mandatory: Data Type: Cardinality: Yes string 1.

16 Message Document Identification Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader DocumentIdentification InstanceIdentifier Element GS1 places additional constraints on the original UN/CEFACT schema definition. or if a specific business document is transmitted multiple times. v1 Final Release 15 . not the business document contained within the message. That is.. Mandatory: Data Type: Cardinality: Yes String 1.Header Elements Co-requisites (Relative to StandardBusinessDocumentHeader DocumentIdentification) Standard (string) InstanceIdentifier (string) Type (string) MultipleType (boolean) CreationDateAndTime (dateTime) Optional Elements None 2. This element is used to identify the whole message being transmitted.1 This element must uniquely identify the instance of the Standard Business Document. no two transmissions will have the same identifier regardless of the type of business document contained.

) Co-requisites (Relative to StandardBusinessDocumentHeader DocumentIdentification) Standard (string) TypeVersion (string) InstanceIdentifier (string) MultipleType (boolean) CreationDateAndTime (dateTime) Optional Elements None 16 Final Release v1 . (The name of the root element in the payload document.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to StandardBusinessDocumentHeader DocumentIdentification) Standard (string) TypeVersion (string) Type (string) MultipleType (boolean) CreationDateAndTime (dateTime) Optional Elements None 2. Mandatory: Data Type: Cardinality: Yes string 1..17 Message Document Type Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader DocumentIdentification Type Element GS1 places additional constraints on the original UN/CEFACT schema definition.1 Must be set to “multiShipmentOrder”.

18 Message Document Multiple Types Included Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader DocumentIdentification MultipleType Element GS1 places additional constraints on the original UN/CEFACT schema definition.19 Message Document Creation Date Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments StandardBusinessDocumentHeader DocumentIdentification CreationDateAndTime Element GS1 places additional constraints on the original UN/CEFACT schema definition.) Co-requisites (Relative to StandardBusinessDocumentHeader DocumentIdentification) Standard (string) TypeVersion (string) InstanceIdentifier (string) Type (string) CreationDateAndTime (dateTime) Optional Elements None 2. v1 Final Release 17 . Mandatory: Data Type: Cardinality: Yes boolean 1.. (NEHTA standard – only one business document should be sent per transmission.1 Must be set to “false”.Header Elements 2.

Co-requisites (Relative to StandardBusinessDocumentHeader DocumentIdentification) Standard (string) TypeVersion (string) InstanceIdentifier (string) Type (string) MultipleType (boolean) Optional Elements None 2..1 Must be set to “NEHTA:E-Procurement” Co-requisites Optional Elements StandardBusinessDocumentHeader BusinessScope Scope InstanceIdentifier StandardBusinessDocumentHeader BusinessScope Scope Identifier 18 Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Schema Constraints Mandatory: Data Type: Cardinality: Yes dateTime 1. Mandatory: Data Type: Cardinality: Yes String 1..1 Must be set to the date and time that the source Purchase Order was approved/verified in the original system.20 Business Scope Type Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader BusinessScope Scope Type Element NEHTA standards mandate the use of this element although it is optional in the UN/CEFACT schema definition.

Co-requisites Optional Elements StandardBusinessDocumentHeader BusinessScope Scope Type StandardBusinessDocumentHeader BusinessScope Scope Identifier 2. Mandatory: Data Type: Cardinality: Schema Constraints Must be replaced with “message”.0 which is the current version of this guideline. v1 Final Release 19 ..1 Must be set to 1. It must be replaced by the “message” element from the Message Layer group of schema. Mandatory: Data Type: Cardinality: Yes String 1.21 Business Scope Identifier Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints StandardBusinessDocumentHeader BusinessScope Scope InstanceIdentifier Element NEHTA standards mandate the use of this element although it is optional in the UN/CEFACT schema definition.22 “Any” Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments <any> This is the place holder for the GS1 XML constructs. See the Message Layer section.Header Elements 2.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites Optional Elements StandardBusinessDocumentHeader None 20 Final Release v1 .

The lowest is the documentCommand element which wraps around the despatchAdvice.) In summary. the links between the layers are: message any transaction command documentCommand document despatchAdvice v1 Final Release 21 . The Message Layer has three sub-layers. the transaction element replaces an any element in the message element.Message Layer Elements 3 Message Layer Elements In this section. (Refer to Standard Business Document Header (SBDH) Technical Implementation Guide for further details on their usage. Finally. The documentCommand element itself replaces an abstract command element in the transaction element. the GS1 XML path root is: StandardBusinessDocument message (XPath: StandardBusinessDocument / eanucc:message) All XML paths will assume this starting point unless otherwise stated. despatchAdvice replaces an abstract document element within the documentCommand element.

1 Message Message: <any> Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints <any> XML type “any” This is the place holder for the “transaction” element.1.* Co-requisites Optional Elements entityIdentification (EntityIdentificationType) None 3.. It is redundant information and is not required for processing by either the buyer or the seller.1.1 (NEHTA requirement) Cardinality as defined in the GS1 XML standard is 1.. easy access to the Despatch Number without having to decode the entire XML document.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 3. Mandatory: Schema Constraints Yes 22 Final Release v1 .2 Message: Identifier Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments entityIdentification uniqueCreatorIdentification Element Must be set to the Despatch Number as per the uniqueCreatorIdentification element in the despatchAdvice element.. Mandatory: Data Type: Cardinality: Yes any 1.1 3. This is to allow messaging hubs etc.

.1 Co-requisites Optional Elements entityIdentification uniqueCreatorIdentification (Global Location Number) (Relative to entityIdentification contentOwner) entityIdentification contentOwner additionalPartyIdentification additionalPartyIdentificationValue (string) entityIdentification contentOwner additionalPartyIdentification additionalPartyIdentificationType (list) v1 Final Release 23 .3 Message: Owner Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints entityIdentification contentOwner gln Mandatory: Data Type: Cardinality: Yes Global Location Number 1.1 Co-requisites (Relative to entityIdentification contentOwner) gln (Global Location Number) Optional Elements (Relative to entityIdentification contentOwner) additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) 3.1..Message Layer Elements Data Type: Cardinality: string 1.

(It is one of three elements in the command substitution group. and should be distinct from all other identifiers used in the message.2 Transaction: Identifier Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments transaction entityIdentification uniqueCreatorIdentification Element This identifies the transaction.) Mandatory: Data Type: Cardinality: Schema Constraints Yes command 1.2. (Note: a prefix such as “TRA” is one way to ensure it is distinct.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 3.2 3.* Co-requisites Optional Elements transaction entityIdentification (EntityIdentificationType) None 3. and the one that is required for multiShipmentOrders.1 Cardinality as defined in the GS1 XML standard is 1.2...1 Transaction Transaction: Command Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments transaction ”command” abstract element This abstract element is replaced by the documentCommand element.) Mandatory: Schema Constraints Yes 24 Final Release v1 .

2.1 Co-requisites Optional Elements Transaction entityIdentification uniqueCreatorIdentification (Global Location Number) (Relative to transaction entityIdentification contentOwner) additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) v1 Final Release 25 .3 Transaction: Owner Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Transaction entityIdentification contentOwner gln Mandatory: Data Type: Cardinality: Yes Global Location Number 1...Message Layer Elements Data Type: Cardinality: string 1.1 Co-requisites (Relative to transaction entityIdentification contentOwner) gln (Global Location Number) Optional Elements (Relative to transaction entityIdentification contentOwner) additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) 3.

1 Co-requisites Optional Elements None None 3.3. Mandatory: Data Type: Cardinality: Schema Constraints Yes complex element 1.2 Document Command: Business Document Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints transaction command documentCommand documentCommandOperand document abstract element This element is replaced with the Business Document payload i. despatchAdvice Mandatory: Data Type: Yes abstract document 26 Final Release v1 .e. documentCommand is one element in the command substitution group.3 3.3.1 Document Command Document Command element Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments transaction command documentCommand Complex element This element replaces the command element in the transaction element..NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 3.

1 CORRECT DELETE Allowable values are: ADD CHANGE_BY_REFRESH ADD must be used when a new Despatch Advice is sent. CHANGE_BY_REFRESH must be used when a Despatch Advice is being changed in any way..3.. v1 Final Release 27 . CORRECT must not be used.3 Document Command: Type Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints transaction command documentCommand documentCommandHeader type Attribute Mandatory: Data Type: Cardinality: Yes List 1. DELETE must be used when the Despatch Advice is to be cancelled.Message Layer Elements Cardinality: 1..* Co-requisites (Relative to transaction command documentCommand documentCommandHeader) type (Attribute list) uniqueCreatorIdentification (string) contentOwner gln (Global Location Number) Optional Elements (Relative to transaction command documentCommand documentCommandHeader contentOwner) additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) 3.1 Cardinality as defined in the GS1 XML standard is 1.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to transaction command documentCommand documentCommandHeader) uniqueCreatorIdentification (string) contentOwner gln (Global Location Number) Optional Elements (Relative to transaction command documentCommand documentCommandHeader contentOwner) additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) 3..4 Document Command: Identifier Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments transaction command documentCommand documentCommandHeader entityIdentification uniqueCreatorIdentification Element This identifies the transaction.3. and should be distinct from all other identifiers used in the message.3. (Note: a prefix such as “CMD” is one way to ensure it is distinct.5 Document Command: Owner Section: Group: Element: AS5023 Reference 28 Final Release v1 .) Mandatory: Data Type: Cardinality: Schema Constraints Yes string 1.1 entityIdentification contentOwner) Co-requisites (Relative to transaction command documentCommand documentCommandHeader gln (Global Location Number) Optional Elements (Relative to transaction entityIdentification contentOwner) additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) 3.

.Message Layer Elements Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: transaction command documentCommand documentCommandHeader entityIdentification contentOwner gln Yes Global Location Number 1.1 Co-requisites transaction command documentCommand documentCommandHeader entityIdentification uniqueCreatorIdentification (Global Location Number) (Relative to transaction entityIdentification contentOwner) Optional Elements additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (list) v1 Final Release 29 .

To get the total quantity of a particular item in the shipment. but are related to those that are and do provide support for the AS5023 requirements. The despatchAdviceLogisticsUnitLineItem element contains elements for Expiry Dates.1 Comments This section contains comments on topics impact a number of data elements. but for some common views on the Despatch Advice.1 Item Perspective vs Packaging Perspective The Despatch XML document may be viewed from either an item perspective (despatchAdviceItemContainmentLineItem element) or a packaging perspective (despatchAdviceLogisticsUnitLineItem element). but the data in this element is about the items contained inside the nominated package. A full data set is held by this structure. and the other a quantity of 400 and Expiry Date of 31 July. However it can be derived in a similar manner to the total shipped quantity of an item. there is no list attached to an item which identifies all the packages in which it is held. 600 had an Expiry date of 30 June and 400 expired on 31 July.1.2 Expiry Dates.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4 Business Document Layer Message Elements This layer covers the Despatch Advice message. For example. 4. if in a shipment of 1. Batch Number. there must be multiple despatchAdviceLogisticsUnitLineItem elements which have the same item GTIN. This section lists additional fields that are not explicitly mentioned in the AS5023 specification. Consequently if there are multiple values for these elements for the items in the shipment. Shelf Life. Similarly. but one would have a quantity of 600 and an Expiry Date of 30 June. 4. In this section. the quantities of that item in each individual package must be summed together. Lot Numbers etc. the GS1 XML path root is: StandardBusinessDocument message transaction command documentCommand documentCommandOperand despatchAdvice (XPath: StandardBusinessDocument / eanucc:message / eanucc:transaction / command / eanucc:documentCommand / documentCommandOperand / deliver:despatchAdvice) All XML paths will assume this starting point unless otherwise stated.000 items. For example. and Serial Number. The packaging perspective does contain despatchAdviceItemContainmentLineItem as a child element. 30 Final Release v1 . the data has to be derived rather than extracted. These are all child data elements of a specific item.1. or are specified as mandatory by GS1. Best Before Dates. there would be two despatchAdviceLogisticsUnitLineItem elements. but not both. Lot Number. the packaging perspective gives the quantity of each item contained in a package. Both would have the same GTIN. 4.

1. but both the document and line number is recorded at the detail level to allow the specific item to be linked to the specific line on the Delivery or Consignment Note. 4. but only Delivery Note and Consignment Note are included in this version of the NEHTA standard.2 Message Function AS5023 Reference Description/Comments GS1 XML Path Basic Type Section: Header Group: Opening Element: Message Function documentStatus Attribute v1 Final Release 31 .1.3 Original Purchase Order Reference The AS5023 specification placed the Purchase Order number in the header and the Purchase Order Line in the details section.Business Document Layer Message Elements All of these data elements are closely related in practice.) At the header level only the document number is recorded.1. or the packaging level despatchAdviceLogisticsUnitLineItem element through the use of the despatchAdviceItemContainmentLineItem child element.1. For a Despatch Advice. and using only one mechanism will give consistency in processing. but if used then both the header and detail level elements must be used. The GS1 XML schema has complete Purchase Order reference data at both header and line level (purchaseOrder element). It is recommended that only the line level Purchase Order reference data be used as this allows a shipment to contain items from multiple Purchase Orders. For an ASN.4 Despatch Advice vs Advance Shipping Notice This same document serves as both a Despatch Advice and an Advance Shipping Notice (ASN). or at a detail level using either the item level despatchAdviceItemContainmentLineItem element. This will cover all cases. Both the Delivery Note and the Consignment Note can occur at the header level. 4. the despatchInformation actualShipping element is used. the Purchase Order reference may be with or without a Purchase Order Line Number. so there should be a combined strategy for processing them all. but not both. the despatchInformation estimatedDelivery element is used. (As per 4. either the item level or packaging level will be used. This has the effect of limiting a Despatch Advice/ASN to a single Purchase Order. In both cases.5 Supporting Documents The GS1 XML schema has elements for several supporting documents. 4. These elements are all optional based on the schema definition.1 Item Perspective vs Packaging Perspective. 4.

. then lastUpdateDate must also be entered.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Comments Schema Constraints Mandatory: Data Type: Cardinality: Yes List 1. Co-requisites creationDateTime (Attribute dateTime) despatchAdviceIdentification uniqueCreatorIdentification (string) shipTo gln (Global Location Number) receiver gln (Global Location Number) shipper gln (Global Location Number) Choice – one of: despatchInformation actualShipping actualShipDateTime (dateTime) despatchInformation estimatedDelivery estimatedDeliveryDateTime (dateTime) Note: estimatedDeliveryDateTime is itself part of a nested choice group and may be substituted by estimatedDeliveryPeriod Choice – one of: despatchAdviceLogisticUnitLineItem (DespatchAdviceLogisticUnitLineItemType) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) 32 Final Release v1 .1 Allowable values: COPY ORIGINAL REPLACE If REPLACE is used.

1 v1 Final Release 33 .3 Last Update Date AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Group: Element: Related to Message Function lastUpdateDate Attribute Yes (NEHTA Requirement) date 0..Business Document Layer Message Elements Optional Elements lastUpdateDate (Attribute date) contentVersion (VersionType) documentStructureVersion (versionType) shipFrom (PartyIdentificationType) carrier (PartyIdentificationType) pickUpLocation (PartyIdentificationType) inventoryLocation (PartyIdentificationType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) deliveryNote (ReferenceType) contract (ReferenceType) productCertification (ReferenceType) specification (ReferenceType) declarantsCustomsIdentity (ReferenceType) consignmentInformation (ConsignmentInformationType) deliveryAndTransportInformation (DeliveryAndTransportInformationType) 4.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages This attribute must be used if documentStatus = “REPLACE” Co-requisites creationDateTime (dateTime) documentStatus (list) despatchAdviceIdentification uniqueCreatorIdentification (string) shipTo gln (Global Location Number) receiver gln (Global Location Number) shipper gln (Global Location Number) Choice – one of: despatchInformation actualShipping actualShipDateTime (dateTime) despatchInformation estimatedDelivery estimatedDeliveryDateTime (dateTime) Note: estimatedDeliveryDateTime is itself part of a nested choice group and may be substituted by estimatedDeliveryPeriod Choice – one of: despatchAdviceLogisticUnitLineItem (DespatchAdviceLogisticUnitLineItemType) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) Optional Elements contentVersion (VersionType) documentStructureVersion (versionType) shipFrom (PartyIdentificationType) carrier (PartyIdentificationType) pickUpLocation (PartyIdentificationType) inventoryLocation (PartyIdentificationType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) deliveryNote (ReferenceType) contract (ReferenceType) productCertification (ReferenceType) specification (ReferenceType) declarantsCustomsIdentity (ReferenceType) consignmentInformation (ConsignmentInformationType) deliveryAndTransportInformation (DeliveryAndTransportInformationType) 34 Final Release v1 .

1 Co-requisites documentStatus (Attribute list) despatchAdviceIdentification uniqueCreatorIdentification (string) shipTo gln (Global Location Number) receiver gln (Global Location Number) shipper gln (Global Location Number) Choice – one of: despatchInformation actualShipping actualShipDateTime (dateTime) despatchInformation estimatedDelivery estimatedDeliveryDateTime (dateTime) Note: estimatedDeliveryDateTime is itself part of a nested choice group and may be substituted by estimatedDeliveryPeriod Choice – one of: despatchAdviceLogisticUnitLineItem (DespatchAdviceLogisticUnitLineItemType) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) v1 Final Release 35 .Business Document Layer Message Elements 4..4 Despatch Advice Date AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Opening Element: Despatch advice date/time Time is optional creationDateTime Attribute Yes dateTime 1.

.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements lastUpdateDate (Attribute date) contentVersion (VersionType) documentStructureVersion (versionType) shipFrom (PartyIdentificationType) carrier (PartyIdentificationType) pickUpLocation (PartyIdentificationType) inventoryLocation (PartyIdentificationType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) deliveryNote (ReferenceType) contract (ReferenceType) productCertification (ReferenceType) specification (ReferenceType) declarantsCustomsIdentity (ReferenceType) consignmentInformation (ConsignmentInformationType) deliveryAndTransportInformation (DeliveryAndTransportInformationType) 4.5 Despatch Advice Reference Number AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Despatch advice reference number Element: Despatch advice reference number despatchAdviceIdentification uniqueCreatorIdentification Element Yes string 1.1 36 Final Release v1 .

Co-requisites contentOwner gln (Global Location Number) documentStatus (Attribute list) creationDateTime (Attribute dateTime) shipTo gln (Global Location Number) receiver gln (Global Location Number) shipper gln (Global Location Number) Choice – one of: despatchInformation actualShipping actualShipDateTime (dateTime) despatchInformation estimatedDelivery estimatedDeliveryDateTime (dateTime) Note: estimatedDeliveryDateTime is itself part of a nested choice group and may be substituted by estimatedDeliveryPeriod Choice – one of: despatchAdviceLogisticUnitLineItem (DespatchAdviceLogisticUnitLineItemType) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) v1 Final Release 37 .Business Document Layer Message Elements This identifier is maintained by the Seller and should uniquely identify the Depatch Advice.

1.1 Delivery Note (Header Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Related to Despatch Advice Reference Number deliveryNote referenceIdentification Element If used. (See 4.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements (Relative to despatchAdviceIdentification contentOwner additionalPartyIdentification) additionalPartyIdentificationValue (string) additionalPartyIdentificationType (AdditionalPartyIdentificationListType) lastUpdateDate (Attribute date) contentVersion (VersionType) documentStructureVersion (versionType) shipFrom (PartyIdentificationType) carrier (PartyIdentificationType) pickUpLocation (PartyIdentificationType) inventoryLocation (PartyIdentificationType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) deliveryNote (ReferenceType) contract (ReferenceType) productCertification (ReferenceType) specification (ReferenceType) declarantsCustomsIdentity (ReferenceType) consignmentInformation (ConsignmentInformationType) deliveryAndTransportInformation (DeliveryAndTransportInformationType) 4. then is must be used at both the header and detail levels.5 Supporting Documents) 38 Final Release v1 .5.

.1 Co-requisites Optional Elements deliveryNote referenceIdentification (string) None 4.5.5 Supporting Documents) Mandatory: Data Type: Cardinality: No dateTime 1.2 Delivery Note Date (Header Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Related to Despatch Advice Reference Number deliveryNote referenceDateTime Element If used. then is must be used at both the header and detail levels.1.Business Document Layer Message Elements Schema Constraints Mandatory: Data Type: Cardinality: No string 1. (See 4..3 Delivery Note (Detail Level) Section: Group: Element: AS5023 Reference Description/Comments Related to Despatch Advice Reference Number v1 Final Release 39 .5.1 Co-requisites Optional Elements deliveryNote referenceDateTime (dateTime) None 4.

1 40 Final Release v1 .1 despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Co-requisites (Relative to or deliveryNote reference referenceDateTime (dateTime) number (Non-negative Integer) Optional Elements None 4. (See 4.5 Supporting Documents) Mandatory: Data Type: Cardinality: No string 1. then is must be used at both the header and detail levels.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) deliveryNote reference referenceIdentification Basic Type Comments Schema Constraints Element If used.1.4 Delivery Note Date (Detail Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch Advice Reference Number (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) deliveryNote reference referenceDateTime Basic Type Comments Schema Constraints Element If used. then is must be used at both the header and detail levels.5 Supporting Documents) Mandatory: Data Type: Cardinality: No dateTime 1.1..5. (See 4..

5 Supporting Documents) Mandatory: Data Type: Cardinality: No Non-negative Number 1..1.5 Delivery Note Line Number (Detail Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch Advice Reference Number (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) deliveryNote number Basic Type Comments Schema Constraints Attribute Delivery Note Line Number is not available at the header level.1 despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Co-requisites (Relative to or reference referenceIdentification (string) deliveryNote reference referenceDateTime (dateTime) deliveryNote Optional Elements None v1 Final Release 41 .5. (See 4.Business Document Layer Message Elements Co-requisites (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) deliveryNote reference referenceIdentification (string) deliveryNote number (Non-negative Integer) Optional Elements None 4.

5 Supporting Documents) Mandatory: Data Type: No DateTime 42 Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4.5 Supporting Documents) Mandatory: Data Type: Cardinality: No string 1. then is must be used at both the header and detail levels.7 Consignment Note Date (Header Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Related to Despatch Advice Reference Number consignmentInformation consignmentInformation consignmentIdentification referenceDateTime Element If used. (See 4.5. (See 4.1 Co-requisites (Relative to consignmentInformation) consignmentIdentification referenceDateTime (dateTime) packageInformation numberOfUnits (integer) Optional Elements consignedItemWeight (ConsignedItemWeightType) unitMeasurement (UnitMeasurementType) 4..6 Consignment Note (Header Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Related to Despatch Advice Reference Number consignmentInformation consignmentIdentification referenceIdentification Element If used.1. then is must be used at both the header and detail levels.5.1.

then is must be used at both the header and detail levels..5 Supporting Documents) Mandatory: Data Type: Cardinality: No string 1.1 despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Co-requisites (Relative to or consignment consignment Optional Elements reference referenceDateTime (dateTime) number (Non-negative Integer) None v1 Final Release 43 .Business Document Layer Message Elements Cardinality: 1.1.8 Consignment Note (Detail Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch Advice Reference Number (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) consignment Basic Type Comments Schema Constraints reference referenceIdentification Element If used.1 Co-requisites (Relative to consignmentInformation) consignmentIdentification referenceIdentification (string) packageInformation numberOfUnits (integer) Optional Elements None 4.. (See 4.5.

5 Supporting Documents) Mandatory: Data Type: Cardinality: No DateTime 1.1 despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Co-requisites (Relative to or consignment reference referenceIdentification (string) consignment Optional Elements number (Non-negative Integer) None 4.5 Supporting Documents) Final Release v1 44 . (See 4. (See 4.10 Consignment Note Line Number (Detail Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch Advice Reference Number (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) consignment number Basic Type Comments Attribute Consignment Note Line Number is not available at the header level.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4.5.1..9 Consignment Note Date (Detail Level) Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch Advice Reference Number (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) consignment reference Basic Type Comments Schema Constraints referenceDateTime Element If used.5.1. then is must be used at both the header and detail levels.

.Business Document Layer Message Elements Schema Constraints Mandatory: Data Type: Cardinality: No Non-negative Integer 1. Required by GS1.6 Despatch Advice Creator AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Group: Element: Related to Despatch Advice Reference Number. despatchAdviceIdentification contentOwner gln Element Yes Global Location Number 1.1 despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Co-requisites (Relative to or consignment reference referenceIdentification (string) consignment reference referenceDateTime (dateTime) Optional Elements None 4..1 v1 Final Release 45 .

7 Order Number AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Order details Element: Order Number purchaseOrder documentReference uniqueCreatorIdentification Element No string 1..1 46 Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites uniqueCreatorIdentification (string) documentStatus (Attribute list) creationDateTime (Attribute dateTime) shipTo gln (Global Location Number) receiver gln (Global Location Number) shipper gln (Global Location Number) Choice – one of: despatchInformation actualShipping actualShipDateTime (dateTime) despatchInformation estimatedDelivery estimatedDeliveryDateTime (dateTime) Note: estimatedDeliveryDateTime is itself part of a nested choice group and may be substituted by estimatedDeliveryPeriod Choice – one of: despatchAdviceLogisticUnitLineItem (DespatchAdviceLogisticUnitLineItemType) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) Optional Elements (Relative to despatchAdviceIdentification contentOwner additionalPartyIdentification) additionalPartyIdentificationValue (string) additionalPartyIdentificationType (AdditionalPartyIdentificationListType) 4.

8 Order Date AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Order Details Element: Order date purchaseOrder documentReference creationDateTime Attribute No dateTime 1.1 Co-requisites (Relative to purchaseOrder documentReference) uniqueCreatorIdentification (string) contentOwner gln (Global Location Number) v1 Final Release 47 .Business Document Layer Message Elements purchaseOrder is a complex type which has a choice grouping of documentReference and documentLineReference. (The purchaseOrder structure also exists at the Despatch Advice Line level which can be used to link specific items on the despatch list to specific lines on the original Purchase Order.) Co-requisites (Relative to purchaseOrder documentReference) creationDateTime (dateTime) contentOwner gln (Global Location Number) Optional Elements (Relative to purchaseOrder documentReference) additionalPartyIdentificationValue (string) additionalPartyIdentificationType (AdditionalPartyIdentificationListType) 4. Only documentReference should be used at the header level to identify the Purchase Order..

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements (Relative to purchaseOrder documentReference) additionalPartyIdentificationValue (string) additionalPartyIdentificationType (AdditionalPartyIdentificationListType) 4..10 Carrier AS5023 Reference Description/Comments Section: Heaer Group: Carrier Element: Carrier reference number This identifies the carrier used.9 Order Creator AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Group: Element: Related to Order Number .Required by GS1 purchaseOrder documentReference contentOwner gln Element No Global Location Number 1.1 Co-requisites (Relative to purchaseOrder documentReference) uniqueCreatorIdentification (string) creationDateTime (dateTime) Optional Elements (Relative to purchaseOrder documentReference) additionalPartyIdentificationValue (string) additionalPartyIdentificationType (AdditionalPartyIdentificationListType) 4. 48 Final Release v1 .

estimatedDeliveryDateTime is mandatory and all other elements are optional..1 Comments The delivery date is located within two elements which form a choice group: estimatedDelivery and actualShipping. actualShipDateTime is mandatory and all other elements are optional.1 Co-requisites Optional Elements None (Relative to carrier) additionalPartyIdentificationValue (string) additionalPartyIdentificationType (AdditionalPartyIdentificationListType) 4. The estimatedDelivery element should be used unless there is a specific request by the buyer for Actual Shipping data. the component elements behave identically in both parent elements.11. In estimatedDelivery. In actualShipping. These two elements also hold the actual shipping date. Element paths are stated as relative to either of the parent elements as the name of the parent element is the only difference. Each holds the same information but from a different perspective.11 Delivery and Despatch Dates 4. The following section describes the component elements just once for both parent elements: estimatedDelivery and actualShipping.Business Document Layer Message Elements GS1 XML Path Basic Type Comments Schema Constraints carrier gln Element Mandatory: Data Type: Cardinality: No Global Location Number 1. v1 Final Release 49 . Except as noted.

1 Comments) estimatedDeliveryPeriod (TimeOrDateTimePeriod) 4.1 in actualShipping Co-requisites Optional Elements Refer to 4.2 Delivery Date Section: AS5023 Reference Description/Comments GS1 XML Path Header Group: Delivery and despatch Element: Despatch date (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryDateTime Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Element No dateTime 1.11..11.11.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4..1 Comments (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) actualShipDateTime (dateTime) (Refer to 4.1 in estimatedDelivery 0.3 Actual Ship Date Section: AS5023 Reference Description/Comments GS1 XML Path Header Group: Delivery and despatch Element: Despatch date (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) actualShipDateTime Basic Type Element Final Release v1 50 .11.

Business Document Layer Message Elements Comments Schema Constraints Mandatory: Data Type: Cardinality: No dateTime 0.11.1 Comments) estimatedDeliveryPeriod (TimeOrDateTimePeriod) 4..1 Comments (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryDateTime (dateTime) (Refer to 4..1 in actualShipping Co-requisites Optional Elements Refer to 4. v1 Final Release 51 . They are a choice group.11.4 Earliest Delivery Date Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch and Delivery Dates (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryPeriod timePeriod beginDate Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Attribute No date 1.1 in estimatedDelivery 1.11.1 The timePeriod and dateTimePeriod elements cannot both be used together..

6 Earliest Delivery Date/Time Section: Group: Element: AS5023 Reference Description/Comments Related to Despatch and Delivery Dates 52 Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryPeriod timePeriod endDate Optional Elements None 4.11.1 despatchInformation estimatedDelivery despatchInformation actualShipping) The timePeriod and dateTimePeriod elements cannot both be used together. They are a choice group. Co-requisites (Relative to either or estimatedDeliveryPeriod timePeriod beginDate Optional Elements None 4.5 Latest Delivery Date Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch and Delivery Dates (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryPeriod timePeriod endDate Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Attribute No date 1..11.

They are a choice group. v1 Final Release 53 .11.1 The timePeriod and dateTimePeriod elements cannot both be used together.Business Document Layer Message Elements GS1 XML Path (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryPeriod dateTimePeriod beginDateTime Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Attribute No dateTime 1. Co-requisites (Relative to either or estimatedDeliveryPeriod dateTimePeriod endDateTime Optional Elements None 4..7 Latest Delivery Date/Time Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Despatch and Delivery Dates (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryPeriod dateTimePeriod endDateTime Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Attribute No dateTime 1..1 despatchInformation estimatedDelivery despatchInformation actualShipping) The timePeriod and dateTimePeriod elements cannot both be used together. They are a choice group.

1 Co-requisites Optional Elements Refer to individual elements Refer to individual elements 4.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to either or despatchInformation estimatedDelivery despatchInformation actualShipping) estimatedDeliveryPeriod dateTimePeriod beginDateTime Optional Elements None 4.12.12 Equipment Details AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Section: Header Group: Delivery and despatch Element: Equipment details Container numbers. Note also the serialShippingContainerCode element which is linked to the AS5023 data element Package identification. deliveryAndTransportInformation is a complex element that provides a number of such elements.1 Truck Identifier Section: AS5023 Reference Description/Comments Header Group: Delivery and despatch Element: Equipment details Refer to Equipment Details 54 Final Release v1 . Mandatory: Data Type: Cardinality: Schema Constraints No 0.. Details of individual elements follow. truck identifiers deliveryAndTransportInformation Complex Element AS5023 does not provide details on specific equipment details.

1 v1 Final Release 55 ..2 Transport Mode Section: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Header Group: Delivery and despatch Element: Equipment details Refer to Equipment Details deliveryAndTransportInformation modeOfTransport Element Mandatory: Data Type: Cardinality: No List 0.Business Document Layer Message Elements GS1 XML Path Basic Type Comments Schema Constraints deliveryAndTransportInformation licensePlate Element There are no formatting constraints applied to this element.1 Co-requisites Optional Elements None deliveryAndTransportInformation deliveryAndTransportInformation deliveryAndTransportInformation deliveryAndTransportInformation deliveryOfTransportTerms (INCOTERMS code) modeOfTransport (list) billOfLadingNumber referenceDateTime (dateTime) billOfLadingNumber referenceIdentification (string) 4.. Mandatory: Data Type: Cardinality: No string 0.12.

12.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Allowable values are: AIR AIR_CHARTER AIR_EXPRESS AIR_FREIGHT BEST_WAY_SHIPPERS_OPTION BOOK_POSTAL BUS CAB CONSOLIDATION CONTRACT_CARRIER CUSTOMER_PICKUP CUSTOMER_PICKUP_OR_CUSTOMERS_EXPENSE EXPEDITED_TRUCK GEOGRAPHIC_RECEIVING Co-requisites Optional Elements GEOGRAPHIC_RECEIVING_SHIPPING GEOGRAPHIC_SHIPPING INLAND_WATERWAY INTERMODAL_PIGGYBACK LESS_THAN_TRUCK_LOAD MOTOR MOTOR_COMMON_CARRIER MOTOR_FLATBED MOTOR_PACKAGE_CARRIER MOTOR_TRUCKLOAD MOTOR_VAN MUTUALLY_DEFINED OCEAN PARCEL_POST PIPELINE POOL_TO_POOL POOLED_AIR POOLED_PIGGYBACK POOLED_RAIL POOLED_TRUCK PRIVATE_CARRIER PRIVATE_PARCEL_SERVICE PRIVATE_VESSEL RAIL ROADRAILER SEA_AIR STEAM_SHIP SUPPLIER_TRUCK None deliveryAndTransportInformation deliveryAndTransportInformation deliveryAndTransportInformation deliveryAndTransportInformation deliveryOfTransportTerms (INCOTERMS code) licensePlate (string) billOfLadingNumber referenceDateTime (dateTime) billOfLadingNumber referenceIdentification (string) 4.3 Bill of Lading Section: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Header Group: Delivery and despatch Element: Equipment details Refer to Equipment Details deliveryAndTransportInformation billOfLadingNumber referenceIdentification Element Mandatory: Data Type: No string Final Release v1 56 .

.1 Co-requisites deliveryAndTransportInformation billOfLadingNumber referenceIdentification (string) v1 Final Release 57 ..4 Bill of Lading Date Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Refer to Equipment Details deliveryAndTransportInformation billOfLadingNumber referenceDateTime Element Mandatory: Data Type: Cardinality: No dateTime 1.Business Document Layer Message Elements Cardinality: 1.12.1 Co-requisites Optional Elements deliveryAndTransportInformation billOfLadingNumber dateTime (dateTime) deliveryAndTransportInformation deliveryOfTransportTerms (INCOTERMS code) deliveryAndTransportInformation licensePlate (string) deliveryAndTransportInformation modeOfTransport (list) deliveryNote referenceIdentification (string) deliveryNote referenceDateTime (dateTime) consignmentInformation consignmentIdentification referenceIdentification (string) consignmentInformation packageInformation numberOfUnits (integer) 4.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements deliveryAndTransportInformation deliveryOfTransportTerms (INCOTERMS code) deliveryAndTransportInformation licensePlate (string) deliveryAndTransportInformation modeOfTransport (list) deliveryNote referenceIdentification (string) deliveryNote referenceDateTime (dateTime) consignmentInformation consignmentIdentification referenceIdentification (string) consignmentInformation packageInformation numberOfUnits (integer) 4.com/service/eancom2003/ean2003s3/experts/part3/dc8m..5 Number of Packages Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Related to Delivery and Despatch consignmentInformation packageInformation numberOfUnits Element This element is the total number of packages in the shipment. Refer to 4. Mandatory: Data Type: Cardinality: Schema Constraints No integer 1.htm Co-requisites None 58 Final Release v1 .19 Number of Packages for the number of packages contained within a larger package.gefeg. Details of this code list can be downloaded from: http://www.1 Allowable values for packageTypeDescriptionCodeValue are defined in the EANCOM element 7065.12.

htm Co-requisites consignmentInformation packageInformation numberOfUnits (integer) v1 Final Release 59 .com/service/eancom2003/ean2003s3/experts/part3/dc8m.1 Allowable values for packageTypeDescriptionCodeValue are defined in the EANCOM element 7065.6 Package Types Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Related to Despatch and Delivery consignmentInformation packageInformation packageType packageTypeDescriptionCodeValue Element Mandatory: Data Type: Cardinality: No list (Definitions in EANCOM element 7065) 0..12. Details of this code list can be downloaded from: http://www.Business Document Layer Message Elements Optional Elements consignmentInformation packageInformation packageType packageTypeDescriptionCodeValue (list) deliveryAndTransportInformation billOfLadingNumber referenceIdentification (string) deliveryAndTransportInformation deliveryOfTransportTerms (INCOTERMS code) deliveryAndTransportInformation licensePlate (string) deliveryAndTransportInformation modeOfTransport (list) deliveryNote referenceIdentification (string) deliveryNote referenceDateTime (dateTime) consignmentInformation consignmentIdentification referenceIdentification (string) consignmentInformation consignmentIdentification referenceDateTime (dateTime) 4.gefeg.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements deliveryAndTransportInformation billOfLadingNumber referenceIdentification (string) deliveryAndTransportInformation deliveryOfTransportTerms (INCOTERMS code) deliveryAndTransportInformation licensePlate (string) deliveryAndTransportInformation modeOfTransport (list) deliveryNote referenceIdentification (string) deliveryNote referenceDateTime (dateTime) consignmentInformation consignmentIdentification referenceIdentification (string) consignmentInformation consignmentIdentification referenceDateTime (dateTime) 4.13 Additional Information AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Delivery and Despatch Element: Additional delivery information deliveryAndTransportInformation deliveryOfTransportTerms Element No List DAF DDP DDU DEQ DES EXW FAS FCA FOB Allowable values are: CFR CIF CIP CPT Co-requisites None 60 Final Release v1 .

14 Buyer AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Party Identification Element: Buyer receiver gln Element Yes Global Location Number 1.1 Co-requisites shipper gln (Global Location Number) shipTo gln (Global Location Number) receiver additionalPartyIdentification additionalPartyIdentificationValue (string) receiver additionalPartyIdentification additionalPartyIdentificationType (List) Optional Elements 4.15 Supplier AS5023 Reference Description/Comments GS1 XML Path Section: Header Group: Party Identification Element: Supplier shipper gln Final Release 61 v1 .Business Document Layer Message Elements Optional Elements deliveryAndTransportInformation deliveryAndTransportInformation deliveryAndTransportInformation deliveryAndTransportInformation licensePlate (string) modeOfTransport (list) billOfLadingNumber referenceDateTime (dateTime) billOfLadingNumber referenceIdentification (string) 4..

. Co-requisites shipTo gln (Global Location Number) receiver gln (Global Location Number) despatchAdviceIdentification contentOwner gln (Global Location Number) despatchAdviceIdentification uniqueCreatorIdentification (string) shipper additionalPartyIdentification additionalPartyIdentificationValue (string) shipper additionalPartyIdentification additionalPartyIdentificationType (List) Optional Elements 4.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Basic Type Comments Schema Constraints Element The Supplier should also be the document owner in the despatchAdviceIdentification element.1 62 Final Release v1 . Mandatory: Data Type: Cardinality: Yes Global Location Number 1..16 Ship To Location AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Header Group: Party Identification Element: Ship to location shipTo gln Element Yes Global Location Number 1.1 despatchAdviceIdentification contentOwner gln must have the same value.

intermediate.1 Co-requisites Optional Elements despatchAdviceLogisticsUnitLineItem logisticUnitIdentification serialShipmentContainerCode (Relative to despatchAdviceLogisticsUnitLineItem) serialShippingContainerCode quantityOfChildren (integer) packageType packageTypeDescriptionCodeValue (string) childPackageType packageTypeDescriptionCodeValue (string) logisticUnitMeasurement (LogisticUnitMeasurementType) parentLevelId levelIdentification (integer) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) v1 Final Release 63 .17. outer. or inner despatchAdviceLogisticsUnitLineItem levelId levelIdentification Element See also 4.1 Parent Packaging Level.Business Document Layer Message Elements Co-requisites receiver gln (Global Location Number) shipper gln (Global Location Number) shipTo shipTo additionalPartyIdentification additionalPartyIdentificationValue (string) additionalPartyIdentification additionalPartyIdentificationType (List) Optional Elements 4. Mandatory: Data Type: Cardinality: No Integer 1..17 Packaging Level AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Section: Detail Group: Packaging Element: Packaging level Entire shipment.

17..1 Co-requisites Optional Elements despatchAdviceLogisticsUnitLineItem logisticUnitIdentification serialShipmentContainerCode (Relative to despatchAdviceLogisticsUnitLineItem) serialShippingContainerCode quantityOfChildren (integer) packageType packageTypeDescriptionCodeValue (string) childPackageType packageTypeDescriptionCodeValue (string) logisticUnitMeasurement (LogisticUnitMeasurementType) levelId levelIdentification (integer) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) 4.1 Parent Packaging Level Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Related to Packaging Level despatchAdviceLogisticsUnitLineItem parentLevelId levelIdentification Element See also Packaging Level 4.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4.17 Packaging Level. Mandatory: Data Type: Cardinality: Schema Constraints No Integer 1. Specifiying the link to the Parent Package ID allows flexibility in the definition of the IDs.18 Packaging Type AS5023 Reference Description/Comments GS1 XML Path Section: Detail Group: Packaging Element: Packaging despatchAdviceLogisticsUnitLineItem packageType packageTypeDescriptionCodeValue 64 Final Release v1 .

1 Child Package Type Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Related to Packaging despatchAdviceLogisticsUnitLineItem packageType childpackageTypeDescriptionCodeValue Element Mandatory: Data Type: No list v1 Final Release 65 .htm Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem) logisticUnitIdentification serialShipmentContainerCode serialShipmentContainerCode serialShippingContainerCode (string) Optional Elements (Relative to despatchAdviceLogisticsUnitLineItem) quantityOfChildren (integer) childPackageType packageTypeDescriptionCodeValue (string) logisticUnitMeasurement (LogisticUnitMeasurementType) levelId levelIdentification (integer) parentLevelId levelIdentification (integer) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) 4.com/service/eancom2003/ean2003s3/experts/part3/dc8m.18.gefeg. 21. It is available on the web at: http://www.Business Document Layer Message Elements Basic Type Comments Schema Constraints Element Mandatory: Data Type: Cardinality: No list 1.1 For the elements of this list.. refer to the EANCOM element 7065 which contains a codelist based on UN/ECE Recommendation No.

htm Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem) logisticUnitIdentification serialShipmentContainerCode serialShipmentContainerCode serialShippingContainerCode (string) Optional Elements (Relative to despatchAdviceLogisticsUnitLineItem) quantityOfChildren (integer) PackageType packageTypeDescriptionCodeValue (string) logisticUnitMeasurement (LogisticUnitMeasurementType) levelId levelIdentification (integer) parentLevelId levelIdentification (integer) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) 4. It is available on the web at: http://www.12. Refer to 4.19 Number of Packages AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Section: Detail Group: Packaging Element: Packaging despatchAdviceLogisticsUnitLineItem quantityOfChildren Element This element is the number of packages within the package being described.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Cardinality: 1.1 Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem) logisticUnitIdentification serialShipmentContainerCode serialShipmentContainerCode serialShippingContainerCode (string) 66 Final Release v1 .com/service/eancom2003/ean2003s3/experts/part3/dc8m..1 For the elements of this list..5 Number of Packages for the total number of packages in the shipment. refer to the EANCOM element 7065 which contains a codelist based on UN/ECE Recommendation No. Mandatory: Data Type: Cardinality: Schema Constraints No integer 0. 21.gefeg.

20 Package Measurements AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Section: Detail Group: Packaging Element: Measurements despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement Complex Type This is a complex type which can record the lineal dimensions of the package as well as weight and volume measurements..Business Document Layer Message Elements Optional Elements (Relative to despatchAdviceLogisticsUnitLineItem) packageType packageTypeDescriptionCodeValue (list) childPackageType packageTypeDescriptionCodeValue (string) logisticUnitMeasurement (LogisticUnitMeasurementType) levelId levelIdentification (integer) parentLevelId levelIdentification (integer) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) 4. Mandatory: Data Type: Cardinality: Schema Constraints No logisticUnitMeasurementType 0.1 Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem) logisticUnitIdentification serialShipmentContainerCode serialShipmentContainerCode serialShippingContainerCode (string) v1 Final Release 67 .

string) packageHeight measurementValue unitOfMeasure (Attribute.20. Mandatory: Data Type: Cardinality: Schema Constraints No decimal 1. string) Optional Elements despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement unitMeasurement (UnitMeasurementType) Final Release v1 68 .. string) packageWidth measurementValue unitOfMeasure (Attribute.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements (Relative to despatchAdviceLogisticsUnitLineItem) quantityOfChildren (integer) packageType packageTypeDescriptionCodeValue (list) childPackageType packageTypeDescriptionCodeValue (string) levelId levelIdentification (integer) parentLevelId levelIdentification (integer) despatchAdviceItemContainmentLineItem (DespatchAdviceItemContainmentLineItemType) 4.1 Package Lineal Dimensions Section: AS5023 Reference Description/Comments GS1 XML Path Detail Group: Packaging Element: Measurements (Relative to despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement packageDimension) packageLength measurementValue value packageHeight measurementValue value packageWidth measurementValue value Basic Type Comments Element All three elements behave in the same way.1 Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement packageDimension) packageLength measurementValue unitOfMeasure (Attribute. The difference is only in their naming. so they are treated as one in this document.

.20.2 Package: Other Measurements Section: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Detail Group: Packaging Element: Measurements despatchAdviceLogisticUnitLineItem logisticUnitMeasurement unitMeasurement measurementValue value Element Mandatory: Data Type: Cardinality: No decimal 1.1 GROSS_VOLUME NET_VOLUME TARE_WEIGHT TOTAL_GROSS_WEIGHT UNIT_GROSS_WEIGHT UNIT_NET_WEIGHT Allowable values for measurementType are: DECLARED_NET_WEIGHT Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement unitMeasurement) measurementValue unitOfMeasure (string) measurementType (list) Optional Elements None 4.20.Business Document Layer Message Elements 4.3 Package: Measurement Type Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Related to Packaging Measurements despatchAdviceLogisticUnitLineItem logisticUnitMeasurement unitMeasurement measurementType Element v1 Final Release 69 .

1 GROSS_VOLUME NET_VOLUME TARE_WEIGHT TOTAL_GROSS_WEIGHT UNIT_GROSS_WEIGHT UNIT_NET_WEIGHT Allowable values for are: DECLARED_NET_WEIGHT Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement unitMeasurement) measurementValue unitOfMeasure (string) measurementValue value (decimal) Optional Elements None 4. Details of this code list can be downloaded from: http://www.4 Package: Unit of Measure Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Related to Packaging Measurements despatchAdviceLogisticUnitLineItem logisticUnitMeasurement unitMeasurement measurementValue unitOfMeasure Attribute Mandatory: Data Type: Cardinality: No string 1..com/service/eancom2003/ean2003s3/experts/part3/dc8b.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Schema Constraints Mandatory: Data Type: Cardinality: No list 1.gefeg..htm 70 Final Release v1 .20.1 Allowable values for unitOfMeasure are defined in the EANCOM element 6411.

Business Document Layer Message Elements

Co-requisites

(Relative to despatchAdviceLogisticsUnitLineItem logisticUnitMeasurement unitMeasurement)

measurementValue value (decimal) measurementType (list)
Optional Elements

None

4.21

Quantity per Package
AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Section:

Detail

Group:

Packaging

Element:

Quantity per package

despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem quantityContained value

Element If multiple batches are contained within the package, then use one despatchAdviceItemContainmentLineItem element per batch. Because despatchAdviceLogisticsUnitLineItem and despatchAdviceItemContainmentLineItem are members of the same choice group, the message cannot contain both the total quantity of an item per despatch and the quantity of an item contained within a package. If the quantity per package option is used, then the total quantity for the despatch can be derived by summing the quantity per package values for the despatch.
Mandatory: Data Type: Cardinality:

Schema Constraints

No float 1..1

v1

Final Release

71

NEHTA Standard Message Implementation Guidelines for Health e-Procurement

Part 3: GS1 XML Despatch Messages

This element is mandatory if despatchAdviceLogisticUnitLineItem is used.
Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem despatchAdviceItemContainmentLineItem)

quantityContained unitOfMeasure measurementUnitCodeValue (string) number (nonNegativeInteger) containedItemIdentification gtin (Global Trade Item Number1)

1.1

1

This must be padded with 0’s to the full 14 characters. See section 1.3 Global Trade Item Numbers - GTINs

Global Trade Item Numbers are used extensively to identify items. This field MUST contain a 14 digit number, so a ‘filler 0’ must be added to the front of the number if they are 8, 12, or 13 digit GTINs. For example, 9312345678901 becomes 09312345678901. This does not change the number at all, it is simply a non-significant digit added so this will pass schema validation.

72

Final Release

v1

Business Document Layer Message Elements

Optional Elements

(Relative to despatchAdviceLogisticsUnitLineItem despatchAdviceItemContainmentLineItem)

requestedItemIdentification gtin (Global Trade Item Number2) productCertification (DetailLevelReferenceType) promotionalDeal (DetailLevelReferenceType) customer (DetailLevelReferenceType) specification (DetailLevelReferenceType) deliveryNote (DetailLevelReferenceType) consignment (DetailLevelReferenceType) contract (DetailLevelReferenceType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) listForEachItem (SpecifItemDataType) extendedAttributes (TransactionalItemDataType) requestedQuantity (QuantityType) freeGoodsQuantity (QuantityType) quantityVariance (QuantityVarianceType) countryOfLastProcessing (ISO3166_1CodeType) countryOfOrigin (ISO3166_1CodeType) locationOfLastProcessing (LocationInformationType) locationOfOrigin (LocationInformationType)

1.2

2

This must be padded with 0’s to the full 14 characters. See section 1.3 Global Trade Item Numbers - GTINs

Global Trade Item Numbers are used extensively to identify items. This field MUST contain a 14 digit number, so a ‘filler 0’ must be added to the front of the number if they are 8, 12, or 13 digit GTINs. For example, 9312345678901 becomes 09312345678901. This does not change the number at all, it is simply a non-significant digit added so this will pass schema validation.

v1

Final Release

73

In this case the line numbers refer to the individual items within the package.e.1 Mandatory if despatchAdviceLogisticUnitLineItem is used. Schema Constraints Mandatory: No Final Release v1 74 . It may also be written from the items within a package perspective which shows the hierarchical relationship between all the packages in the shipment i.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4. Co-requisites Optional Elements None (Relative to despatchAdviceLogisticsUnitLineItem logisticUnitIdentification) additionalLogisticUnitIdentification logisticUnitIdentification (string) 4.. using the despatchAdviceLogisticUnitLineItem element containing the despatchAdviceItemContainmentLineItem element.22 Package Identification AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Section: Detail Group: Packaging Element: Package Identification despatchAdviceLogisticUnitLineItem logisticUnitIdentification serialShipmentContainerCode serialShippingContainerCode Element No string 1.23 Line Number AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Section: Detail Group: Line Item Element: Line number despatchAdviceItemContainmentLineItem number Attribute Line numbers are used if the Despatch Advice is written from the item perspective i. using the despatchAdviceItemContainmentLineItem element.e.

This field MUST contain a 14 digit number.1 This is mandatory if despatchAdviceItemContainmentLineItem is used. This does not change the number at all. 9312345678901 becomes 09312345678901. 12. so a ‘filler 0’ must be added to the front of the number if they are 8. v1 Final Release 75 . or 13 digit GTINs. it is simply a non-significant digit added so this will pass schema validation. Co-requisites (Relative to despatchAdviceLogisticsUnitLineItem despatchAdviceItemContainmentLineItem) containedItemIdentification gtin (Global Trade Item Number3) quantityContained unitOfMeasure measurementUnitCodeValue (string) quantityContained value (float) 1. See section 1. For example.3 3 This must be padded with 0’s to the full 14 characters..3 Global Trade Item Numbers .Business Document Layer Message Elements Data Type: Cardinality: Non-negative Integer 1.GTINs Global Trade Item Numbers are used extensively to identify items.

This does not change the number at all.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Optional Elements (Relative to despatchAdviceLogisticsUnitLineItem despatchAdviceItemContainmentLineItem) requestedItemIdentification gtin (Global Trade Item Number4) productCertification (DetailLevelReferenceType) promotionalDeal (DetailLevelReferenceType) customer (DetailLevelReferenceType) specification (DetailLevelReferenceType) deliveryNote (DetailLevelReferenceType) consignment (DetailLevelReferenceType) contract (DetailLevelReferenceType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) listForEachItem (SpecifItemDataType) extendedAttributes (TransactionalItemDataType) requestedQuantity (QuantityType) freeGoodsQuantity (QuantityType) quantityVariance (QuantityVarianceType) countryOfLastProcessing (ISO3166_1CodeType) countryOfOrigin (ISO3166_1CodeType) locationOfLastProcessing (LocationInformationType) locationOfOrigin (LocationInformationType) 1. it is simply a non-significant digit added so this will pass schema validation. 12. 76 Final Release v1 . 9312345678901 becomes 09312345678901. For example. so a ‘filler 0’ must be added to the front of the number if they are 8.GTINs Global Trade Item Numbers are used extensively to identify items.4 4 This must be padded with 0’s to the full 14 characters. or 13 digit GTINs. This field MUST contain a 14 digit number.3 Global Trade Item Numbers . See section 1.

This field MUST contain a 14 digit number.GTINs Global Trade Item Numbers are used extensively to identify items.1 This is mandatory if despatchAdviceItemContainmentLineItem is used.5 5 This must be padded with 0’s to the full 14 characters. 1. 9312345678901 becomes 09312345678901. v1 Final Release 77 . it is simply a non-significant digit added so this will pass schema validation.3 Global Trade Item Numbers .24 Unique Product Identifier AS5023 Reference Description/Comments GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Section: Detail Group: Product Identifier Element: Unique product identifier containedItemIdentification gtin Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Element No Global Trade Item Number5 1. See section 1. or 13 digit GTINs. For example.. so a ‘filler 0’ must be added to the front of the number if they are 8. 12. This does not change the number at all.Business Document Layer Message Elements 4.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) number (Non-negative Number) quantityContained unitOfMeasure measurementUnitCodeValue (string) quantityContained value (float) 78 Final Release v1 .

12.Business Document Layer Message Elements Optional Elements (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) requestedItemIdentification gtin (Global Trade Item Number6) productCertification (DetailLevelReferenceType) promotionalDeal (DetailLevelReferenceType) customer (DetailLevelReferenceType) specification (DetailLevelReferenceType) deliveryNote (DetailLevelReferenceType) consignment (DetailLevelReferenceType) contract (DetailLevelReferenceType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) listForEachItem (SpecifItemDataType) extendedAttributes (TransactionalItemDataType) requestedQuantity (QuantityType) freeGoodsQuantity (QuantityType) quantityVariance (QuantityVarianceType) countryOfLastProcessing (ISO3166_1CodeType) countryOfOrigin (ISO3166_1CodeType) locationOfLastProcessing (LocationInformationType) locationOfOrigin (LocationInformationType) 1. or 13 digit GTINs. v1 Final Release 79 .3 Global Trade Item Numbers . so a ‘filler 0’ must be added to the front of the number if they are 8. For example.GTINs Global Trade Item Numbers are used extensively to identify items. See section 1.6 6 This must be padded with 0’s to the full 14 characters. This does not change the number at all. 9312345678901 becomes 09312345678901. This field MUST contain a 14 digit number. it is simply a non-significant digit added so this will pass schema validation.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4. See section 1. This does not change the number at all. For example.25 Requested Item Identifier AS5023 Reference Description/Comments GS1 XML Path Section: Group: Element: Related to Unique Product Identifier (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) requestedItemIdentification gtin Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Element No Global Trade Item Number7 1. 12. This field MUST contain a 14 digit number.3 Global Trade Item Numbers . or 13 digit GTINs.. it is simply a non-significant digit added so this will pass schema validation. Co-requisites (Relative to or number (Non-negative Number) quantityContained unitOfMeasure measurementUnitCodeValue (string) quantityContained value (float) containedItemIdentification gtin (Global Trade Item Number8) 1.1 despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) This item must be used if the item supplied is different to the one requested. 9312345678901 becomes 09312345678901. so a ‘filler 0’ must be added to the front of the number if they are 8.7 7 This must be padded with 0’s to the full 14 characters.GTINs Global Trade Item Numbers are used extensively to identify items. 80 Final Release v1 .

v1 Final Release 81 . For example. or 13 digit GTINs. See section 1. 12.Business Document Layer Message Elements Optional Elements (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) productCertification (DetailLevelReferenceType) promotionalDeal (DetailLevelReferenceType) customer (DetailLevelReferenceType) specification (DetailLevelReferenceType) deliveryNote (DetailLevelReferenceType) consignment (DetailLevelReferenceType) contract (DetailLevelReferenceType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) listForEachItem (SpecifItemDataType) extendedAttributes (TransactionalItemDataType) requestedQuantity (QuantityType) freeGoodsQuantity (QuantityType) quantityVariance (QuantityVarianceType) countryOfLastProcessing (ISO3166_1CodeType) countryOfOrigin (ISO3166_1CodeType) locationOfLastProcessing (LocationInformationType) locationOfOrigin (LocationInformationType) 1. it is simply a non-significant digit added so this will pass schema validation.GTINs Global Trade Item Numbers are used extensively to identify items. This field MUST contain a 14 digit number.8 8 This must be padded with 0’s to the full 14 characters. 9312345678901 becomes 09312345678901. so a ‘filler 0’ must be added to the front of the number if they are 8. This does not change the number at all.3 Global Trade Item Numbers .

1 INDUSTRY_ASSIGNED despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Allowable values for additionalTradeItemIdentificationType are: BUYER_ASSIGNED Co-requisites (Relative to or SUPPLIER_ASSIGNED containedItemIdentification additionalTradeItemIdentificationType Optional Elements None 4..NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4.26 Additional Product Information AS5023 Reference Description/Comments GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Section: Detail Group: Product Identifier Element: Additional product information containedItemIdentification additionalTradeItemIdentification Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: additionalTradeItemIdentificationValue Element No string 1.27 Additional Product Information Type AS5023 Reference Description/Comments GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Section: Detail Group: Product Identifier Element: Additional product information containedItemIdentification additionalTradeItemIdentification Basic Type additionalTradeItemIdentificationType Element 82 Final Release v1 .

1 INDUSTRY_ASSIGNED despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Allowable values are: BUYER_ASSIGNED Co-requisites (Relative to or SUPPLIER_ASSIGNED containedItemIdentification additionalTradeItemIdentificationValue Optional Elements None 4..28 Supplier Product Code AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Section: Detail Group: Product Identifier Element: Supplier Product Code See Additional Product Details for futher information. Set the additionalTradeItemIdentificationType to “SUPPLIER_ASSIGNED”. Mandatory: Data Type: Cardinality: Schema Constraints Co-requisites Optional Elements v1 Final Release 83 .Business Document Layer Message Elements Comments Schema Constraints Mandatory: Data Type: Cardinality: No list 1.

. then the total quantity for the despatch can be derived by summing the quantity per package values for the despatch.29 Despatched Quantities AS5023 Reference Description/Comments GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Section: Detail Group: Item Detail Element: Quantities despatchAdviceItemContainmentLineItem quantityContained value Basic Type Comments Element Because despatchAdviceLogisticsUnitLineItem and despatchAdviceItemContainmentLineItem are members of the same choice group. the message cannot contain both the total quantity of an item per despatch and the quantity of an item contained within a package.1 Co-requisites Optional Elements None (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) quantityContained unitOfMeasure measurementUnitCodeValue (string) 4.30 Ordered Quantity AS5023 Reference Description/Comments GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Section: Detail Group: Item Detail Element: Quantities requestedQuantity value 84 Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4. Mandatory: Data Type: Cardinality: Schema Constraints No float 1. If the quantity per package option is used.

31 Batch Number AS5023 Reference Description/Comments GS1 XML Path Section: Group: Element: Related to Item Details (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) extendedAttributes batchNumber Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Element No string 0. If the quantity per package option is used... then the total quantity for the despatch can be derived by summing the quantity per package values for the despatch. Mandatory: Data Type: Cardinality: Schema Constraints No float 1.Business Document Layer Message Elements Basic Type Comments Element Because despatchAdviceLogisticsUnitLineItem and despatchAdviceItemContainmentLineItem are members of the same choice group. the message cannot contain both the total quantity of an item per despatch and the quantity of an item contained within a package.1 v1 Final Release 85 .1 Co-requisites Optional Elements None (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) requestedQuantity unitOfMeasure measurementUnitCodeValue (string) 4.

* 86 Final Release v1 .1 Cardinality of listForEachItem is 0..NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites Optional Elements None (Relative to or despatchAdviceItemContainmentLineItem extendedAttributes despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem extendedAttributes) availableForSaleDate (date) bestBeforeDate (date) countryOfOrigin (list) itemExpirationDate (date) lotNumber (string) packagingDate (date) productionDate (date) productQualityIndication (QuantityType) sellByDate (date) shelfLife (string) transactionalItemWeight (UnitMeasurementType) 4..32 Serial Numbers AS5023 Reference Description/Comments GS1 XML Path Section: Group: Element: Related to Item Details (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) listForEachItem serialNumber Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: No string 1.

Business Document Layer Message Elements Co-requisites (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) number (Attribute. Non-negative Integer) quantityContained value (float) Optional Elements (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) requestedItemIdentification (TradeItemIdenfiticationType) productCertification (DetailLevelReferenceType) promotionalDeal (DetailLevelReferenceType) customer (DetailLevelReferenceType) specification (DetailLevelReferenceType) deliveryNote (DetailLevelReferenceType) consignment (DetailLevelReferenceType) contract (DetailLevelReferenceType) purchaseOrder (DocumentOrDocumentLineReferenceType) purchaseConditions (DocumentOrDocumentLineReferenceType) extendedAttributes (TransactionalItemDataType) requestedQuantity (QuantityType) freeGoodsQuantity (QuantityType) quantityVariance (QuantityVarianceType) countryOfLastProcessing (ISO3166_1CodeType) countryOfOrigin (ISO3166_1CodeType) locationOfLastProcessing (LocationInformationType) locationOfOrigin (LocationInformationType) v1 Final Release 87 .

then multiple despatchAdviceItemContainmentLineItem elements must be used. (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) extendedAttributes itemExpirationDate Basic Type Comments Element If there are multiple Expiry Dates for the item being despatched.34). AS5023 Reference Description/Comments GS1 XML Path Section: Detail Group: Item details Element: Dates The dates identified in AS5023 are: estimated delivery date. The strategy for processing multiple Expiry Dates will be linked to the strategies for Best Before Dates (4. Batch Numbers(4..31).32). Delivery Dates apply to the whole shipment and so are held at the header level.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4.33 Expiry Date Note: AS5023 identifies an Estimated Delivery Date as a data element at the item level. best before date. expiry date. Schema Constraints Mandatory: Data Type: Cardinality: No date 0.1 Co-requisites None 88 Final Release v1 . and Serial Numbers (4.

34 Best Before Dates AS5023 Reference Description/Comments GS1 XML Path Section: Detail Group: Item details Element: Dates The dates identified in AS5023 are: estimated delivery date. The strategy for processing multiple Best Before Dates will be linked to the strategies for Expiry Dates (4.31). (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) extendedAttributes bestBeforeDate Basic Type Comments Element If there are multiple Best Before Dates for the item being despatched.. best before date. then multiple despatchAdviceItemContainmentLineItem elements must be used.32). Schema Constraints Mandatory: Data Type: Cardinality: No date 0.Business Document Layer Message Elements Optional Elements (Relative to or despatchAdviceItemContainmentLineItem extendedAttributes despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem extendedAttributes) availableForSaleDate (date) batchNumber (string) bestBeforeDate (date) countryOfOrigin (list) lotNumber (string) packagingDate (date) productionDate (date) productQualityIndication (QuantityType) sellByDate (date) shelfLife (string) transactionalItemWeight (UnitMeasurementType) 4. and Serial Numbers(4.33). Batch Numbers(4. expiry date.1 v1 Final Release 89 .

Mandatory: Schema Constraints No 90 Final Release v1 . The details in this section apply to both versions. The schema structure mandates that only one of these two can be used at any one time. and package item level.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites Optional Elements None (Relative to or despatchAdviceItemContainmentLineItem extendedAttributes despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem extendedAttributes) availableForSaleDate (date) batchNumber (string) countryOfOrigin (list) itemExpirationDate (date) lotNumber (string) packagingDate (date) productionDate (date) productQualityIndication (QuantityType) sellByDate (date) shelfLife (string) transactionalItemWeight (UnitMeasurementType) 4. The item level or package item level version must be used.35 Order Line Number AS5023 Reference Description/Comments GS1 XML Path Section: Detail Group: Item details Element: Order Line Number This is a reference to the line number in the original Purchase Order. item level. (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) purchaseOrder documentLineReference number Basic Type Comments Element The purchaseOrder element exists at header level.

.1 Cardinality of documentReference is 0..1 Order Number Section: AS5023 Reference Description/Comments GS1 XML Path Detail Group: Item details Element: Order Line Number Related to Order Line Number (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) purchaseOrder documentLineReference documentReference Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: uniqueCreatorIdentification No string 1.35.1 v1 Final Release 91 .Business Document Layer Message Elements Data Type: Cardinality: Non-negative Integer 1..1 Co-requisites Optional Elements None (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) documentReference documentReference documentReference documentReference uniqueCreatorIdentification (string) contentOwner gln (Global Location Number) contentOwner additionalPartyIdentificationValue (string) contentOwner additionalPartyIdentificationType (list) 4.

2 Order Date Section: Group: Element: AS5023 Reference Description/Comments GS1 XML Path Related to Order Line Number (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) documentReference creationDateTime Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Attribute No dateTime 0.NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Co-requisites (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) number (Non-negative Integer) documentReference creationDateTime (Attribute..1 despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) Co-requisites (Relative to or number (Non-negative Integer) documentReference uniqueCreatorIdentification (string) documentReference contentOwner gln (Global Location Number) 92 Final Release v1 .35. dateTime) documentReference contentOwner gln (Global Location Number) Optional Elements (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) documentReference contentOwner additionalPartyIdentificationValue (string) documentReference contentOwner additionalPartyIdentificationType (list) 4.

dateTime) documentReference contentOwner gln (Global Location Number) Optional Elements (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) documentReference contentOwner additionalPartyIdentificationValue (string) documentReference contentOwner additionalPartyIdentificationType (list) v1 Final Release 93 .Business Document Layer Message Elements Optional Elements (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) documentReference contentOwner additionalPartyIdentificationValue (string) documentReference contentOwner additionalPartyIdentificationType (list) 4.36 Order Creator AS5023 Reference Description/Comments GS1 XML Path Section: Group: Element: Related to Order Line Number (Relative to or despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) documentReference contentOwner gln Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Element No Global Location Number 1..1 despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem purchaseOrder documentLineReference) Co-requisites (Relative to or number (Non-negative Integer) documentReference creationDateTime (Attribute.

it has multiple Batch Numbers or occurs in multiple packages.g. Schema Constraints Mandatory: Data Type: Cardinality: No float 1.. despatchAdviceItemContainmentLineItem also occurs as a child element of despatchLogisticUnitLineItem.37 Quantity Variances AS5023 Reference Description/Comments GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) Section: Detail Group: Quantity Variances Element: Quantity Variances quantityVariance varianceQuantity value Basic Type Comments Element If a particular item occurs multiple times. then the variances should be recorded with the first occurrence only.* so multiple types of variances can be recorded.. e. Co-requisites (Relative to or changeReason (list) Optional Elements (Relative to or despatchAdviceItemContainmentLineItem quantityVariance despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem quantityVariance) varianceQuantity unitOfMeasure measurementUnitCodeValue (string) 4.1 despatchAdviceItemContainmentLineItem quantityVariance despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem quantityVariance) The cardinality of quantityVariance is 0. and the same rules apply.38 Variance Reason AS5023 Reference Description/Comments Section: Detail Group: Quantity Variances Element: Quantity Variances 94 Final Release v1 .NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages 4.

Allowable values are: ARTICLE_CODE_UNKNOWN Co-requisites (Relative to or despatchAdviceItemContainmentLineItem quantityVariance despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem quantityVariance) varianceQuantity Optional Elements (Relative to or value (float) despatchAdviceItemContainmentLineItem quantityVariance despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem quantityVariance) varianceQuantity unitOfMeasure measurementUnitCodeValue (string) 4.. Mandatory: Data Type: v1 Final Release 95 .39 Delivery Date: Variances AS5023 Reference Description/Comments GS1 XML Path Basic Type Comments Schema Constraints Section: Detail Group: Quantity variance Element: Delivery date for variances This is subject to a change request to incorporate Back Order dates as a data element.Business Document Layer Message Elements GS1 XML Path (Relative to or despatchAdviceItemContainmentLineItem despatchAdviceLogisticUnitLineItem despatchAdviceItemContainmentLineItem) quantityVariance changeReason Basic Type Comments Schema Constraints Mandatory: Data Type: Cardinality: Element No list 1..* so multiple types of variances can be recorded.1 DAMAGED ITEM_NOT_ORDERED OUT_OF_INVENTORY PACK_DIFFERENCE The cardinality of quantityVariance is 0.

NEHTA Standard Message Implementation Guidelines for Health e-Procurement Part 3: GS1 XML Despatch Messages Cardinality: Co-requisites Optional Elements 96 Final Release v1 .

GS1 2007. BMS Release: 2.4. Standard Business Document Header (SBDH) Technical Implementation Guide. Release: 1. Standards Australia. Business Message Standard (BMS) Order Response. GS1. GS1 2007. Health Supply Chain Messaging Part 4: Dataset content – Secondary transactions.5 References This document is based on the following documents [SA2003] Standards Australia 2003. Version 1. E-Procurement Technical Architecture. NEHTA 2007.0.3. GS1. NEHTA [GS1-2007] [SBDH2007] [EPTA2007] v1 Final Release .