Supplier PEPPOL Message Implementation Guide
First Release Date: 11/01/2017 Last Revision Date: 07/07/2020 http://www.netedi.co.uk Document Version: 3.61 NHS Supply Chain Supplier Message Implementation Guide
Contents Document Control ...... 4 Revision History ...... 4 Overview ...... 5 1 PEPPOL Document Overview ...... 6 1.1 Stock Orders ...... 7 1.2 Blue Diamond (Cross-Dock) Orders ...... 7 1.3 eDirect Orders ...... 7 1.4 Order Response ...... 8 1.5 Advanced Shipping Notification - ASN ...... 8 1.5.1 Serial Shipping Container Code (SSCC) ...... 8 1.5.2 Basic ASN Hierarchy ...... 9 1.5.3 Complex ASN Hierarchy ...... 9 1.6 Despatch Advice (Delivery Confirmation) ...... 10 2 Benefits and changes of moving to PEPPOL ...... 11 2.1 Benefits of PEPPOL with NHS Supply Chain ...... 11 2.2 Important business process changes...... 11 2.2.1 Order Notes ...... 11 2.2.2 Labelling ...... 11 2.2.3 Order Amendments ...... 11 2.2.4 Despatch Advice (Delivery Confirmation) – eDirect orders only...... 12 2.2.5 Despatch Advice (ASN) ...... 12 2.2.6 Order Response, Despatch Advice, Invoice and Credit Note rejections ...... 12 2.2.7 Delivery Location GLN ...... 12 2.2.8 Invoices ...... 12 3 Exchanging PEPPOL Documents with NHS Supply Chain ...... 13 3.1 Pre-requisites ...... 13 3.2 NHS Supply Chain PEPPOL Connectivity ...... 13 3.1.1 PEPPOL ID’s ...... 14 3.1.2 Contact Information ...... 14 4 NHS Supply Chain PEPPOL document Summary ...... 15 5. Purchase Orders ...... 16 5.1 Department of Health Data Dictionary changes ...... 16 5.2 Requirements ...... 17 5.3 Example ...... 33 6 Order Responses ...... 40 6.1 Requirements ...... 40 6.2 Example ...... 44 6.2.1 Order Response – Accepted with Amendment ...... 44 6.2.2 Order Response – Accepted ...... 49 6.2.3 Order Response – Rejected ...... 51 7. Advanced Shipping Notes (ASN) Despatch Advices ...... 53 7.1 Requirements ...... 54 7.2 Example ...... 67
Page 2 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
7.2.1 Basic Hierarchy ...... 67 7.2.2 Complex Hierarchy...... 72 8. Despatch Advices (Confirmation) ...... 78 8.1 Requirements ...... 78 8.2 Example ...... 84 9. Invoices...... 88 9.1 Requirements ...... 88 9.2 Example ...... 109 10. Credit Notes ...... 115 10.1 Requirements ...... 115 10.2 Example ...... 131 11. PEPPOL Validation ...... 135 Appendix A – PEPPOL Connectivity ...... 136 I already have a PEPPOL Access Point provider ...... 136 I don’t have a PEPPOL Access Point provider ...... 136 Appendix B – Labels ...... 137 ASN Labels ...... 137 Blue Diamond Label for ASN deliveries ...... 137 eDirect Label for ASN deliveries ...... 139 Stock Label for ASN Deliveries ...... 141 Legacy Non ASN Labels ...... 142 Blue Diamond Label for non ASN deliveries ...... 142 eDirect Label for non ASN deliveries ...... 143 Stock Label for non ASN deliveries ...... 143
Page 3 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Document Control
Revision History Revision Status Date Author Description 1.0 Released 11/01/2017 Marc Nelson Initial release (NetEDI) 1.1 Amended 20/01/2017 Marc Nelson Added Despatch Advice message 1.2 Amended 23/01/2017 Marc Nelson Updated with Invoices and Credit Notes 2.0 Amended 15/02/2017 Steve Moore NHS Supply Chain amendments, (NHS Supply Chain) Delivery Location details update 2.1 Amended 23/02/2017 Marc Nelson Added Label examples, general formatting changes and extended message specifications 2.2 Amended 10/03/2017 Marc Nelson Added Delivery Charges to Orders, Invoices and Credit Notes 2.3 Amended 21/03/2017 Marc Nelson Added Despatch Date to Delivery Note 2.4 Amended 23/03/2017 Marc Nelson Added GLN information for eDirect Orders 2.5 Amended 11/04/2017 Marc Nelson Fixed issue with duplicate elements on the invoice. 2.6 Amended 13/04/2017 Marc Nelson Minor amendments 2.7 Amended 02/06/2017 Marc Nelson Minor Amendments 2.8 Amended 21/07/2017 Marc Nelson Made changes to match Department of Health’s Data Dictionary dated June 2017 2.9 Amended 07/08/2017 Marc Nelson Added Proof of Delivery Number to Invoices, plus some minor changes to label details. 3.0 Amended 19/12/2017 Marc Nelson Added note about Delivery Charges on Invoices 3.1 Amended 20/12/2017 Marc Nelson Added notes about being able to send multiple Order Responses 3.2 Amended 20/02/2018 Marc Nelson Removed comment about 227=Consignment Orders for the Order Type on Order messages. 3.3 Amended 13/03/2018 Marc Nelson Change Blue Diamond label to include Requisition Point Name 3.4 Amended 28/11/2018 Marc Nelson Change GLN reference for eDirects 3.5 Amended 31/03/2020 Paul Lillie Added Advanced Shipping Note (ASN) Document. 3.6 Amended 10/06/2020 Paul Lillie Updated Order to Invoice messages to BIS3. Added Order Response validation notes. Correction to ASN example. 3.61 Amended 7/7/2020 Paul Lillie Added supported Transport Handling Unit Type Codes to ASN
Page 4 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Overview Welcome to the PEPPOL Implementation Guide for NHS Supply Chain (hereafter referred to as PEPPOL). As part of the NHS Scan4Safety Strategy, suppliers must comply with PEPPOL messaging standards. More details on the NHS Scan4Safety Strategy can be found on the Government web site or via this direct link. NetEDI has produced a Guide for choosing a PEPPOL Service Provider that can be used to help you select the right Access Provider for you. PEPPOL involves a suite of electronic documents that, when utilised in combination with a defined set of business rules and processes, enables a significant improvement to the efficiency and administration of the trading relationship. PEPPOL results in the removal of manual processes and paper documents and replaces them with electronic documents and automation. NHS Supply Chain has identified five key documents relating to ordering, delivery and payment. Under the PEPPOL process, a higher level of collaboration between NHS Supply Chain and supplier is required. This will affect both NHS Supply Chain and supplier’s IT systems and business processes. PEPPOL brings the following potential benefits:
▪ Reduction of order processing lead time ▪ Cost reduction through process ▪ Administrative cost cuts optimisation ▪ More accurate order placement ▪ Elimination of redundant manual data input ▪ Shorter business cycles ▪ Reduced manual work required
Page 5 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
1 PEPPOL Document Overview The following diagram illustrates the electronic documents used during the PEPPOL process with NHS Supply Chain, as well as the sequence in which they occur in a normal purchase order to invoice transaction.
Purchase Order
Order Response
Chain NHS Supply
Supplier Despatch Advice*
Advanced Shipping Note*
Invoice
Credit Note
*Please note: The Advanced Shipping Note (ASN) message will replace the need for suppliers to send Despatch Advice message that is currently used as a delivery confirmation. The NHS Supply Chain solution will automatically generate the Despatch Advice (Confirmation) upon receipt of an ASN document. NHS Supply Chain supports the implementation of all the following messages;
• NHS Supply Chain Purchase Order • Supplier Order Response • Supplier Advanced Shipping Notification (ASN)* • Supplier Despatch Advice (Delivery Confirmation) * • Supplier Invoice • Supplier Credit Note
Each document is described in detail later in this guide. The PEPPOL Order message from NHS Supply Chain supports three different types of orders: -
• eDirect • Blue Diamond (Cross-Dock) • Stock
Page 6 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Each type of order can contain different data, in the main the additional data contains information that needs to be printed on labels, as well as batch/serial numbers where required. The differences are covered in the PEPPOL Order and 2.2 Important business process changes sections. The e-procurement strategy from the Department of Health has mandated the use of the Purchase Order and Invoice messages as part of the PEPPOL Scan4Safety initiative. Order Responses, Despatch Advices and Credit Notes are optional. Order Responses, sometimes referred to as Amendments can be used to remove the need to use the NHS Supply Chain Supplier Portal. Despatch Advices are only allowed for eDirect type orders and remove the need to confirm Orders via the NHS Supply Chain Supplier Portal. Despatch Advices sent for other order types will be ignored. You must follow the standard NHS Supply Chain process for booking in your delivery with the NHS Supply Chain depots. 1.1 Stock Orders Order Response messages (to amend quantities) can be returned to NHS Supply Chain via PEPPOL and will be processed automatically. This process can replace the need for the supplier to email NHS Supply Chain with changes on Stock Orders or make quantity amendments via the supplier portal. Order Responses can be sent to amend quantities, but this must be notified to NHS Supply Chain before the delivery date. Please note that the Order Response is not a mandatory requirement for Stock Orders but has been included to allow suppliers of different types of orders to return order response messages for all order types, if their ERP and/or PEPPOL Access Point can support it. 1.2 Blue Diamond (Cross-Dock) Orders For Blue Diamond (Cross-dock) type orders, suppliers Order Responses can be sent to amend quantities, but this must be notified to NHS Supply Chain before the delivery date. Delivery dates are not allowed to be changed for Blue Diamond type orders. If an Order Response for a Blue Diamond order is received with a change in Delivery Date the change in date will be ignored. 1.3 eDirect Orders eDirect orders allow for changes in Delivery Dates and Quantities. Delivery Dates must not be in the past or for the current day. Suppliers must therefore submit any changes to orders before the day of delivery. Validation will take place on the eDirect order responses and any failure will result in the Order Response being rejected back to the supplier via an email.
Page 7 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
1.4 Order Response If sending Order Response via PEPPOL, NHS Supply Chain will validate the delivery date (PromisedDeliveryPeriod\Start Date). This validation will reject any Order Responses with a delivery date that falls on a weekend or UK bank holiday. 1.5 Advanced Shipping Notification - ASN This section is provided to highlight the mandatory requirements for successful shipment into (or on behalf of) the NHS Supply Chain. This includes the transmission of a PEPPOL Advanced shipping note, the correct labelling standards including Serial Shipping Container Codes (SSCC). Advanced Shipping Notes (ASN) are required for all types of orders and are mandatory for the shipment of items that fall under the European Medical Device Regulation (MDR) legislation. The ASN requires suppliers to provide handling unit (Pallet, Cage or Carton) information including the hierarchy within the delivery, were applicable. Some examples of handling unit hierarchy are explained in the sections below. The ASN must be an accurate representation of what has been shipped, handling units and items that are contained in within each handling unit. The new PEPPOL ASN message requirements can be found in section 7. Advanced Shipping Notes (ASN) Despatch Advices. All Shipping Label requirements can be found in section Appendix B – Labels. The ASN message can be used instead of the existing Confirmations (Despatch Advice) message as the NHS Supply Chain systems will automatically generate Confirmations during the processing of ASN messages. 1.5.1 Serial Shipping Container Code (SSCC) The Serial Shipping Container Code (SSCC) is an 18-digit number used to identify logistics units. NHS Supply Chain requires suppliers to use SSCC codes on the ASN and the Shipping Labels. In addition, NHS Supply Chain expects that suppliers will send ASNs with SSCC at both Pallet\Cage level as well as a carton level (As appropriate). In order to automate the reading process, the SSCC should be encoded in a barcode (GS1-128) on Shipping Labels.
Page 8 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
1.5.2 Basic ASN Hierarchy Below is an example of a basic delivery (represented by the truck) with items built onto a single layer hierarchy e.g. a Carton, Pallet or Cage only.
1.5.3 Complex ASN Hierarchy Below is an example of a complex delivery (represented by the truck) with items within cartons which are then built onto pallets.
Page 9 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
1.6 Despatch Advice (Delivery Confirmation) Current Despatch Advice (Delivery Confirmation) is a legacy message, it has been replaced by Advance Shipping Notification (ASN) See section 1.4 for details Despatch Advice (Delivery Confirmations) are required for eDirect orders only. If a confirmation is received for Stock or Blue Diamond type orders they will be ignored and not processed. All eDirect Orders must be confirmed as despatched prior to 4pm on the day of delivery.
Page 10 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
2 Benefits and changes of moving to PEPPOL
2.1 Benefits of PEPPOL with NHS Supply Chain There are many benefits for both suppliers and NHS Supply Chain by moving to PEPPOL processes. Though not all may apply to every supplier, the following list provides some of the more commonly identified benefits: ▪ PEPPOL messaging is a fast, accurate and versatile way for passing information between trading partners’ systems, enabling better business decisions to be made ▪ PEPPOL Invoices are more readable than PDF files and removes the occurrence of lost ‘paper’ invoices, which enables faster processing of supplier invoices. This, in turn, improves the average days outstanding of supplier invoices ▪ NHS Supply Chain are following the Department of Health Scan4Safety initiative in implementing PEPPOL messaging systems and prefer to deal with compliant suppliers.. ▪ Moving to PEPPOL messaging with NHS Supply Chain means suppliers will trade using a single, uniform process ▪ Suppliers who implement PEPPOL with NHS Supply Chain will be compliant with the Department of Health PEPPOL Scan4Safety initiative 2.2 Important business process changes This section contains important information about dealing with NHS Supply Chain Business Documents, some of which may differ from the historic (Pre-PEPPOL) processes. NHS Supply Chain strongly recommend that the following section is shared with the Business Operations Team within the Suppliers Organisation. 2.2.1 Order Notes Order notes can appear on the Order Header and the Order Lines and suppliers need to take account of the details within the notes fields. For orders where the batch/serial number of an item is required then this will be output in the order line notes. 2.2.2 Labelling All Blue Diamond (Cross-Dock) and eDirect orders will contain label information that is required to be printed on any labels produced for the order. All data required for the labels as per the NHS Supply Chain requirements will be included in the PEPPOL Order message. Example labels and details of the PEPPOL fields to use to produce the labels can be found in Appendix B – Labels. 2.2.3 Order Amendments Suppliers can utilise the Order Response message to make amendments to quantities for all order types, rather than emailing or manually amending the order via the Supplier Portal. Suppliers can also utilise the Order Response message to cancel an order in full. eDirect suppliers can also use the Order Response message to notify NHS Supply Chain of a change in Delivery Date, replacing the need to use the Supplier Portal for this information. You can provide multiple order responses up to the point a Delivery Note has been received by NHS Supply Chain. Any order responses received after a Delivery Note has been received will be rejected. This ensures that both the Suppliers and NHS Supply Chain systems are kept in sync.
Page 11 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
2.2.4 Despatch Advice (Delivery Confirmation) – eDirect orders only Please note: This section details the legacy Despatch Confirmation requirements, this should only be used while suppliers implement the ASN message. For eDirect Orders, suppliers need to confirm that an order has been delivered. The Despatch Advice must reach NHS Supply Chain prior to 16:00 on the day of delivery. The PEPPOL Despatch Advice message is utilised for this process and allows suppliers to confirm to NHS Supply Chain that the goods have been despatched. Failure to confirm delivery may result in delayed payment of the invoice. Utilising the PEPPOL Despatch Advice message removes the need to confirm orders via the NHS Supply Chain Supplier Portal. If Despatch Advices are received for other types of orders they will be ignored. The Supplier Advanced Shipping Notification (ASN) will replace the Despatch Advice Confirmation message, see below for more information. 2.2.5 Despatch Advice (ASN) The NHS Supply Chain has chosen to implement a new ASN message to meet new Medical Device Regulation (MDR) requirements. As part of this ASN message Suppliers will require to send additional information (Detailed in section 8.) and provide new labels (Detailed in Appendix B). The Despatch Advice (ASN) message is an extension of the PEPPOL Despatch Advice message as used by the existing Delivery Confirmation. The ASN message requires more information around product attributes but more significantly, handling units and the hierarchy of them in relation to the delivery (Detailed in section 1.5). If a supplier is sending ASN messages they do not need to send a Delivery Confirmation message. 2.2.6 Order Response, Despatch Advice, Invoice and Credit Note rejections You will be required to set up a generic email box for rejected order responses, despatch advices, invoices and credit notes and confirm the address to us. Details of any documents that fail validation will be returned to this address. 2.2.7 Delivery Location GLN NHS Supply Chain have allocated new Global Location Numbers (GLN) to be used for identifying Delivery Points for Stock and Blue Diamond type orders when using PEPPOL messages. The table below details the changes in GLN’s and shows the old and new GLN’s that are required on the PEPPOL messages.
Name Address Lines 1 Address Line 2 Postal Area Province Post Code New GLN Old GLN Alfreton West Way Cotes Park Industrial Estate Alfreton Derbyshire DE55 4QJ 5019100000006 5026744999993 RDC Runcorn Lister Road Astmoor Industrial Estate Runcorn Cheshire WA7 1SW 5019100000013 5019802000016 RDC Bridgwater Unit 6, Express Way Bristol Road Bridgwater Somerset TA6 4RN 5019100000020 5019100700005 RDC Normanton Foxbridge Way Normanton West Yorkshire WF6 1TL 5019100000037 5020668000003 RDC Maidstone St Barnabas Close Allington Maidstone Kent ME16 0LW 5019100000044 5020252000008 RDC Bury RDC Olding Road Bury St Suffolk IP33 3YE 5019100000051 5018885000005 Edmunds Rugby Valley Point Valley Drive Rugby Warwickshire CV21 1TN 5019100000068 5018885000021 RDC Rugby Valley Point Valley Drive Rugby Warwickshire CV21 1TN 5019100000075 5020901009211 NDC
Delivery Points for eDirect type orders are identified using the NHS Supply Chain Delivery Point code which is specified on the PEPPOL messages. 2.2.8 Invoices Delivery charges on Invoices are only supported were specific agreement has been made with NHS Supply Chain or a delivery charge is included on an Order. Otherwise, delivery charges issued on invoices to NHS Supply Chain will be ignored.
Page 12 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
3 Exchanging PEPPOL Documents with NHS Supply Chain NHS Supply Chain has adopted the PEPPOL messaging and communication standards as specified by the Department of Health. PEPPOL provides a secure, encrypted, standardised, direct point to point connection between NHS Supply Chain’s Access Point and the suppliers’ Access Point. PEPPOL also provides message delivery confirmation to ensure what is sent has been successfully received. Suppliers can source their own PEPPOL Access Point or NetEDI can provide an Access Point as part of their service offering. 3.1 Pre-requisites Before beginning to review the PEPPOL message usage in detail you should have a good understanding of the Open PEPPOL requirements. This includes connectivity and message details. This guide provides details of the specific PEPPOL requirements for NHS Supply Chain in line with the Open PEPPOL standards. Further details can be found on the http://www.peppol.eu/ressource-library/technical-specifications pages. We would recommend reviewing the Post Award section which provides detailed information on the PEPPOL standards and requirements. 3.2 NHS Supply Chain PEPPOL Connectivity NHS Supply Chain has selected NetEDI as their PEPPOL Access Point provider. Every PEPPOL message will be transmitted and received via the NetEDI Access Point. The NetEDI Access Point is an approved Department of Health Access Point capable of exchanging messages with any PEPPOL Certified Access Point. Below is a diagram highlighting where the Access Points fit in the flow of messages between the Supplier and NHS Supply Chain.
Purchase Order
NHSSupply Chain PEPPOL AccessPoint Order Response
SupplierPEPPOL AccessPoint Chain NHS Supply
Supplier Despatch Advice
ASN
Invoice
Credit Note
Page 13 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
3.1.1 PEPPOL ID’s NHS Supply Chain has allocated two PEPPOL ID’s that are used for exchanging messages on the PEPPOL network.
PEPPOL ID Name 0088:5019100000105 NHS Supply Chain (Test) 0088:5026744000002 NHS Supply Chain (Live)
These ID’s should be used within the StandardBusinessDocumentHeader section of the PEPPOL message for the following data elements.
The Sender element will be populated with one of the above ID’s for Order messages.
The Receiver element should be populated with one of the above ID’s for when you send any message into NHS Supply Chain
GS1 UK As part of the Scan4Safety strategy all Suppliers need to join GS1 UK to allow items to be barcoded. Barcoding products is not an immediate requirement for trading with NHS Supply Chain but Suppliers do need to register with GS1 to provide your GS1 allocated Global Location Number (GLN). The GLN forms part of the PEPPOL ID that is used to identify Trading Partners on the PEPPOL network. More information is available on GS1 web site where you can also find details on how to join GS1.
3.1.2 Contact Information If you have any questions regarding the setup of the PEPPOL Connection, then please use the details below for help.
Company Name: NetEDI (NHS Supply Chain Onboarding Team) Name: Tasmin Richards (Onboarding Manager) Contact Tel: 01772 977781 Contact email: [email protected]
Page 14 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
4 NHS Supply Chain PEPPOL document Summary NHS Supply Chain has identified five key PEPPOL documents which will provide the greatest benefit with our supply chain. These five documents are Purchase Orders, Order Responses, Advanced Shipping Notes (Legacy Despatch Advices), Invoices and Credit Notes. The following sections contain the specific requirements for exchanging messages with NHS Supply Chain. To obtain the full PEPPOL specifications including communication details, please visit the http://www.peppol.eu web site. Full documentation on the messages used by NHS Supply Chain can be found at http://www.peppol.eu/ressource-library/technical-specifications/post-award/mandatory The following sections contain the specific requirements for NHS Supply Chain. These include mandatory elements required by the PEPPOL specifications as well as additional mandatory elements or elements that could be used by NHS Supply Chain. Providing data in any element not specified in the sections below will be ignored. For some elements, the occurrence column has been changed from the PEPPOL standards to reflect the usage by NHS Supply Chain. The Bus. Req. (Business Requirement) column in the specifications refer to rules within the full PEPPOL message documentation.
• tirNN-NNN – Cover rules that are specified in the message Detail section of the full PEPPOL specification • OPXNN-NNN – Cover specific PEPPOL Requirements
Page 15 of 143 v3.61 5. Purchase Orders
5.1 Department of Health Data Dictionary changes The following table outlines changes made to the NHS Supply Chain Order message to be in line with the Department of Health’s Data Dictionary published in June 2017.
Type Element Details Added Order/cbc:IssueTime Changed Order/BuyerCustomerParty/Party/EndpointID Content changed to match the Sender GLN within the SDBH Envelope. i.e. 5026744000002 or 5019100000105 Added Order/BuyerCustomerParty/Party/PartyIdentification/ID Always 5026744000002 Added Order/OriginatorCustomerParty/Party/PartyIdentification/ID Requisition Point (GLN or other code) – used for eDirect type orders only Added Order/OrderLine/LineItem/Item/Name Changed from NHS Product Code to Product Description Added Order/OrderLine/LineItem/Item/ClassifiedTaxCategory/ID Added Tax Code S or Z Added Order/OrderLine/LineItem/Item/ClassifiedTaxCategory/TaxScheme Added Tax Percentage Added Order/OrderLine/LineItem/Item/AdditoinalItemPropertyName BuyersItemIdentification Added Order/OrderLine/LineItem/Item/AdditionalItemProperty/Value NHS Supply Chain Item Code Changed Order/cbc:OrderTypeCode Removed 227 Consignment Order type.
NHS Supply Chain Supplier Message Implementation Guide
5.2 Requirements The following table contains the elements provided by NHS Supply Chain within the Purchase Order Document.
Element/Attribute Description Usage
Order Type OrderType
cbc:CustomizationID Occurrence 1 .. 1 Term name Customization identifier Type Identifier Usage Identifies the specification of content and rules that apply to the Info req.ID tir01-001 transaction Example urn:fdc:peppol.eu:poacc:trns:order:3 Rules PEPPOL-T01-B00201 - Element 'cbc:CustomizationID' MUST contain value 'urn:fdc:peppol.eu:poacc:trns:order:3'.
cbc:ProfileID Occurrence 1 .. 1 Term name Profile identifier Type Identifier Usage Identifies the BII profile or business process context in which the Info req.ID tir01-002 transaction appears. Values to be used are either Example urn:fdc:peppol.eu:poacc:bis:order_only:3 urn:fdc:peppol.eu:poacc:bis:order_only:3 or urn:fdc:peppol.eu:poacc:bis:ordering:3
cbc:ID Occurrence 1 .. 1 Term name Order identifier Type Identifier Usage A transaction instance must have an identifier. The identifier enables Info req.ID tir01-003 referencing the transaction for various purposes such as from other Example 0-123 transactions that are part of the same process
cbc:IssueDate Occurrence 1 .. 1 Term name Order issue date Type Date Usage The date on which the transaction instance was issued. Info req.ID tir01-004 Example 2018-06-01
cbc:OrderTypeCode Occurrence 1 .. 1 Term name Order type indication Type cbc:OrderTypeCodeType Usage Indicates whether the order is a Stock, Blue Diamond or eDirect Info req.ID tir01-153 order. 105=Stock, 220=eDirect, 402=Blue Diamond Example 220 Rules PEPPOL-T01-B00801 - Value MUST be part of code list 'Order type Bus req.ID tbr01-002 code (UNCL1001 subset)'.
Page 17 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cbc:Note Occurrence 0 .. 1 Term name Document level textual note Type Text Usage Free form text applying to the Order. This element may contain Info req.ID tir01-006 notes or any other similar information that is not contained explicitly Example Packages of other sizes are OK in another structure.
cbc:DocumentCurrencyCode Occurrence 1 .. 1 Term name Currency Type Code Usage The default currency for the order. Info req.ID tir01-007 Rules PEPPOL-T01-B01001 - Value MUST be part of code list 'Currency Example GBP codes (ISO 4217)'
cac:ValidityPeriod Occurence 1 .. 1 Term name Validity period Type PeriodType Usage The end date for when the order is valid. The end date for the time period within which the seller must respond. An order should contain the validity end date Rules PEPPOL-T01-B01301- Element 'cbc:EndDate' MUST be provided. PEPPOL-T01-B01302 - Document MUST NOT contain elements not part of the data model.
cbc:EndDate Occurrence 1 .. 1 Term name Order validity end date Type Date Usage Requested Delivery Date Info req.ID tir01-009 Rules PEPPOL-T01-R002 - An order SHOULD provide information about Example 2018-06-02 its validity end date.
cac:AdditionalDocumentReference Occurrence 0 .. 5 Term name Additional document reference Type cac:DocumentReferenceType Rules PEPPOL-T01-B02101 - Element 'cbc:ID' MUST be provided. PEPPOL-T01-B02102 - Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Document identifier Type Identifier type Usage Information to be printed on labels as defined by the DocumentType Info req.ID tir01-154 element. Example doc - 34
cbc:DocumentType Occurrence 1 .. 1 Term name Document description Type cbc:DocumentTypeType Usage A short description of the document reference type. Info req.ID tir01-016 Valid Types Reqpt = Requisition Point Bus req.ID tbr01-006 Reqpt Name = Requisition Point Name Example Reqpt Reqptno = Requisition Point Number SortRef = Sorting Reference DoHCode = Department of Health Code
Page 18 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cac:Contract Occurence 0 .. 1 Term name Contract Type cac:ContractType Usage Reference to Contract
Rules PEPPOL-T01-B03001 - Element 'cbc:ID' MUST be provided. PEPPOL-T01-B03002 - Document MUST NOT contain elements not part of the data model
cbc:ID Occurrence 1 .. 1 Term name Reference identifier Type cbc:IDType Usage NHS Supply Chain Contract Number. Info req.ID tir01-019
Example
Page 19 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:BuyerCustomerParty Occurence 1 .. 1 Term name Buyer customer Type CustomerPartyType Usage Description of buyer Rules PEPPOL-T01-B03201 - Element 'cac:Party' MUST be provided PEPPOL-T01-B03202 - Document MUST NOT contain elements not part of the data model.
cac:Party Occurence 1 .. 1 Term use Party Type PartyType Rules PEPPOL-T01-B03301- Element 'cbc:EndpointID' MUST be provided PEPPOL-T01-B03302 Element 'cac:PartyLegalEntity' MUST be provided PEPPOL-T01-B03303 - Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurrence 1 .. 1 Term name Buyer party endpoint identifier Type EndpointIDType Usage Identifies the end point of the routing service. Info req.ID tir01-021 Rules PEPPOL-T01-B03401 Example 5026744000002 or 5019100000105 Attribute 'schemeID' MUST be present.
schemeID Type7300010000001 Identifier Rules PEPPOL-T01-B03402 Use required Value MUST be part of code list 'Electronic Address Scheme Example 0088 (EAS)'.
cac:PartyIdentification Occurence 0 .. 1 CodeRules List ID: PEPPOL:PartyIdentifierPEPPOL-T01-B03601 - Element 'cbc:ID' MUST be provided. Type PartyIdentificationType cbc:ID Occurrence 1 .. 1 Term name Buyer party identification Type Identifier type BII Usage An identification for the buyer party. Info req.ID tir01-022 Example 5026744000002
schemeID Type xs:normalizedString Rules PEPPOL-T01-B03701 - Value MUST be part of code list 'ISO 6523 Use required ICD list'. Example 0088
cac:PartyName Occurence 1 .. 1 Rules PEPPOL-T01-B03901- Element 'cbc:Name' MUST be provided. Type cac:PartyNameType cbc:Name Occurrence 1 .. 1 Type Text Info req.ID tir01-023 Example Buyer name
cac:PostalAddress Occurence 1 .. 1 Rules PEPPOL-T01-B04101 - Element 'cac:Country' MUST be Type AddressType provided. PEPPOL-T01-B04102 - Document MUST NOT contain elements not part of the data model.
Page 20 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type cbc:StreetNameType Usage The main address line in a postal address usually the street name Info req.ID tir01-032 and number.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type cbc:AdditionalStreetNameType Usage An additional address line in a postal address that can be used to Info req.ID tir01-027 give further details supplementing the main line. Common use are secondary house number in a complex or in a building.
cbc:CityName Occurrence 0 .. 1 Term name City Type cbc:CityNameType Usage The common name of the city where the postal address is. The
Info req.ID tir01-031 name is written in full rather than as a code.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type cbc:PostalZoneType Usage The identifier for an addressable group of properties according to Info req.ID tir01-024 the relevant national postal service, such as a ZIP code or Post Code. cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type cbc:CountrySubentityType Usage For specifying a region, county, state, province etc. within a country Info req.ID tir01-141 by using text.
cac:Country Occurrence 1 .. 1 Term name Country Rules PEPPOL-T01-B04901 - Element 'cbc:IdentificationCode' MUST be
provided. PEPPOL-T01-B04902 - Document MUST NOT contain elements not part of the data model. cbc: IdentificationCode Occurrence 1 .. 1 Term name Identification code Type udt:CodeType Rules PEPPOL-T01-B05001 - Value MUST be part of code list 'Country Info req.ID tir01-033 codes (ISO 3166-1:Alpha2)'. Example GB
cac:PartyLegalEntity Occurrence 1 .. 1 Term name Party Legal Entity Rules PEPPOL-T01-B05501 - Element 'cbc:RegistrationName' MUST be provided. PEPPOL-T01-B05502 Document MUST NOT contain elements not part of the data model.
Occurrence 1 .. 1 Term name Registration Name Type udt:NameType cac:RegistrationName Info req.ID tir01-044 Example Text
Page 21 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Contact Occurence 0 .. 1 Rules PEPPOL-T01-B06301- Document MUST NOT contain elements not Type ContactType part of the data model.
cbc:Name Occurrence 0 .. 1 Term name Contact person name Type Text Usage The name of the contact person. Info req.ID tir01-050
cbc:Telephone Occurrence 0 .. 1 Term name Contact telephone number Type Text Usage A phone number for the contact person. If the person has a direct Info req.ID tir01-047 number, this is that number.
cbc:ElectronicMail Occurrence 0 .. 1 Term name Contact email address Type Text Usage The e-mail address for the contact person. If the person has a direct Info req.ID tir01-049 e-mail this is that email.
cac:SellerSupplierParty Occurrence 1 .. 1 Term name Seller supplier party Type cac:SupplierPartyType Usage Identifies the supplier Rules PEPPOL-T01-B06701 - Element 'cac:Party' MUST be provided. PEPPOL-T01-B06702 - Document MUST NOT contain elements not part of the data model. cac:Party Occurrence 1 .. 1 Rules PEPPOL-T01-B06801 - Element 'cbc:EndpointID' MUST be Type PartyType provided. PEPPOL-T01-B06802 - Element 'cac:PostalAddress' MUST be provided. PEPPOL-T01-B06803 - Element 'cac:PartyLegalEntity' MUST be provided. PEPPOL-T01-B06804 - Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurrence 1 .. 1 Term name Seller party endpoint identifier Type cbc:EndpointIDType Usage Identifies the end point of the routing service. Info req.ID tir01-058 Rules PEPPOL-T01-B06901 - Attribute 'schemeID' MUST be present. Example 9999999999999 schemeID ExampleType 999999999xs:normalizedString Rules PEPPOL-T01-B06902- Value MUST be part of code list 'Electronic Use required Address Scheme (EAS)'. Example 0088 cac:PartyIdentification Occurence 1 .. 1 Rules PEPPOL-T01-B07101 - Element 'cbc:ID' MUST be provided.
OccurrenceType 1cac:PartyIdentificationType .. 1 Term name Seller party identification Type Identifier cbc:ID Info req.ID tir01-059 Example 99999999
schemeID Type xs:normalizedString Rules PEPPOL-T01-B07201 - Value MUST be part of code list 'ISO 6523 Use required ICD list'. 0080 is used to represent the NHS Supply Chain code for Example 0080 the supplier. cac:PartyName Occurrence 1 .. 1 Rules PEPPOL-T01-B07401 - Element 'cbc:Name' MUST be provided. Type cac:PartyNameType
Page 22 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage Occurrence 1 .. 1 Term name Seller party name Type NameType Usage The name of the party. cbc:Name Info req.ID tir01-060 Example Seller name cac:PostalAddress Occurence 1 .. 1 Rules PEPPOL-T01-B07601 - Element 'cac:Country' MUST be provided. Type cac:AddressType PEPPOL-T01-B07602 - Document MUST NOT contain elements not part of the data model.
cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type Text Usage The main address line in a postal address usually the street name Info req.ID tir01-063 and number.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type Text Usage An additional address line in a postal address that can be used to Info req.ID tir01-064 give further details supplementing the main line. Common use are secondary house number in a complex or in a building.
cbc:CityName Occurrence 0 .. 1 Term name City Type Text Usage The common name of the city where the postal address is. The Info req.ID tir01-065 name is written in full rather than as a code.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type Text Usage The identifier for an addressable group of properties according to Info req.ID tir01-068 the relevant national postal service, such as a ZIP code or Post
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type Text Usage For specifying a region, county, state, province etc. within a country Info req.ID tir01-142 by using text.
cac:Country Occurrence 1 .. 1 Rules PEPPOL-T01-B08401- Element 'cbc:IdentificationCode' MUST be Type cac:CountryType provided. PEPPOL-T01-B08402 - Document MUST NOT contain elements not part of the data model.
cbc:IdentificationCode Occurrence 1 .. 1 Term name Country code Type Code Usage The country where the address is. The country should always be Info req.ID tir01-069 given by using ISO code 3166 alpha 2 Example NL Rules PEPPOL-T01-B08501 - Value MUST be part of code list 'Country codes (ISO 3166-1:Alpha2)'.
cac:PartyLegalEntity Occurrence 1 .. 1 Rules PEPPOL-T01-B08601 Element 'cbc:RegistrationName' MUST be Type cac:PartyLegalEntity provided. PEPPOL-T01-B08602 Document MUST NOT contain elements not part of the data model.
Occurrence 0 .. 1 Term name Registration Name Type udt:NameType cac:RegistrationName Info req.ID tir01-044
Page 23 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:OriginatorCustomerParty Occurence 0 .. 1 Rules PEPPOL-T01-B09801 - Element 'cac:Party' MUST be provided. Type cac:CustomerPartyType PEPPOL-T01-B09802 - Document MUST NOT contain elements not part of the data model. cac:Party Occurence 1 .. 1 Rules PEPPOL-T01-B09901 - Document MUST NOT contain elements Type cac:PartyType not part of the data model. cac:PartyIdentification Occurence 0 .. 1 Rules PEPPOL-T01-R014 - An order SHALL have the originator party Type cac:PartyIdentificationType name or an identifier. PEPPOL-T01-B10001 - Element 'cbc:ID' MUST be provided.
cbc:ID Occurrence 1 .. 1 Term name Originator identifier Type cbc:IDType Usage Identifies a party. Info req.ID tir01-081
schemeID Type xs:normalizedString Rules PEPPOL-T01-B10101 - Value MUST be part of code list 'ISO 6523 Use required ICD list'. Example 0088 cac:AccountingCustomerParty Occurence 1 .. 1 Usage Identifies the NHS Supply Chain Payable Department Type cac:CustomerPartyType Rules PEPPOL-T01-B10901 - Element 'cac:Party' MUST be provided. PEPPOL-T01-B10902 - Document MUST NOT contain elements not part of the data model.
cac: Party Occurence 1 .. 1 Rules PEPPOL-T01-B11001 - Element 'cac:PostalAddress' MUST be Type cac:PartyType provided. PEPPOL-T01-B11002 - Element 'cac:PartyLegalEntity' MUST be provided. PEPPOL-T01-B11003 - Document MUST NOT contain elements not part of the data model.
Occurrence 1 .. 1 Term name Endpoint identifier Type Identifier Usage Identifies the end point of the routing service. cbc:EndpointID Info req.ID tir01-157 Rules PEPPOL-T01-B11101 - Attribute 'schemeID' MUST be present. Example 5026744000002 or 5019100000105
schemeID Type xs:normalizedString Rules PEPPOL-T01-B11102 - Value MUST be part of code list 'Electronic Use required Address Scheme (EAS)'.
Example 0088 cac:PartyIdentification Occurrence 0 .. 1 Rules PEPPOL-T01-B11301 - Element 'cbc:ID' MUST be provided. Type cac:PartyIdentificationType cbc:ID Occurrence 1 .. 1 Term name Originator identifier Type Identifier Usage Identifies a party. Info req.ID tir01-156 Example 5026744000002
schemeID Type xs:normalizedString Rules PEPPOL-T01-B11401 - Value MUST be part of code list 'ISO 6523 Use required ICD list'. Example 0088 cac:PartyName Occurence 1 .. 1 Rules PEPPOL-T01-B11601 - Element 'cbc:Name' MUST be provided. Type cac:PartyNameType
Page 24 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage Occurrence 1 .. 1 Term name Party name Type Text Usage The name of the party who should be invoiced for the ordered cbc:Name Info req.ID tr01-155 items. Example Invoice Name
cac:PostalAddress Occurence 1 .. 1 Rules PEPPOL-T01-B11801 - Element 'cac:Country' MUST be provided. Type cac:AddessType PEPPOL-T01-B11802- Document MUST NOT contain elements not part of the data model. Occurrence 0 .. 1 Term name Address line 1 Type Text Usage The main address line in a postal address usually the street name cbc:StreetName Info req.ID tir01-p013 and number.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type Text Usage An additional address line in a postal address that can be used to Info req.ID tir01-p014 give further details supplementing the main line. Common use are secondary house number in a complex or in a building.
cbc:CityName Occurrence 0 .. 1 Term name City Type Text Usage The common name of the city where the postal address is. The Info req.ID tir01-p009 name is written in full rather than as a code.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type Text Usage The identifier for an addressable group of properties according to Info req.ID tir01-p015 the relevant national postal service, such as a ZIP code or Post Code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type Text Usage For specifying a region, county, state, province etc. within a country Info req.ID tir01-p016 by using text.
Occurrence 1 .. 1 Term name Country Usage PEPPOL-T01-B12601. Element 'cbc:IdentificationCode' MUST be cac:Country provided. PEPPOL-T01-B12602Document MUST NOT contain elements not part of the data model.
Cbc:IdentificationCode Occurrence 1 .. 1 Rules PEPPOL-T01-B12701 Value MUST be part of code list 'Country Type Code codes (ISO 3166-1:Alpha2)'. Info req.ID tir01-p017
cac:PartyLegalEntity Occurrence 1 .. 1 Rules PEPPOL-T01-B13201 Element 'cbc:RegistrationName' MUST be Type Code provided. PEPPOL-T01-B13202Document MUST NOT contain elements not part of the data model.
Cbc:RegistrationName Occurrence 1 .. 1 Type Text Info req.ID tir01-159
Page 25 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Delivery Occurence 1 .. 1 Usage Identifies the Delivery Point Type ac:DeliveryType Rules PEPPOL-T01-B14401 - Document MUST NOT contain elements not part of the data model.
cac:DeliveryLocation Occurence 1 .. 1 Rules PEPPOL-T01-B14501 - Element 'cac:Address' MUST be provided. Type ac:LocationType PEPPOL-T01-B14502 -Document MUST NOT contain elements not part of the data model. cbc:ID Occurrence 1 .. 1 Term name Delivery location ID Type Identifier Usage An identifier for the location to where the ordered items should be Info req.ID tir01-169 delivered. For Stock and Blue Diamond type orders this will be the Example 9999999999999 GLN of the depot to deliver to. For eDirect type orders this will be the Delivery Point code allocated by NHS Supply Chain schemeID Type xs:normalizedString Usage 0088 = Depot GLN Use Required 0080 = eDirect Delivery Point Code Example 0088 Rules PEPPOL-T01-B14601 - Value MUST be part of code list 'ISO 6523 ICD list'. cac:Address Occurence 1 .. 1 Rules PEPPOL-T01-B14901 - Element 'cac:Country' MUST be provided. Type cac:AddressType PEPPOL-T01-B14902 - Document MUST NOT contain elements not part of the data model.
cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type cbc:StreetNameType Usage The main address line in a postal address usually the street name Info req.ID tir01-092 and number.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type cbc:AdditionalStreetNameType Usage An additional address line in a postal address that can be used to Info req.ID tir01-093 give further details supplementing the main line. Common use are secondary house number in a complex or in a building.
cbc:CityName Occurrence 0 .. 1 Term name City Type cbc:CityNameType Usage The common name of the city where the postal address is. The Info req.ID tir01-096 name is written in full rather than as a code.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type cbc:PostalZoneType Usage The identifier for an addressable group of properties according to Info req.ID tir01-097 the relevant national postal service, such as a ZIP code or Post Code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type cbc:CountrySubentityType Usage For specifying a region, county, state, province etc. within a country Info req.ID tir01-144 by using text.
Page 26 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Country Occurence 0 .. 1 Rules PEPPOL-T01-B15701 - Element 'cbc:IdentificationCode' MUST be Type cac:CountryType provided. PEPPOL-T01-B15702 - Document MUST NOT contain elements not part of the data model.
Occurrence 1 .. 1 Term name Country code Type cbc:IdentificationCodeType Usage The country where the address is. The country should always be cbc:IdentificationCode Info req.ID tir01-098 given by using ISO code 3166 alpha 2 Example NL Rules PEPPOL-T01-B15801 - Value MUST be part of code list 'Country codes (ISO 3166-1:Alpha2)'.
cac:RequestedDeliveryPeriod Occurence 1 .. 1 Rules PEPPOL-T01-B15901 - Document MUST NOT contain elements not Type ac:PeriodType part of the data model. Occurrence 1 .. 1 Term name Period start date Type Date Usage Requested Delivery Date cbc:StartDate Info req.ID tir01-099
cbc:EndDate Occurrence 1 .. 1 Term name Period end date Type Date Usage Requested Delivery Date (same as StartDate) Info req.ID tir01-100
cac:DeliveryParty Occurence 1 .. 1 Rules PEPPOL-T01-B16201 - Element 'cac:PartyName' MUST be Type cac:PartyType provided. PEPPOL-T01-B16202 - Document MUST NOT contain elements not part of the data model.
cac:PartyIdentification Occurence 0 .. 1 Rules PEPPOL-T01-B16301 - Element 'cbc:ID' MUST be provided. Type cac:PartyIdentificationType
cbc:ID Occurrence 1 .. 1 Term name Delivery party ID Type cbc:IDType BII Usage An identifier for the party that should deliver the ordered items. In Info req.ID tir01-101 this BIS: The identifier of the party that should receive the ordered Example 9999999999999 items
schemeID Type xs:normalizedString Rules PEPPOL-T01-B16401 - Value MUST be part of code list 'ISO 6523 Use required ICD list'. Example 0088 Occurence 1 .. 1 Rules PEPPOL-T01-B16601 - Element 'cbc:Name' MUST be provided. Type Text cac: PartyName
Occurrence 1 .. 1 Term name Delivery party name Type Text Usage The name of the party that should handle the delivery. In this BIS: cbc:Name Info req.ID tir01-102 The name of the party that should receive the delivery
Example Surgery deparment
Page 27 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:AllowanceCharge Occurrence 0 .. unbounded Usage Used to specify any Carriage or Delivery Charges that may apply to Type cac:AllowanceChargeType this order.
Rules PEPPOL-T01-B18901 - Element 'cbc:ChargeIndicator' MUST be provided. PEPPOL-T01-B18902 - Element 'cbc:AllowanceChargeReason' MUST be provided. PEPPOL-T01- B18903 - Element 'cbc:Amount' MUST be provided. PEPPOL-T01- B18904 - Document MUST NOT contain elements not part of the data model.
cbc:ChargeIndicator Occurrence 1 .. 1 Term name AllowanceChargeIndicator Type Boolean BII Usage True = Charge, False = Allowance Info req.ID tir01-p002 Example False Rule PEPPOL-T01-B19001 - Value MUST be part of code list 'Boolean indicator (openPEPPOL)'.
cbc:AllowanceChargeReason Occurrence 1 .. 1 Term name Allowance and charges reason Type Text BII Usage A textual reason for the allowance or the charge. Can also be its Info req.ID tir01-112 name. Rules PEPPOL-T01-R023 - Each document or line level allowance SHALL have an allowance reason text or an allowance reason code.
cbc:Amount Occurrence 1 .. 1 Term name Allowance and charge amount Type Amount BII Usage The net amount of the allowance or the charge exluding VAT. Info req.ID tir01-113 Example 220 Rules PEPPOL-T01-R022 - Allowance/charge amount SHALL equal base amount * percentage/100 if base amount and percentage exists. PEPPOL-T01-R028 - Elements of data type amount cannot have more than 2 decimals (I.e. all amounts except unit price amounts). PEPPOL-T01-B19401 - Attribute 'currencyID' MUST be present.
Type xs:normalizedString Rules PEPPOL-T01-R003 - An order SHALL be stated in a single Use required currency. PEPPOL-T01-B19402 - Value MUST be part of code list currencyID Example GBP 'Currency codes (ISO 4217)'.
Page 28 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:OrderLine Occurrence 1 .. unbounded Rules PEPPOL-T01-B22301 - Element 'cac:LineItem' MUST be provided. Type cac:OrderLineType PEPPOL-T01-B22302- Document MUST NOT contain elements not part of the data model.
Occurrence 0 .. 1 Term name Order line note Type Text Usage Free-form text applying to the Order Line. This element may contain cbc:Note Info req.ID tir01-123 notes or any other similar information that is not contained explicitly in another structure. Is to capture any free form description related to the order line as a whole.
cac:LineItem Occurence 1 .. 1 Rules PEPPOL-T01-B22501 - Element 'cbc:ID' MUST be provided.
Type cac:LineItemType PEPPOL-T01-B22502 - Element 'cbc:Quantity' MUST be provided. PEPPOL-T01-B22503- Element 'cac:Item' MUST be provided. PEPPOL-T01-B22504- Document MUST NOT contain elements not part of the data model.
Occurrence 1 .. 1 Term name Document line identifier Type cbc:IDType Usage Identifies the Line Item assigned by the buyer. cbc:ID Info req.ID tir01-120 Example 1 Rules PEPPOL-T01-R001- Each order line SHALL have a document line identifier that is unique within the order.
cbc:Quantity Occurrence 1 .. 1 Term name Ordered quantity Type cbc:QuantityType RulesUsage BII2The -quantityT01-R003 for - theEach order order line. line MUST have a document line Info req.ID tir01-132 Rules PEPPOL-T01-R004 - Each order line ordered quantity SHALL not Example 10 identifier that is uniquebe negative. within the PEPPOL order -T01-R013 - Each order line SHOULD have an ordered quantity. PEPPOL-T01-B22701 - Attribute 'unitCode' MUST be present. Type xs:normalizedString Rules PEPPOL-T01-B22702 - Value MUST be part of code list ' Use required Recommandation 20, including Recommondation 21 codes - unitCode prefixed with X (UN/ECE)'. Example C62
cbc:LineExtensionAmount Occurrence 1 .. 1 Term name Order line amount Type Amount Usage The total amount for the Line Item, including Allowance Charges but Info req.ID tir01-128 net of taxes. The expected line amount excluding VAT but inclusive Example 200 of other charges, allowances and taxes.
Rules PEPPOL-T01-R024 - Order line net amount SHALL equal (Ordered quantity * (Item net price/item price base quantity) + Order line charge amount - Order line allowance amount. PEPPOL-T01-R028 Elements of data type amount cannot have more than 2 decimals (I.e. all amounts except unit price amounts). PEPPOL-T01-B22901 Attribute 'currencyID' MUST be present.
Page 29 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage Type xs:normalizedString Rules PEPPOL-T01-R003 - An order SHALL be stated in a single Use required currency. PEPPOL-T01-B22902 currencyID Example GBP Value MUST be part of code list 'Currency codes (ISO 4217)'.
cac:Price Occurence 1 .. 1 Rules PEPPOL-T01-B25201 - Element 'cbc:PriceAmount' MUST be Type cac:PriceType provided. PEPPOL-T01-B25202 - Document MUST NOT contain elements not part of the data model.
cbc:PriceAmount Occurrence 1 .. 1 Term name Item price Type Price Amount Rules PEPPOL-T01-R005 - Each order line item net price SHALL not be Info req.ID tir01-130 negative. PEPPOL-T01-R019 - Item net price SHALL equal (Gross Example 211.124 price - Allowance amount) when gross price is provided. PEPPOL- T01-B25301 - Attribute 'currencyID' MUST be present.
Type xs:normalizedString Rules PEPPOL-T01-R003 - An order SHALL be stated in a single Use required currency. PEPPOL-T01-B22902 currencyID Example GBP Value MUST be part of code list 'Currency codes (ISO 4217)'.
Page 30 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Item Occurence 1 .. 1 Rules PEPPOL-T01-B26301 - Element 'cbc:Name' MUST be provided. Type cac:ItemType PEPPOL-T01-B26302 - Document MUST NOT contain elements not part of the data model.
cbc:Description Occurrence 1 .. 1 Term name Item description as text Type Text Usage A detailed description of the item. Info req.ID tir01-133
cbc:Name Occurrence 1 .. 1 Term name Item name Type Text Usage Item Description Info req.ID tir01-135 Rules BII2-T01-R031 - Each order line MUST have an item identifier and/or an item name cac:BuyersItemIdentification Occurence 0 .. 1 Rules PEPPOL-T01-B26601 - Element 'cbc:ID' MUST be provided. Type cac:ItemIdentificationType PEPPOL-T01-B26602 - Document MUST NOT contain elements not part of the data model.
Occurrence 1 .. 1 Term name Buyers item identifier Type Identifier Usage The buyers identifier for the item. Associates the item with its cbc:ID Info req.ID tir01-p022 identification according to the Buyer’s system. Example NHS SC PRODUCT CODE
cac:SellersItemIdentification Occurence 0 .. 1 Rules PEPPOL-T01-B26801 - Element 'cbc:ID' MUST be provided. Type cac:ItemIdentificationType PEPPOL-T01-B26802 - Document MUST NOT contain elements not part of the data model.
Occurrence 1 .. 1 Term name Item sellers identifier Type Identifier Usage The sellers identifier for the item. Associates the item with its cbc:ID Info req.ID tir01-p020 identification according to the seller's system. Example 3249834
cac:StandardItemIdentification Occurence 0 .. 1 Rules PEPPOL-T01-B27001 - Element 'cbc:ID' MUST be provided. Type cac:ItemIdentificationType PEPPOL-T01-B27002 - Document MUST NOT contain elements not part of the data model. Occurrence 1 .. 1 Term name Item standard identifier Type Identifier Usage Items Global Traded Identification Number (GTIN) cbc:ID Info req.ID tir01-136 Rules PEPPOL-T01-B27101 -Attribute 'schemeID' MUST be present. Example 05704066204093
Type xs:normalizedString Rules PEPPOL-T01-B27102 - Value MUST be part of code list 'ISO 6523 Use optional ICD list'. schemeID Example 0160
Page 31 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:ClassifiedTaxCategory Occurence 0 .. 1 Rules PEPPOL-T01-B27901 - Element 'cbc:ID' MUST be provided. Type cac:TaxCategoryType PEPPOL-T01-B27902 - Element 'cac:TaxScheme' MUST be provided. PEPPOL-T01-B27903 - Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Item VAT category code Type Code Usage The VAT code that indicates what VAT details apply to the item. Info req.ID tir01-150 Rules PEPPOL-T01-B28001 -Value MUST be part of code list 'Duty or tax Example S or fee category code (UNCL5305)'.
cbc:Percent Occurrence 0 .. 1 Term name Item VAT rate Type Percentage Usage The VAT percentage rate that applies to the ordered item. Info req.ID tir01-170 Example 25 Rules PEPPOL-T01-R029 - Each Tax Category SHALL have a VAT category rate, except if the order is not subject to VAT. PEPPOL- cac:TaxScheme Occurence 1 .. 1 Rules T01PEPPOL-R030- T01- When-B28201 VAT -category Element code 'cbc:ID' is "Standard MUST be rated"provided. (S) the Type cac:TaxSchemeType VAT rate SHALL be greater than zero. PEPPOL-T01-B28202 - Document MUST NOT contain elements not part of the data model
cbc:ID Occurrence 1 .. 1 Term name Identifier Type Identifier Usage Code for TaxScheme. VAT is the only allowed value Info req.ID tir01-p021 Example VAT Rules PEPPOL-T01-B28301 - Element 'cbc:ID' MUST contain value 'VAT'.
Page 32 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
5.3 Example
Page 33 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 34 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 35 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 36 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 37 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 38 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 39 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
6 Order Responses The following table contains the elements required by NHS Supply Chain within the Order Response Document. 6.1 Requirements
Element/Attribute Description Usage
OrderResponse Type OrderResponseType cbc:CustomizationID Occurence 1 .. 1 Term name Customization identifier Type Identifier Usage Identifies the specification of content and rules that apply to the Info req.ID tir76-001 transaction. Example urn:fdc:peppol.eu:poacc:trns:order_response:3 Rules PEPPOL-T76-B00201 Element 'cbc:CustomizationID' MUST contain value 'urn:fdc:peppol.eu:poacc:trns:order_response:3'.
cbc:ProfileID Occurence 1 .. 1 Term name Profile identifier Type Identifier Usage Identifies the BII profile or business process context in which Info req.ID tir76-002 the transaction appears. Example urn:fdc:peppol.eu:poacc:bis:ordering:3 Rules PEPPOL-T76-B00301 Element 'cbc:ProfileID' MUST contain value 'urn:fdc:peppol.eu:poacc:bis:ordering:3'.
cbc:ID Occurence 1 .. 1 Term name Order response identifier Type Identifier Usage Suppliers Order Number Info req.ID tir76-003 Example or0987 cbc:IssueDate Occurence 1 .. 1 Term name Order response issue date Type Date Usage The date on which the transaction instance was issued. Info req.ID tir76-004 Example 2018-05-15 cbc:OrderResponseCode Occurence 1 .. 1 Term name Response code Type Code Usage A code that indicates whether the referenced order as whole is Info req.ID tir76-200 Accepted or Rejected or, alternatively, Accepted with change. If Example AP response code is Accept or Reject there may not be any response lines. RE=Not Accepted, AP=Accepted, CA=Accepted with amendment Rules PEPPOL-T76-B00801 - Value MUST be part of code list 'Order Response type code (UNCL4343 Subset)'.
cbc:Note Occurence 0 .. 1 Term name Response clarification Type Text Usage Clarification of the suppliers decision. Info req.ID tir76-006
Page 40 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cbc:DocumentCurrencyCode Occurence 1 .. 1 Term name Document currency Type cbc:DocumentCurrencyCodeType Usage The default currency for the offer. Info req.ID tir76-007 Rules PEPPOL-T76-B01001 Value MUST be part of code list 'Currency Example GBP codes (ISO 4217)'. cac:OrderReference Occurence 1 .. 1 Rules PEPPOL-T76-B01201 Element 'cbc:ID' MUST be provided. Type cac:OrderReferenceType PEPPOL-T76-B01202 Document MUST NOT contain elements not part of the data model. cbc:ID Occurence 1 .. 1 Term name Order document reference Type Document reference Usage Used to reference the order that is being responded to. Info req.ID tir76-011 Example o-23424 cac:SellerSupplierParty Occurence 1 .. 1 Rules PEPPOL-T76-B01401 Document MUST NOT contain elements Type cac:SupplierPartyType not part of the data model. cac:Party Occurence 0 .. 1 Rules PEPPOL-T76-B01501 Element 'cbc:EndpointID' MUST be Type cac:PartyType provided. PEPPOL-T76-B01502 Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurence 0 .. 1 Term name Seller party endpoint identifier Type Identifier Usage Suppliers GLN. Info req.ID tir76-058 Rules PEPPOL-T76-B01601 Attribute 'schemeID' MUST be present. Example 9999999999999
schemeID Type xs:normalizedString Rules PEPPOL-T76-B01602 Value MUST be part of code list 'Electronic Use required Address Scheme (EAS)'. Example 0088 cac:PartyLegalEntity Occurence 1 .. 1 Rules PEPPOL-T76-R002 An order response SHALL have the seller Type cac:PartyNameType party official name or a seller party identifier. PEPPOL-T76- B02101 Element 'cbc:RegistrationName' MUST be provided. PEPPOL-T76-B02102 Document MUST NOT contain elements not part of the data model. Occurrence 1 .. 1 Term name Seller party name Type Text Usage The name of the party. cbc:RegistrationName Info req.ID tir76-060
cac:BuyerCustomerParty Occurence 1 .. 1 Rules PEPPOL-T76-B02301 Element 'cac:Party' MUST be provided. Type cac:CustomerPartyType PEPPOL-T76-B02302 Document MUST NOT contain elements not part of the data model. cac:Party Occurence 1 .. 1 Rules PEPPOL-T76-B02401 Element 'cbc:EndpointID' MUST be provided. PEPPOL-T76-B02402 Document MUST NOT contain Type cac:PartyType elements not part of the data model.
cbc:EndpointID Occurrence 1 .. 1 Term name Buyer party endpoint identifier Type Identifier Usage NHS Supply Chain GLN Info req.ID tir76-021 Rules PEPPOL-T76-B02501 Attribute 'schemeID' MUST be present. Example 5026744000002 Type xs:normalizedString Rules PEPPOL-T76-B02502 Value MUST be part of code list 'Electronic Use required Address Scheme (EAS)'. schemeID Example 0088
Page 41 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cac:PartyLegalEntity Occurence 1 .. 1 Rules PEPPOL-T76-R001 An order response SHALL have the buyer Type cac:PartyNameType party official name or a buyer party identifier. PEPPOL-T76- B03001 Element 'cbc:RegistrationName' MUST be provided. cbc:RegistrationName Occurrence 1 .. 1 Term name BuyerPEPPOL party-T76 name-B02102 Document MUST NOT contain elements Type Text Usage Thenot part name of theof the data party model. who ordered the items and receives the Info req.ID tir76-023 response. cac:Delivery Occurence 0 .. 1 Rules PEPPOL-T76-B03201 Element 'cac:PromisedDeliveryPeriod'
Type cac:DeliveryType MUST be provided. PEPPOL-T76-B03202 Document MUST NOT contain elements not part of the data model.
cac:PromisedDeliveryPeriod Occurence 1 .. 1 Rules PEPPOL-T76-B03301 Document MUST NOT contain elements not Type cac:PeriodType part of the data model. cbc:StartDate Occurrence 1 .. 1 Term name Period start date Type Date Usage Agreed Delivery Date Info req.ID tir76-099 Example 2018-06-01 Rules PEPPOL-T76-R004 If both delivery period start date and delivery period end date are given then the end date SHALL be later or equal to the start date. cac:OrderLine Occurrence 0 .. unbounded Rules PEPPOL-T76-B03601 Element 'cac:LineItem' MUST be provided. Type cac:OrderLineType PEPPOL-T76-B03602 Element 'cac:OrderLineReference' MUST be provided. PEPPOL-T76-B03603 Document MUST NOT contain elements not part of the data model. cac:LineItem Occurence 1 .. 1 Rules PEPPOL-T76-B03701 Element 'cbc:ID' MUST be provided. Type cac:LineItemType PEPPOL-T76-B03702 Element 'cbc:LineStatusCode' MUST be provided. PEPPOL-T76-B03703 Element 'cac:Item' MUST be provided. PEPPOL-T76-B03704 Document MUST NOT contain elements not part of the data model. Occurrence 1 .. 1 Term name Document line identifier Type Identifier Usage Identifies the response line. cbc:ID Info req.ID tir76-120 Rules PEPPOL-T76-R003 - Each order response line SHALL have a Example 3 document line identifier that is unique within the order
cbc:LineStatusCode Occurrence 1 .. 1 Term name Response code Type udt:CodeType Usage A code that indicates whether the referenced order line as whole Info req.ID tir76-202 is Accepted or Rejected or, alternatively, Accepted with change. Example 3 7 = Not Accepted, 5=Accepted, 3=Changed Rules PEPPOL-T76-B04001 Value MUST be part of code list 'Action code (UNCL1229)'. cbc:Quantity Occurrence 0 .. 1 Term name Quantity Type Quantity Usage The quantity of items that will be delivered. Mandatory if Info req.ID tir76-132 cbc:LineStatusCode equals 5 Example 10 Rules PEPPOL-T76-B04101 Attribute 'unitCode' MUST be present. Type Code Rules PEPPOL-T76-B04102 Value MUST be part of code list Use required 'Recommandation 20, including Recommondation 21 codes - unitCode Example EA prefixed with X (UN/ECE)'.
Page 42 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Item Occurence 1 .. 1 Rules PEPPOL-T76-B05301 Element 'cbc:Name' MUST be provided. Type cac:ItemType PEPPOL-T76-B05302 Document MUST NOT contain elements not part of the data model.
cbc:Name Occurrence 1 .. 1 Term name Item name Type Text Usage NHS Supply Chain Product Code Info req.ID tir76-205 Example Copy paper, 500 sheets
cac:SellersItemIdentification Occurence 0 .. 1 Rules PEPPOL-T76-B05701 Element 'cbc:ID' MUST be provided. Type cac:ItemIdentificationType PEPPOL-T76-B05702 Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Item sellers identifier Type Identifier Usage The sellers product code for the item. Info req.ID tir76-206 Example 3249834 cac:StandardItemIdentification Occurence 0 .. 1 Rules PEPPOL-T76-B05901 Element 'cbc:ID' MUST be provided. Type cac:ItemIdentificationType PEPPOL-T76-B05902 Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Item standard identifier Type Identifier Usage Items Global Traded Identification Number (GTIN) Info req.ID tir76-207 Example 0504066204093 Rules PEPPOL-T76-B06001 Attribute 'schemeID' MUST be present.
schemeID Type xs:normalizedString Rules PEPPOL-T76-B06002 Value MUST be part of code list 'ISO 6523 Use required ICD list'. Example 0160 Occurence 1 .. 1 Rules PEPPOL-T76-B08801 Element 'cbc:LineID' MUST be provided. Type cac:OrderLineReferenceType PEPPOL-T76-B08802 Document MUST NOT contain elements cac:OrderLineReference not part of the data model. Occurrence 1 .. 1 Term name Order line reference Type cbc:LineIDType Usage Used to reference the initial order line that corresponds to the cbc:LineID Info req.ID tir76-201 response. All order lines should be stated. Example 1
Page 43 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
6.2 Example 6.2.1 Order Response – Accepted with Amendment
Page 44 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 45 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 46 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 47 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 48 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
6.2.2 Order Response – Accepted
Page 49 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 50 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
6.2.3 Order Response – Rejected
Page 51 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 52 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
7. Advanced Shipping Notes (ASN) Despatch Advices The following table contains the elements required by NHS Supply Chain within the ASN Despatch Advice Document. NHS Supply Chain have provided the following guidance around product identifiers and additional MDR requirements.
1. When returning an ASN both the NPC (NHS Supply Chain National Product Code) and the Suppliers own identifying product code (MPC) as registered with NHS Supply Chain should be provided. Where it is available or where a product is covered by the MDR Regulations a supplier must also return a compliant registered code, such as a GTIN. This code also needs to have been previously advised to NHS Supply Chain and confirmed as compliant to the MDR Regulations. 2. Where a product is covered by MDR regulations all relevant information should be provided according to that products type, this includes Batch Number and Expiry Date for MDR Type 1 products and Batch Number, Expiry Date and Serial Numbers for MDR Type 2 products. If a product is not covered by MDR but this information is available a supplier can still provide it. 3. For any product that has a Best Before Date this should always be provided regardless of whether that product is covered by the MDR Regulations.
Additionally, valid party identifiers for the BIS3 standard are as follows:
1. GLN (0088) – Replaces BIS2 “GLN” 2. Tax Code (as relevant e.g. 9932 United Kingdom VAT number) – Replaces BIS2 “VAT” 3. NHS Scheme (0080) - Replaces BIS2 “ZZZ” to identify Requisition Points
Page 53 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
7.1 Requirements
Element/Attribute Description Usage
DespatchAdvice Type DespatchAdviceType cbc:CustomizationID Occurence 1 .. 1 Term name Customization identifier Type Identifier Usage Identifies the specification of content and rules that apply Info req.ID tir16-002 to the transaction. Example urn:fdc:peppol.eu:poacc:trns:despatch_advice:3 Rules PEPPOL-T16-B00201- Element 'cbc:CustomizationID' MUST contain value 'urn:fdc:peppol.eu:poacc:trns:despatch_advice:3 cbc:ProfileID Occurence 1 .. 1 Term name Profile identifier Type Identifier Usage Identifies the BII profile or business process context in Info req.ID tir16-001 which the transaction appears. Example urn:fdc:peppol.eu:poacc:bis:despatch_advice:3 Rules PEPPOL-T16-B00301- Element 'cbc:ProfileID' MUST contain value 'urn:fdc:peppol.eu:poacc:bis:despatch_advice:3'.
cbc:ID Occurence 1 .. 1 Term name Document identifier Type Identifier Usage Delivery Note Number Info req.ID tir16-003
cbc:IssueDate Occurence 1 .. 1 Term name Despatch advice issue date Type Date Usage Delivery Note Date Info req.ID tir16-004 Example 2020-03-29
cac:OrderReference Occurrence 0 .. n Rules PEPPOL-T16-B00801 - Element 'cbc:ID' MUST be provided. Type cac:OrderReferenceType PEPPOL-T16-B00802 - Document MUST NOT contain elements not part of the data model. cbc:ID Occurence 1 .. 1 Term name Order reference Type Identifier Usage NHS Supply Chain Order Number Info req.ID tir16-006
cac:AdditionalDocumentReference Occurrence 0 .. 5 This AdditionalDocumentReference isn’t currently available in the PEPPOL Despatch Type cac:DocumentReferenceType Advice syntax,a request to include this has been made to OpenPEPPOL. This is not required by NHS Supply Chain but has been made available to store additional document references that can be used on the label prints. Alternatively, Suppliers can get this additional information from the original Order document. Having the information within the Despatch Advice will make reprinting labels (if required) easier. cbc:ID Occurrence 1 .. 1 Term name Document identifier Type cbc:IDType Usage Information to be printed on labels as defined by the DocumentType cbc:DocumentType OccurenceInfo req.ID 1tir01 ..- 1541 Term name Documentelement. description TypeBus req.ID cbc:DocumentTypeTypetbr01-006 Usage A short description of the document reference type. Example R31509 Valid Types Reqpt = Requisition Point Example Reqpt Reqpt Name = Requisition Point Name Reqptno = Requisition Point Number SortRef = Sorting Reference DoHCode = Department of Health Code
Page 54 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cac:DespatchSupplierParty Occurrence 1 .. 1 Term name Despatching party information Type cac:DespatchSupplierPartyType Usage The Despatch Party is the person or organization who provides (despatch) the goods or services. (Despatch Party is sometimes known as the Consignor)
Rules PEPPOL-T16-B01001 - Element 'cac:Party' MUST be provided. PEPPOL-T16-B01002 - Document MUST NOT contain elements not part of the data model. cac:Party Occurrence 1 .. 1 Term name Party information Type cac:PartyType Rules PEPPOL-T16-B01101- Element 'cbc:EndpointID' MUST be provided. PEPPOL-T16-B01102- Element 'cac:PartyLegalEntity' MUST be provided PEPPOL-T16-B01103 - Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurence 1 .. 1 Term name Electronic address identifier Type Identifier Usage Identifies the despatch party's electronic address Info req.ID tir16-071 Example 5012347894512 Rules PEPPOL-T16-B01201 - Attribute 'schemeID' MUST be present.
schemeID Type Identifier Term name Electronic address identifier Use required Usage Identifies the despatch party's electronic address
Example 0088 Rules PEPPOL-T16-B01202 – Value MUST be part of code list ‘Electronic Address Scheme (EAS)
cac:PartyLegalEntity Occurence 1 .. 1 Term name Party Name Type cbc:PartyLegalEntityType Usage The name of the dispatching party
Rules PEPPOL-T16-B02701 - Element 'cbc:RegistrationName' MUST be provided
PEPPOL-T16-B02702 - Document MUST NOT contain elements not part of the data model cbc:RegistrationName Occurence 1 .. 1 Term name Dispatching party name Type Text Usage The name of the dispatching party Info req.ID tir16-007
Example Example Supplier Name
Page 55 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Contact Occurence 0 .. 1 Term name Contact information Type cac:ContactType Rules PEPPOL-T16-B02901 - Document MUST NOT contain elements not part of the data model.
cbc:Name Occurrence 0..1 Term name Contact person name Type Text Usage The name of the contact person. Info req.ID tir16-008
cbc:Telephone Occurrence 0..1 Term name Contact telephone number Type Text Usage A phone number for the contact person. If the person has a direct Info req.ID tir16-012 number, this is that number.. cbc:ElectronicMail Occurrence 0..1 Term name Contact email address Type Text Usage The e-mail address for the contact person. If the person has a direct Info req.ID tir16-013 e-mail this is that email.
Page 56 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cac:DeliveryCustomerParty Occurrence 1 .. 1 Term name Consignee information Type cac:DeliveryCustomerPartyType Usage The Consignee is the person or organization to which the products will be shipped and who is taking possession
Rules PEPPOL-T16-B03301- Element 'cac:Party' MUST be provided. PEPPOL-T16-B03302- Document MUST NOT contain elements not part of the data model.
cac:Party Occurrence 1 .. 1 Term name Party information Type cac:PartyType Rules PEPPOL-T16-B03401- Element 'cbc:EndpointID' MUST be provided. PEPPOL-T16-B03402- Element 'cac:PartyLegalEntity' MUST be provided PEPPOL-T16-B03403- Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurence 1 .. 1 Term name Consignee party electronic address Type Identifier Usage Identifies the consignee party's electronic address Info req.ID tir16-016 Example 5032147894512 Rules PEPPOL-T16-B03501- Attribute 'schemeID' MUST be present.
@schemeID Type xs:normalizedString Term name Scheme identifier Use required Usage Scheme identifier for electronic address
Example 0088 Rules PEPPOL-T16-B03502-Value must be part of code list EAS cac:PartyIdentification Occurrence 0 .. 1 Term name Buying party identifier Type cbc:PartyIdentificationType Usage Consignee party identifier
Rules PEPPOL-T16-B03701- Element 'cbc:ID' MUST be provided. cbc:ID Occurence 1..1 Term name Consignee party identifier Type Identifier Usage The receiving party identifier. Info req.ID tir16-015 Example 916QA9915 @schemeID Type Identifier Term name Scheme identifier Use required Usage Scheme identifier for party identification
Example 0080 Rules PEPPOL-T16-B03801- Value MUST be part of code list 'ISO 6523 ICD list'.
Page 57 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cac:PostalAddress Occurrence 0 .. 1 Term name Postal address Type cbc:PostalAddressType Usage Postal address of the consignee Info req.ID tir16-016
Rules PEPPOL-T16-B04001-Element 'cac:Country' MUST be provided PEPPOL-T16-B04002-Document MUST NOT contain elements not part of the data model. cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type Text Usage The main address line in a postal address usually the street name and Info req.ID tir16-018 number cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type Text Usage An additional address line in a postal address that can be used to give Info req.ID tir16-019 further details supplementing the main line. Common use are secondary house number in a complex or in a building.
cbc:CityName Occurrence 0 .. 1 Term name City Type Text Usage The common name of the city where the postal address is. The name is Info req.ID tir16-020 written in full rather than as a code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type Text Usage For specifying a region, county, state, province etc. within a country by Info req.ID tir16-022 using text.. cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type Text Usage The identifier for an addressable group of properties according to the Info req.ID tir16-021 relevant national postal service, such as a ZIP code or Post Code
cac:Country Occurrence 1 .. 1 Term name Country Type cac:CountryType Rules PEPPOL-T16-B04801- Element 'cbc:IdentificationCode' MUST be provided' PEPPOL-T16-B04802- Document MUST NOT contain elements not part of the data model. cbc:IdentificationCode Occurence 1 .. 1 Term name Postal address Type Code Usage Postal address of the consignee Info req.ID tir16-023 Rules PEPPOL-T16-B04901- Value MUST be part of code list 'Country codes (ISO 3166-1:Alpha2)' cac:PartyLegalEntity Occurence 1 .. 1 Term name Buyer legal party Type cbc:PartyLegalEntityType Usage The name of the receiving party.
Rules PEPPOL-T16-B05001- Element 'cbc:RegistrationName' MUST be provided cbc:RegistrationName Occurrence 1 .. 1 Term name Consignee party name Type Text Usage PEPPOLThe-T16 name-B02702 of the - Documentreceiving party. MUST NOT contain elements not part of Usage The name of the dispatching party Info req.ID tir16-014 the data model Example Example Delivery Name
Page 58 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:BuyerCustomerParty Occurrence 1 .. 1 Term name Buyer Type cac:BuyerCustomerPartyType Usage The buyer is the legal person or organization who buys or purchases the goods or services. The role is carried out by the customer or on behalf of the customer.
Rules PEPPOL-T16-B05601- Element 'cac:Party' MUST be provided. PEPPOL-T16-B05602- Document MUST NOT contain elements not part of the data model.
cac:Party Occurrence 1 .. 1 Term name Party information Type cac:PartyType Usage The buyer is the legal person or organization who buys or purchases the goods or services. The role is carried out by the customer or on behalf of the customer.
Rules PEPPOL-T16-B05701- Document MUST NOT contain elements not part of the data model..
cac:PartyIdentification Occurrence 0 .. 1 Term name Buying party identifier Type cbc:EndpointIDType Usage The buying party identifier Info req.ID tir16-016
Rules PEPPOL-T16-B05801 - Element 'cbc:ID' MUST be provided.
cbc:ID Occurence 1..1 Term name Scheme identifier Type Identifier Usage Scheme identifier for party identification Info req.ID tir16-030 Example 5067847894512 Rules PEPPOL-T16-B05801 - Element 'cbc:ID' MUST be provided. @schemeID Type Identifier Term name Scheme identifier Use required Usage Scheme identifier for party identification
Example 0088 Rules PEPPOL-T16-B05901 - Value MUST be part of code list 'ISO 6523 ICD list'.
Page 59 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:SellerSupplierParty Occurrence 1 .. 1 Term name Seller Type cac:SellerSupplierPartyType Usage The seller is the legal person or organization who sells goods or services to the customer
Rules PEPPOL-T16-B07301- Element 'cac:Party' MUST be provided
PEPPOL-T16-B07302 - Document MUST NOT contain elements not part of the data model. cac:Party Occurrence 1 .. 1 Term name Party information Type cac:PartyType Rules PEPPOL-T16-B07401- Document MUST NOT contain elements not part of the data model.
cac:PartyIdentification Occurrence 1 .. 1 Term name Selling party identifier Type cac:PartyIdentificationType Usage An identifier for the seller party.
Rules PEPPOL-T16-B07501- Element 'cbc:ID' MUST be provided cbc:ID Type Identifier Term name Selling party identifier Use required Usage An identifier for the seller party. Info req.ID tir16-066 Example 5067847894512 Rules PEPPOL-T16-B07501- Element 'cbc:ID' MUST be provided @schemeID Type xs:normalizedString Term name Scheme identifier Use optional Usage Scheme identifier for party identification
Example 0088 Rules PEPPOL-T16-B07601- Value MUST be part of code list 'ISO 6523 ICD list'.
Page 60 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Shipment Occurrence 1 .. 1 Term name Shipment information Type cac:ShipmentType
Rules PEPPOL-T16-B10701-Element 'cbc:ID' MUST be provided.
PEPPOL-T16-B10702-Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Shipment identifier Type udt:IdentifierType Usage Identifies a shipment. Info req.ID tir16-038
XML Note If no unique identifier is assigned to the shipment, use “NA”.
cac:Delivery Occurrence 1 .. 1 Term name Delivery information Type cac:ShipmentType Rules PEPPOL-T16-B12501- Document MUST NOT contain elements not part of the data model..
cac: EstimatedDeliveryPeriod Occurrence 1 .. 1 Term name Estimated delivery period Type cac:EstimatedDeliveryPeriodType Usage The expected date when the shipment will arrive from the despatching party.
Rules PEPPOL-T16-B12701 - Document MUST NOT contain elements not part of the data model
cbc:StartDate Occurrence 0 .. 1 Term name Period start date Type udt:DateType Usage The start date of the period Info req.ID tir16-042 Example 2020-03-29 Rules Optional, send this information if available.
cbc:StartTime Occurrence 0 .. 1 Term name Period start time Type udt:TimeType Usage The start time of the period Info req.ID tir16-043 Example 12:00:00 Rules Optional, send this information if available.
cbc:EndDate Occurrence 1 .. 1 Term name Period end date Type udt:DateType Usage The end date of the period Info req.ID tir16-044 Example 2020-03-29 Rules NHS Supply Chain require Suppliers to send the expected date of the . delivery cbc:EndTime Occurrence 0..1 Term name Period end time Type udt:TimeType Usage The end time of the period Info req.ID tir16-045 Example 12:00:00 Rules Optional, send this information if available.
Page 61 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:DespatchLine Occurence 1 .. n Term name Despatch advice line Type cac:DespatchLineType Rules PEPPOL-T16-B14601 - Element 'cbc:ID' MUST be provided. PEPPOL-T16-B14602 - Element 'cac:OrderLineReference' MUST be provided. PEPPOL-T16-B14603 - Element 'cac:Item' MUST be provided PEPPOL-T16-B14604 - Document MUST NOT contain elements not part of the data model.
cbc: ID Occurence 1 .. 1 Term name Despatch line identifier Type udt:IdentifierType Usage A identifier for the individual line in the despatch advice. Info req.ID tir16-046 Rules Each despatch advice line MUST have a despatch line identifier that is unique within the despatch advice
cbc:DeliveredQuantity Occurence 1 .. 1 Term name Delivered quantity Type udt:QuantityType Usage The quantity that is despatched in the line. Info req.ID tir16-048 Rules PEPPOL-T16-R005 - Each despatch advice line SHOULD have a delivered quantity PEPPOL-T16-R006 - Each despatch advice line delivered quantity SHALL not be negative PEPPOL-T16-B14901- Attribute 'unitCode' MUST be present. @unitCode Type Code Term name Ordered quantity unit of measure Use required Usage The unit of measure that applies to the ordered quantity. Rules PEPPOL-T16-B14902 - Value MUST be part of code list 'Recommandation 20, including Recommondation 21 codes - prefixed with X (UN/ECE)'”
cac:OrderLineReference Occurrence 1 .. 1 Term name Despatch advice line Type cac:OrderLineReferenceType Rules PEPPOL-T16-B15401- Element 'cbc:LineID' MUST be provided. PEPPOL-T16-B15402 - Element 'cac:OrderReference' MUST be provided. PEPPOL-T16-B15403- Document MUST NOT contain elements not part of the data model. cbc:LineID Occurrence 1 .. 1 Term name Order line reference Type udt:IdentifierType Usage To uniquely identify the line of the order that is being despatched. Info req.ID tir16-051
cac:OrderReference Occurrence 1 .. 1 Term name Order reference Type cac:OrderReferenceType Usage Identifies the order that the reference order line belongs to. XMLInfo req.IDNote Iftir16 no -order051 line reference exists, use dummy value “NA” Rules PEPPOL-T16-B15601 - Element 'cbc:ID' MUST be provided. XML Note If no order line reference exists, use dummy value “NA” PEPPOL-T16-B15602 - Document MUST NOT contain elements not part of the data model. cbc:ID Occurrence 1 .. 1 Term name Item name Type udt:IdentifierType Usage Order identifier Rules PEPPOL-T16-R002 - A despatch advice SHOULD have an order identifier
Page 62 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:Item Occurrence 1 .. 1 Term name Item information Type cac:ItemType Rules PEPPOL-T16-B15801- Element 'cbc:Name' MUST be provided. PEPPOL-T16-B15802- Document MUST NOT contain elements not part of the data model.
cbc:Name Occurrence 1 .. 1 Term name Item name Type udt:NameType Usage A short name for an item. Info req.ID tir16-052 Rules PEPPOL-T16-R004 - Each Despatch Advice SHALL contain the item name
cac:BuyersItemIdentification Occurrence 0 .. 1 Term name Buyers item identification Type cac:BuyersItemIdentificationType Rules PEPPOL-T16-B16001 - Element 'cbc:ID' MUST be provided. PEPPOL-T16-B16002 - Document MUST NOT contain elements not part of the data model.
cbc:ID Occurence 1 .. 1 Term name Item buyers identifier Type Identifier Usage Buyers Product Code (NPC) Info req.ID tir16-p041 Rules Please see text at the beginning of section 8.
cac:SellersItemIdentification Occurrence 0 .. 1 Term name Sellers item identification Type cac:ItemIdentificationType Rules PEPPOL-T16-R003 - Each item in a Despatch Advice line SHALL be identifiable by either “item sellers identifier” or “item standard identifier” PEPPOL-T16-B16201 - Element 'cbc:ID' MUST be provided. PEPPOL-T16-B16202 - Document MUST NOT contain elements not part of the data model
cbc:ID Occurence 1 .. 1 Term name Item sellers identifier Type Identifier Usage Suppliers Product Code (MPC) Info req.ID tir16-053 Rules Please see text at the beginning of section 8.
Page 63 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:StandardItemIdentification Occurrence 0 .. 1 Term name Sellers item identification Type cac:ItemIdentificationType Rules PEPPOL-T16-R003 - Each item in a Despatch Advice line SHALL be identifiable by either “item sellers identifier” or “item standard identifier” PEPPOL-T16-B16501- Element 'cbc:ID' MUST be provided. PEPPOL-T16-B16502 - Document MUST NOT contain elements not part of the data model.
cbc:ID Occurence 1 .. 1 Term name Item standard identifier Type Identifier Usage Items Global Traded Identification Number (GTIN) or European Article Info req.ID tir16-055 Number (EAN) Rules PEPPOL-T16-B16601 - Attribute 'schemeID' MUST be present.
schemeID Type Identifier Term name Item standard identifier identification scheme identifier Use optional Usage The identification scheme identifier of the Item standard identifier Example GTIN Rules Please see text at the beginning of section 8. PEPPOL-T16-B16602 - Value MUST be part of code list 'ISO 6523 ICD cac:AdditionalItemProperty Occurrence 0 .. n Term name list'.Additional item property information Type cac:AdditionalItemPropertyType Usage A group of business terms providing information about properties of the goods and services invoiced. Rules PEPPOL-T16-B17201 - Element 'cbc:Name' MUST be provided. PEPPOL-T16-B17202 - Element 'cbc:Value' MUST be provided PEPPOL-T16-B17203 - Document MUST NOT contain elements not part of the data model
cbc: Name Occurence 1..1 Term name Item property name Type Text Usage The name of the property.The name must be sufficiently descriptive Info req.ID tir16-p039 to define the value. NHS Supply Chain accept Substitute Product Example Substitute “SUBSTITUTE” and/or Kit Product “KIT”
cbc:Value Occurence 1..1 Term name Item property value Type Text Usage The value of the item property. NHS Supply Chain accept “Y” or “N” Info req.ID tir16-p040 Example Y
Page 64 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cac:ItemInstance Occurence 0 .. n Term name Item instance information Type cac:ItemInstanceType Rules PEPPOL-T16-B18001- Document MUST NOT contain elements not part of the data model.
cbc:BestBeforeDate Occurence 0..1 Term name Item best before date Type udt:DateType Usage The best before date of all items listed in this dispatch line. Info req.ID tir16-080 Rules Please see text at the beginning of section 8. Example 2020-12-01 cbc:SerialID Occurence 0..1 Term name Item serial numbers Type udt:IdentifierType Usage Serial numbers for items listed in the dispatch line, please use a pipe Info req.ID tir16-083 “|” separator for multiple serial number Example 4558784|4558784 Rules Please see text at the beginning of section 8. cac:LotIdentification Occurence 0..1 Term name Lot identifictation Type cac:LotIdentificationType Rules PEPPOL-T16-B18401- Document MUST NOT contain elements not part of the data model
cbc:LotNumberID Occurence 0..1 Term name Item batch number Type udt:IdentifierType Usage The batch number that applies to all items in the dispatch line. Info req.ID tir16-082 Rules Please see text at the beginning of section 8. Example 546378239
cbc:ExpiryDate Occurence 0..1 Term name Item expiry date Type udt:DateType Usage The expiry date of all items listed in this dispatch line Info req.ID tir16-081 Example 2021-01-01 Rules Please see text at the beginning of section 8.
cac:Shipment Occurrence 1 .. 1 Term name Shipment information Type cac:ShipmentType Usage Provides Transport Handling Unit (THU) information including hierarchy in relation to the delivery. Rules PEPPOL-T16-B18701- Element 'cbc:ID' MUST be provided PEPPOL-T16-B18702- Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Shipment identifier Type udt:IdentifierType Usage Element is mandated by syntax structure use value NA Info req.ID tir16-038 Rules PEPPOL-T16-B18801- Element 'cbc:ID' MUST contain value 'NA'.
Page 65 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage
cac:TransportHandlingUnit Occurence 1 .. n Term name Transport handling unit information Type cac:TransportHandlingUnitType Rules PEPPOL-T16-B18901- Document MUST NOT contain elements not part of the data model
cbc: ID Occurrence 1 .. 1 Term name Handling unit identifier Type cbc:IDType Usage Identifies the transport handling unit Info req.ID tir16-061
cbc:TransportHandlingUnitTypeCode Occurence 1 .. 1 Term name Handling unit type Type udt:CodeType Usage The type of packaging that represent the handling unit, such as box, Info req.ID tir16-085 pallet, container etc Rules PEPPOL-T16-B19101- Value MUST be part of code list 'Recommandation 21 (UN/ECE)'.
NHS Supported Values are PALLET (PX), CARTON (CT) or CAGE cbc:ShippingMarks Occurence 1 .. 1 Term(CG). name Handling unit shipping marks Type udt:TextType Usage Free-form description of the marks and numbers on a transport unit or Info req.ID tir16-064 package.etc Rules PEPPOL-T16-B19101- Value MUST be part of code list 'Recommandation 21 (UN/ECE)'.
cac: Package Occurence 0 .. n Term name Transport handling unit information (2nd Level) Type cac:PackageType Rules PEPPOL-T16-B18901- Document MUST NOT contain elements not part of the data model
cbc:ID Occurence 0 .. 1 Term name Handling unit shipping marks (2nd Level) Type udt:TextType Usage Free-form description of the marks and numbers on a transport unit or Info req.ID tir16-064 package.etc Rules
cbc:PackagingTypeCode Occurence 0 .. n Term name Handling unit type Type udt:CodeType Usage The type of packaging that represent the handling unit, such as box, Info req.ID pallet, container etc Rules NHS Supported Values are PALLET (PX), CARTON (CT) or CAGE
Page 66 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
7.2 Example 7.2.1 Basic Hierarchy Below is an example of a delivery with only a single pallet.
Page 67 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 68 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 69 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 70 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 71 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
7.2.2 Complex Hierarchy Below is an example of a delivery with one carton on one pallet.
Page 72 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 73 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 74 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 75 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 76 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 77 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
8. Despatch Advices (Confirmation)
This legacy message has been replaced by the introduction of Advance Shipping Notes for ALL Order types not just eDirect Orders. The document specification is provided below for historical reference only. The following table contains the elements required by NHS Supply Chain within the Despatch Advice Document. Despatch Advices are only currently required for eDirect type orders. No new implementations of this message type are supported. 8.1 Requirements
Element/Attribute Description Usage
DespatchAdvice Type DespatchAdviceType cbc:CustomizationID Occurence 1 .. 1 Term name Customization identifier Type Identifier Usage Identifies the specification of content and rules that apply Info req.ID tir16-002 to the transaction. Example urn:fdc:peppol.eu:poacc:trns:despatch_advice:3 Rules PEPPOL-T16-B00201 Element 'cbc:CustomizationID' MUST contain value 'urn:fdc:peppol.eu:poacc:trns:despatch_advice:3'.
cbc:ProfileID Occurence 1 .. 1 Term name Profile identifier Type Identifier Usage Identifies the BII profile or business process context in Info req.ID tir16-001 which the transaction appears. Example urn:fdc:peppol.eu:poacc:bis:despatch_advice:3 Rules PEPPOL-T16-B00301 Element 'cbc:ProfileID' MUST contain value 'urn:fdc:peppol.eu:poacc:bis:despatch_advice:3'.
cbc:ID Occurence 1 .. 1 Term name Document identifier Type Identifier Usage Delivery Note Number Info req.ID tir16-003 Example 123
cbc:IssueDate Occurence 1 .. 1 Term name Despatch advice issue date Type Date Usage Delivery Note Date Info req.ID tir16-004 Example 2018-05-25
cac:OrderReference Occurrence 1 .. 1 Rules PEPPOL-T16-B00801 Element 'cbc:ID' MUST be provided. PEPPOL- Type cac:OrderReferenceType T16-B00802 Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Order reference Type Identifier Usage NHS Supply Chain Order Number Info req.ID tir16-006
Page 78 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:DespatchSupplierParty Occurrence 1 .. 1 Rules PEPPOL-T16-B01001 Element 'cac:Party' MUST be provided. Type cac:SupplierPartyType PEPPOL-T16-B01002 Document MUST NOT contain elements not part of the data model.
cac:Party Occurrence 1 .. 1 Rules PEPPOL-T16-B01101 Element 'cbc:EndpointID' MUST be provided. Type cac:PartyType PEPPOL-T16-B01102 Element 'cac:PartyLegalEntity' MUST be provided. PEPPOL-T16-B01103 Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurrence 1 .. 1 Term name Electronic address identifier Type Identifier Usage A despatch advice may contain the despatching party electronic Info req.ID tir16-071 address identifier. The address can be of any format and the format Example 9999999999999 should be identified in the message. Rules PEPPOL-T16-B01201 Attribute 'schemeID' MUST be present.
schemeID Type xs:normalizedString Rules PEPPOL-T16-B01202 Value MUST be part of code list 'Electronic Use required Address Scheme (EAS)'. Example 0088
cac:PartyLegalEntity Occurrence 1 .. 1 Rules PEPPOL-T16-B02701 Element 'cbc:RegistrationName' MUST be provided. PEPPOL-T16-B02702 Document MUST
cbc:RegistrationName Occurrence 1 .. 1 Type Text Info req.ID tir16-007
cac:DeliveryCustomerParty Occurrence 1 .. 1 Rules PEPPOL-T16-B03301 Element 'cac:Party' MUST be provided. Type cac:CustomerPartyType PEPPOL-T16-B03302 Document MUST NOT contain elements not part of the data model.
cac:Party Occurrence 1 .. 1 Rules PEPPOL-T16-B03401 Element 'cbc:EndpointID' MUST be provided. Type cac:PartyType PEPPOL-T16-B03402 Element 'cac:PartyLegalEntity' MUST be provided. PEPPOL-T16-B03403 Document MUST NOT contain elements not part of the data model.
cbc:EndpointID Occurrence 1 .. 1 Term name Consignee party identifier Type Identifier Usage A despatch advice may contain the despatching party electronic Info req.ID tir16-016 address identifier. The address can be of any format and the format Example 5026744000002 should be identified in the message. Rules PEPPOL-T16-B03501 Attribute 'schemeID' MUST be present.
Page 79 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage Type xs:normalizedString Rules PEPPOL-T16-B01202 Value MUST be part of code list 'Electronic Use required Address Scheme (EAS)'. Example 0088
schemeID
Occurrence 1 .. 1 Rules PEPPOL-T16-B02701 Element 'cbc:RegistrationName' MUST be provided. PEPPOL-T16-B02702 Document MUST cac:PartyLegalEntity
Occurrence 1 .. 1 Type Text cbc:RegistrationName Info req.ID tir16-014
Page 80 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists cac:Shipment Occurrence 1 .. 1 Rules PEPPOL-T16-B10701 Element 'cbc:ID' MUST be provided. Type cac:ShipmentType PEPPOL-T16-B10702 Document MUST NOT contain elements not
part of the data model.
Occurrence 1 .. 1 Term name Shipment identifier Type cbc:IdentifierType Usage Identifies a shipment. cbc:ID Info req.ID tir16-038
cac:Delivery Occurrence 1 .. 1 Rules PEPPOL-T16-B12501 Document MUST NOT contain elements not part of the data model.
cac:Despatch Occurrence 1 .. 1 Rules PEPPOL-T16-B13201 Document MUST NOT contain elements not part of the data model.
OccurrenceType 1cac:DespatchType .. 1 Term name Shipment dispatch date Type cbc:ActualDespatchDateType BII Usage The actual or expected date when the shipment was despatched from cbc:ActualDespatchDate Info req.ID tir16-072 the despatching party.
cac:DespatchLine Occurrence 1 .. unbounded Rules PEPPOL-T16-B14601 Element 'cbc:ID' MUST be provided. PEPPOL- Type cac:DespatchLineType T16-B14602 Element 'cac:OrderLineReference' MUST be provided. PEPPOL-T16-B14603 Element 'cac:Item' MUST be provided. PEPPOL- T16-B14604 Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Despatch line identifier Type cbc:IdentifierType Usage A identifier for the individual line in the despatch advice. Info req.ID tir16-046
cbc:DeliveredQuantity Occurrence 1 .. 1 Term name Delivered quantity Type cbc:QuantityType Usage The quantity that is despatched in the line. Info req.ID tir16-048 Rules PEPPOL-T16-R005 Each despatch advice line SHOULD have a delivered quantity. PEPPOL-T16-R006 Each despatch advice line delivered quantity SHALL not be negative. PEPPOL-T16-B14901
Attribute 'unitCode' MUST be present.
unitCode Type xs:normalizedString Rules PEPPOL-T16-B14902 Value MUST be part of code list Use optional 'Recommandation 20, including Recommondation 21 codes - prefixed Example PK with X (UN/ECE)'.
cac:OrderLineReference Occurrence 1 .. 1 Rules PEPPOL-T16-B15401 Element 'cbc:LineID' MUST be provided. Type cac:OrderLineReferenceType PEPPOL-T16-B15402 Element 'cac:OrderReference' MUST be provided. PEPPOL-T16-B15403 Document MUST NOT contain elements not part of the data model.
Page 81 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage cbc:LineID Occurrence 1 .. 1 Term name Order line reference Type cbc:LineIDType Usage To uniquely identify the line of the order that is being despatched. Info req.ID tir16-051
Occurrence 1 .. 1 Rules –
cac:OrderReference XML Note If no order line reference exists, use dummy value “NA” Occurrence 1 .. 1 Rules PEPPOL-T16-R002 A despatch advice SHOULD have an order Type cbc:IdentifierType identifier cbc:ID Info req.ID tir16-p010
Page 82 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:Item Occurrence 1 .. 1 Rules PEPPOL-T16-B15801 Element 'cbc:Name' MUST be provided. Type cac:ItemType PEPPOL-T16-B15802Document MUST NOT contain elements not part of the data model.
cbc:Name Occurrence 1 .. 1 Term name Item name Type cbc:NameType Usage NHS Supply Chain Product Code Info req.ID tir16-052 Rules PEPPOL-T16-R004 Each Despatch Advice SHALL contain the item name
cac:SellersItemIdentification Occurrence 0 .. 1 Rules PEPPOL-T16-R003 Each item in a Despatch Advice line SHALL be Type cac:ItemIdentificationType identifiable by either “item sellers identifier” or “item standard identifier” PEPPOL-T16-B16201 Element 'cbc:ID' MUST be provided. PEPPOL- T16-B16202 Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Item sellers identifier Type Identifier Usage Suppliers Product Code Info req.ID tir16-053 Example 3249834
cac:StandardItemIdentification Occurrence 0 .. 1 Rules PEPPOL-T16-R003 Each item in a Despatch Advice line SHALL be Type cac:ItemIdentificationType identifiable by either “item sellers identifier” or “item standard identifier”. PEPPOL-T16-B16501 Element 'cbc:ID' MUST be provided. PEPPOL- T16-B16502 Document MUST NOT contain elements not part of the data model.
cbc:ID Occurrence 1 .. 1 Term name Item standard identifier Type cbc:IDType Usage Items Global Traded Identification Number (GTIN) Info req.ID tir16-055 Rules PEPPOL-T16-B16601 Attribute 'schemeID' MUST be present. Example 05704066204093
schemeID Type xs:normalizedString Rules PEPPOL-T16-B16602 Value MUST be part of code list 'ISO 6523 ICD Use optional list'. Example 0160
Page 83 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
8.2 Example
Page 84 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 85 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 86 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 87 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
9. Invoices The following table contains the elements required by NHS Supply Chain within the Invoice Document. 9.1 Requirements
Element/Attribute Description Usage/Rules/Code lists
Invoice Type InvoiceType cbc:CustomizationID Occurrence 1 .. 1 Term name Customization identifier Type Identifier Usage Identifies the specification of content and rules that apply Info req.ID BT-24 to the transaction. Example Identifying the customization/implementation guide/ urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc contextualization of the syntax message and its :billing:3.0 extension that applies to the invoice transaction, enables the receiver to apply the correct validation to the received document as well as to route the document to an appropriate service for processing.
Rules PEPPOL-EN16931-R004 - Specification identifier MUST have the value urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0'. BR-01 -[BR-01]-An Invoice shall have a Specification identifier (BT-24).
cbc:ProfileID Occurrence 1 .. 1 Term name Profile identifier Type Text Usage Identifies the BII profile or business process context in Info req.ID BT-23 which the transaction appears. Example urn:fdc:peppol.eu:2017:poacc:billing:01:1.0 Identifying the profile or business process context in which the transaction appears enables the buyer to direct the message to an appropriate service as well as controlling its relation to other documents exchanged as part of the same process.
Rules PEPPOL-EN16931-R001 - Business process MUST be provided.
cbc:ID Occurrence 1 .. 1 Term name Document identifier Type Identifier Usage Supplier Invoice Number Info req.ID BT-1 Example 33445566 Rules BR-02 - [BR-02]-An Invoice shall have an Invoice number (BT-1).
cbc:IssueDate Occurrence 1 .. 1 Term name Document issuing date Type Date Usage Invoice Date Info req.ID BT-2 Rules BR-03 - [BR-03]-An Invoice shall have an Invoice issue date (BT-2). PEPPOL- Example 2017-11-01 EN16931-F001 -A date MUST be formatted YYYY-MM-DD.
Page 88 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:InvoiceTypeCode Occurrence 1 .. 1 Term name Invoice type code Type Code Usage A code that identifies the functional type of the invoice Info req.ID BT-3 instance, such as commercial invoice, pro-forma invoice, Example 380 final invoice. A code that identifies that the invoice is a commercial invoice. Rules BR-04 - [BR-04]-An Invoice shall have an Invoice type code (BT-3). PEPPOL- EN16931-P0100 - Invoice type code MUST be set according to the profile.
cbc:TaxPointDate Occurrence 0 .. 1 Term name Document issuing date Type Date BII Usage The date applicable VAT Info req.ID BT-7 Rules BR-CO-03 - [BR-CO-03]-Value added tax point date (BT-7) and Value added Example 2017-11-01 tax point date code (BT-8) are mutually exclusive.
cbc:TaxPointDatecbc:DocumentCurrencyCode OccurrenceOccurrence 1 .. 1 0 .. 1 Term name Term Invoice name currency Document code issuing date Type Code Usage The currency in which the monetary amounts are stated Info req.IDType BT -5 cbc:TaxPointDateType BII must Usage be stated inThe the date invoice. applicable VAT Example GBP Info req.ID tir10-006 Rules BR -05 - [BR-05]-An Invoice shall have an Invoice currency code (BT-5). BR-CL-04 [BR-CL-04]-Invoice currency code MUST be coded using ISO code list 4217 alpha-3 Bus req.ID tbr10-024 cac:InvoicePeriod Occurrence 0 .. 1 Term name Invoice period Type cac:PeriodType Rules BR-IC-11 - [BR-IC-11]-In an Invoice with a VAT breakdown (BG-23) where the VAT Info req.ID BG-14 category code (BT-118) is "Intra-community supply" the Actual delivery date (BT-72) or the Invoicing period (BG-14) shall not be blank.
Occurrence 0 .. 1 Term name Period start date cbc:StartDate Type Date Usage The date on which the period starts. The start dates Info req.ID BT-73 counts as part of the period. Example 2017-10-01 For invoices that charge for services or items delivered over a time period is necessary to be able to state the start date of the period for which the invoice relates such as for metered services and subscriptions.
Rules BR-CO-19 - [BR-CO-19]-If Invoicing period (BG-14) is used, the Invoicing period start date (BT-73) or the Invoicing period end date (BT-74) shall be filled, or both. PEPPOL- EN16931-F001 -A date MUST be formatted YYYY-MM-DD.
Page 89 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:EndDate Occurrence 0 .. 1 Term name Period end date Type Date Usage The date on which the period ends. The end date counts Info req.ID BT-74 as part of the period. Example 2017-10-31 It must be possible to state the end date of the period for which the invoice relates such as for metered services and subscriptions.
Rules PEPPOL-EN16931-F001 - A date MUST be formatted YYYY-MM-DD. BR-29 [BR-29]-If both Invoicing period start date (BT-73) and Invoicing period end date (BT-74) are given then the Invoicing period end date (BT-74) shall be later or equal to the Invoicing period start date (BT-73). BR-CO-19 [BR-CO-19]-If Invoicing period (BG- 14) is used, the Invoicing period start date (BT-73) or the Invoicing period end date (BT-74) shall be filled, or both.
Page 90 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:OrderReference Occurrence 1 .. 1 Type cac:OrderReferenceType Occurrence 1 .. 1 Term name Order reference identifier cbc:ID Type Document reference Usage NHS Supply Chain Order Number Info req.ID BT - 13 Rules PEPPOL-EN16931-R003 - A buyer reference or purchase order reference MUST be Example 98776 provided.
cac:AdditionalDocumentReference Occurrence 0 .. 1 Type cac:DocumentReferenceType Info req.ID BT - 24
cbc:ID Occurrence 1 .. 1 Term name Document identifier Type cbc:IDType Usage An identifier for the referenced document. Info req.ID BT-18, BT-122 Proof of Delivery Number Example AB23456 Rules BR-52 -[BR-52]-Each Additional supporting document (BG-24) shall contain a Supporting document reference (BT-122).
@schemeID Occurrence 1 .. 1 Term name Scheme Identifier Type Code Info req.ID BR-CL-07 Usage The identification scheme identifier of the Invoiced object identifier. Used for Proof of Example ASI Delivery reference (ASI)
cac:AccountingSupplierParty Occurrence 1 .. 1 Term name Identifies the Supplier Type cac:SupplierPartyType Info req.ID BG-4
cac:Party Occurrence 1 .. 1 Type cac:PartyType cbc:EndpointID Occurrence 1 .. 1 Term name Seller electronic address Type Identifier Usage An invoice may contain the sellers electronic address. Info req.ID BT-34 The address can be of any format and the format should Example 9999999999999 be identified in the message.
Rules BR-62 - [BR-62]-The Seller electronic address (BT-34) shall have a Scheme identifier.
schemeID Type xs:normalizedString Use required Example 0088 cac:PartyName Occurrence 1 .. 1 Type cac:PartyNameType cbc:Name Occurrence 1 .. 1 Term name Seller name Type Text Usage An invoice must contain the name of the seller. Info req.ID BT-28 Example Seller Business Name AS
Page 91 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:PostalAddress Occurrence 1 .. 1 Type cac:AddressType cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type cbc:StreetNameType Usage The main address line in a postal address usually the Info req.ID BT-35 street name and number. Example Main street 1 An invoice must contain the seller’s street name and number or P.O.box.
Rules IT-R-002 - [IT-R-002] BT-35 (Seller address line 1) - Italian suppliers MUST provide the postal address line 1 - I fornitori italiani devono indicare l'indirizzo postale.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type Text Usage An additional address line in a postal address that can Info req.ID BT-36 be used to give further details supplementing the main Example Po Box 351 line. Common use are secondary house number in a complex or in a building. An invoice may contain an additional address line for seller address.
cbc:CityName Occurrence 0 .. 1 Term name City Type Text Usage The common name of the city where the postal address Info req.ID BT-37 is. The name is written in full rather than as a code. Example London An invoice must contain the seller’s city. Rules IT-R-003 - [IT-R-003] BT-37 (Seller city) - Italian suppliers MUST provide the postal address city - I fornitori italiani devono indicare la città di residenza.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type Text Usage The identifier for an addressable group of properties Info req.ID BT-38 according to the relevant national postal service, such as Bus req.ID W1G 8LZ a ZIP code or Post Code. An invoice may contain the seller’s post code. Rules IT-R-004 "> [IT-R-004] BT-38 (Seller post code) - Italian suppliers MUST provide the postal address post code - I fornitori italiani devono indicare il CAP di residenza.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type Text Usage For specifying a region, county, state, province etc. Info req.ID BT-39 within a country by using text. Example In some countries regions or other type of country sub divisions are commonly used. An invoice may contain that information.
cac:Country Occurrence 1 .. 1 Type cac:CountryType
Page 92 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Occurrence 1 .. 1 Term name Country code Type cbc:IdentificationCodeType Usage The country where the address is. The country should cbc:IdentificationCode Info req.ID BT-40 always be given by using ISO code 3166 alpha 2 Example GB The seller’s address country must be contained in an invoice in the form of a two letter code (ISO 3166-1 alpha-2). Rules BR-09 [BR-09]-The Seller postal address (BG-5) shall contain a Seller country code (BT 40). BR-CL-14[BR-CL-14]-Country codes in an invoice MUST be coded using ISO code list 3166-1
cac:PartyTaxScheme Occurrence 0 .. 1 Type cac:PartyTaxSchemeType cbc:CompanyID Occurrence 0 .. 1 Term name Seller VAT identifier Type Identifier Usage When the invoice is a VAT invoice it must state the Info req.ID BT-31, BT-32 sellers VAT registration number and tax scheme. Example 999888777 Rules There are several rules that apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-AccountingSupplierParty/cac-Party/cac-PartyTaxScheme/cbc-CompanyID/
cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType cbc:ID Occurrence 1 .. 1 Term name Tax Scheme ID Type cbc:IDType Example VAT
cac:PartyLegalEntity Occurrence 0 .. 1 Type cac:PartyLegalEntityType cbc:RegistrationName Occurrence 0 .. 1 Term name Seller legal registration name Type Text Usage The name under which the seller is legally registered. Info req.ID BT-27 Example Full Formal Seller Name LTD Rules BR-06 - [BR-06]-An Invoice shall contain the Seller name (BT-27).
cbc:CompanyID Occurrence 0 .. 1 Term name Seller legal registration identifier Type Identifier Usage An invoice may contain the identifier assigned to the Info req.ID BT-30 party by the national company registrar. Example 9999999999999 Rules BR-CO-26 - [BR-CO-26]-In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present. DK-R-002 Danish suppliers MUST provide legal entity (CVR-number). DK-R-014 - For Danish Suppliers it is mandatory to specify schemeID as "0184" (DK CVR-number) when PartyLegalEntity/CompanyID is used for AccountingSupplierParty. SE-R-003 Swedish organisation numbers should be numeric. SE-R-004 - Swedish organisation numbers consist of 10 characters.
Page 93 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Type xs:normalizedString
schemeID Use 0088
cac:AccountingCustomerParty Occurrence 1 .. 1 Term name Identifies the Customer - NHS Supply Chain Type cac:CustomerPartyType Info req.ID BG-7
cac:Party Occurrence 1 .. 1 Type cac:PartyType Occurrence 1 .. 1 Term name Buyers electronic address cbc:EndpointID Type Identifier Usage An invoice may contain the buyers’ electronic address. Info req.ID BT-49 The address can be of any format and the format should Example 5026744000002 be identified in the message. Rules BR-63 -[BR-63]-The Buyer electronic address (BT-49) shall have a Scheme identifier. schemeID Type xs:normalizedString Use required Example 0088 cac:PartyName Occurrence 1 .. 1 Type cac:PartyNameType
cbc:Name Occurrence 1 .. 1 Term name Buyer trading name Type Text Usage A name by which the Buyer is known, other than Buyer name (also known as Business Info req.ID BT-45 name).. Example Buyer Trading Name cac:PostalAddress Occurrence 1 .. 1 Rules BR-10 - [BR-10]-An Invoice shall contain the Buyer postal address (BG-8). Type cac:AddressType Info req.ID BG- 8
cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type Text Usage The main address line in a postal address usually the Info req.ID BT-50 street name and number. Example Accounts Payable An invoice must contain the buyer’s street name and number or P.O. box.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type Text Usage An additional address line in a postal address that can Info req.ID BT-51 be used to give further details supplementing the main Bus req.ID line. Common use are secondary house number in a complex or in a building. An invoice may give an additional address line for buyer’s address.
cbc:CityName Occurrence 0 .. 1 Term name City Type Text Usage The common name of the city where the postal address Info req.ID BT -52 is. The name is written in full rather than as a code. Example Wymondham An invoice must contain the buyer’s city.
Page 94 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type Text Usage The identifier for an addressable group of properties Info req.ID BT-53 according to the relevant national postal service, such as Example NR18 8DL a ZIP code or Post Code. An invoice may contain the buyer’s post code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type Text Usage For specifying a region, county, state, province etc. Info req.ID BT-54 within a country by using text. Example In some countries regions or other type of country sub divisions are commonly used. An invoice may contain that information.
cac:Country Occurrence 1 .. 1 Type cac:CountryType Occurrence 1 .. 1 Term name Country code Type cbc:IdentificationCodeType Usage The country where the address is. The country should cbc:IdentificationCode Info req.ID BT-55 always be given by using ISO code 3166 alpha 2 Example GB The buyer’s address country must be given in an invoice in the form of a two letter code (ISO 3166-1 alpha-2). Rules BR-11 [BR-11]-The Buyer postal address shall contain a Buyer country code (BT-55). BR-CL-14 - [BR-CL-14]-Country codes in an invoice MUST be coded using ISO code list 3166-1
cac:PartyTaxScheme Occurrence 0 .. 1 Type cac:PartyTaxSchemeType Occurrence 0 .. 1 Term name Buyer VAT identifier cbc:CompanyID Type Identifier Usage An invoice may contain the buyers VAT identifier In order Info req.ID BT-48 to facilitate reverse charge and intra community supply Example 999999999 invoicing.
Rules There are several rules that apply https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-AccountingCustomerParty/cac-Party/cac-PartyTaxScheme/cbc-CompanyID/
cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType Occurrence 1 .. 1 Term name Tax Scheme ID cbc:ID Type Identifier Example 9932
cac:PartyLegalEntity Occurrence 0 .. 1 Type cac:PartyLegalEntityType
Page 95 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Occurrence 1 .. 1 Rules BR-07 - [BR-07]-An Invoice shall contain the Buyer name (BT-44). cbc:RegistrationName Type Text Info req.ID BT-44 Example NHS Supply Chain
cbc:CompanyID Occurrence 0 .. 1 Term name Buyer legal registration identifier Type Identifier Usage An invoice may contain the identifier assigned to the Info req.ID BT-47 Party by the national company registrar. Example 5026744000002 Rules There are several rules that apply https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-AccountingCustomerParty/cac-Party/cac-PartyLegalEntity/cbc-CompanyID/ schemeID Type xs:normalizedString Use required Example 0088 Occurrence 0 .. 1 cac:Delivery Type cac:DeliveryType Info req.ID BG-13
cbc:ActualDeliveryDate Occurrence 0 .. 1 Term name Delivery date Type Date BII Usage An invoice may contain the actual delivery date on which goods or consignments are Info req.ID BT-72 delivered from the seller. Also applicable for service completion date. Example 2017-12-01 Rules BR-IC-11 - [BR-IC-11]-In an Invoice with a VAT breakdown (BG-23) where the VAT category code (BT-118) is "Intra-community supply" the Actual delivery date (BT-72) or the Invoicing period (BG-14) shall not be blank. PEPPOL-EN16931-F001 -A date MUST be formatted YYYY-MM-DD.
cac:DeliveryLocation Occurrence 1 .. 1 Type cac:LocationType Occurrence 1 .. 1 Term name Delivered to location identifier cbc:ID Type Identifier Usage An identifier for the location to where the ordered items where be delivered. For Stock Info req.ID BT-71 and Blue Diamond type orders this will be the GLN of the depot to deliver to. For eDirect Example 5019100000044 type orders this will be the Delivery Point code allocated by NHS Supply Chain
Type xs:normalizedString Usage 0088 = Delivery GLN (Stock and Blue Diamond order types) schemeID Use required 0080 = eDirect Delivery Point Code Example 0088
cac:Address Occurrence 0 .. 1 Type cac:AddressType Info req.ID BG-15
Page 96 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type Text Usage The main address line in a postal address usually the Info req.ID BT-75 street name and number. Info req.ID Regional Distribution Centre An invoice may contain the address to which the items where delivered.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type Text Usage An additional address line in a postal address that can Info req.ID BT-76 be used to give further details supplementing the main Example St Barnabas Close Allington line. Common use are secondary house number in a complex or in a building. An invoice may contain an additional address line in the delivered to address.
cbc:CityName Occurrence 0 .. 1 Term name City Type Text Usage The common name of the city where the postal address Info req.ID BT-77 is. The name is written in full rather than as a code. Example Maidstone An invoice may contain the name of the city to which the items where delivered.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type cbc:PostalZoneType Usage The identifier for an addressable group of properties Info req.ID BT-78 according to the relevant national postal service, such as Example ME16 0LW a ZIP code or Post Code. An invoice may contain the post code to which the items where delivered.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type cbc:CountrySubentityType Usage For specifying a region, county, state, province etc. Info req.ID BT-79 within a country by using text. Example In some countries regions or other type of country sub divisions are commonly used. An invoice may contain the country sub division to which the items where delivered.
cac:Country Occurrence 0 .. 1 Type cac:CountryType
Page 97 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Occurrence 1 .. 1 Term name Country code Type Code Usage The country where the address is. The country should Info req.ID BT-80 always be given by using ISO code 3166 alpha 2 Example GB Since delivery country may affect VAT issues an invoice cbc:IdentificationCode may contain the country to which the items were delivered. Rules BR-57 - [BR-57]-Each Deliver to address (BG-15) shall contain a Deliver to country code (BT-80). BR-CL-14 - [BR-CL-14]-Country codes in an invoice MUST be coded using ISO code list 3166-1. BR-IC-12 [BR-IC-12]-In an Invoice with a VAT breakdown (BG-23) where the VAT category code (BT-118) is "Intra-community supply" the Deliver to country code (BT-80) shall not be blank.
cac:PaymentMeans Occurrence 0 .. unbounded Type cac:PaymentMeansType Info req.ID BG-16
Occurrence 1 .. 1 Term name Payment means type cbc:PaymentMeansCode Type Code Usage An invoice may contain an indication about how the Info req.ID BT-81 payment should be handled. Example 30 Rules BR-49 - [BR-49]-A Payment instruction (BG-16) shall specify the Payment means type code (BT-81). BR-CL-16 - [BR-CL-16]- Payment means in an invoice MUST be coded using UNCL4461 code list
cac:AllowanceCharge Occurrence 0 .. unbounded Term name Used to specify Carriage and Delivery Charges Type cac:AllowanceChargeType Note Delivery charges are only supported were specific agreement has been made with Info req.ID BG-20, BG-21 NHS Supply Chain or a delivery charge is included on an Order. Otherwise, delivery charges issued on invoices to NHS Supply Chain will be ignored.
cbc:ChargeIndicator Occurrence 1 .. 1 Term name Allowance and charges indicator Type cbc:ChargeIndicatorType BII Usage Indicates whether the Allowance Charge is a Charge (True) and should be added or Example False an Allowance (False) and should be subtracted.
cbc:AllowanceChargeReasonCode Occurrence 0 .. 1 Term name Allowance and charges reason code Type Code BII Usage A coded specification of what the allowance or charge is. An invoice may contain a Info req.ID BT-98, BT-105 coded description of what is being added or deducted. E.g. „volume discount" or Example 95 "packing charges", for each allowance or charge.
Rules There are several rules that apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-AllowanceCharge/cbc-AllowanceChargeReasonCode/
Page 98 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:AllowanceChargeReason Occurrence 1 .. 1 Term name Allowance and charges reason Type Text BII Usage A textual reason for the allowance or the charge. Can also be its name. One textual Info req.ID BT-97, BT-104 description of what is being added or deducted. E.g. “volume discount" or "packing Example Discount charges" must be stated for each allowance and charge on document level in an invoice. Rules There are several rules that apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-AllowanceCharge/cbc-AllowanceChargeReason/
cbc:Amount Occurrence 1 .. 1 Term name Allowance and charge amount Type cbc:AmountType BII Usage The net amount of the allowance or the charge. For each allowance or charge an Info req.ID BT-92, BT-99 invoice must contain the amount. Allowances are subtracted from the total invoice Example 200 amount and charges are added to the amount. The amount is “net” without VAT. Rules There are several rules that apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-AllowanceCharge/cbc-Amount/
currencyID Type xs:normalizedString Rules PEPPOL-EN16931-CL007 - Currency code must be according to ISO 4217:2005. Use required PEPPOL-EN16931-R051 - All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111). cac:TaxCategory Occurrence 1 .. 1
Occurrence 1 .. 1 Rules BR-32 [BR-32]-Each Document level allowance (BG-20) shall have a Document level Type Code allowance VAT category code (BT-95). BR-37[BR-37]-Each Document level charge cbc:ID Info req.ID BT-95, BT-102 (BG-21) shall have a Document level charge VAT category code (BT-102). BR-O-13 Example S [BR-O-13]-An Invoice that contains a VAT breakdown group (BG-23) with a VAT category code (BT-118) "Not subject to VAT" shall not contain Document level allowances (BG-20) where Document level allowance VAT category code (BT-95) is not "Not subject to VAT". BR-O-14 [BR-O-14]-An Invoice that contains a VAT breakdown group (BG-23) with a VAT category code (BT-118) "Not subject to VAT" shall not contain Document level charges (BG-21) where Document level charge VAT category code (BT-102) is not "Not subject to VAT".
cac:TaxScheme Occurrence 1 .. 1
Occurrence 1 .. 1 Example VAT cbc:ID
Page 99 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:TaxTotal Occurrence 1 .. 1 Rules PEPPOL-EN16931-R054 - Only one tax total without tax subtotals MUST be provided Type cac:TaxTotalType when tax currency code is provided. Occurrence 1 .. 1 Term name VAT total amount cbc:TaxAmount Type cbc:TaxAmountType Usage The total VAT amount that is "added to the document Info req.ID BT-110, BT-111 total w/o VAT". This is the sum of all VAT subcategory Example 486.25 amounts. An invoice may contain the total VAT amount. This amount is the sum of each subtotal for each VAT rate.
Rules BR-53 -[BR-53]-If the VAT accounting currency code (BT-6) is present, then the Invoice total VAT amount in accounting currency (BT-111) shall be provided. BR-CO-14 - [BR- CO-14]-Invoice total VAT amount (BT-110) = Σ VAT category tax amount (BT-117). BR- DEC-13 - [BR-DEC-13]-The allowed maximum number of decimals for the Invoice total VAT amount (BT-110) is 2. BR-DEC-15 [BR-DEC-15]-The allowed maximum number of decimals for the Invoice total VAT amount in accounting currency (BT-111) is 2. UBL- DT-01 - [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
currencyID Type xs:normalizedString Rules PEPPOL-EN16931-CL007 - Currency code must be according to ISO 4217:2005. Use required PEPPOL-EN16931-R051 - All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
Page 100 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:TaxSubtotal Occurrence 1 .. unbounded Rules PEPPOL-EN16931-R053 - Only one tax total with tax subtotals MUST be provided. BR- Type cac:TaxSubtotalType CO-18 - [BR-CO-18]-An Invoice shall at least have one VAT breakdown group (BG-23). Info req.ID BG-23 BR-O-11 - [BR-O-11]-An Invoice that contains a VAT breakdown group (BG-23) with a VAT category code (BT-118) "Not subject to VAT" shall not contain other VAT breakdown groups (BG-23).
cbc:TaxableAmount Occurrence 1 .. 1 Term name VAT category taxable amount Type Amount Usage The amount that is the base for the VAT rate applied in Info req.ID BT-116 the subcategory. Example 1945.00 For each VAT category an invoice must contain the amount to which VAT percent (rate) is applied to calculate the VAT sub total amount for that category.
Rules Several rules apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac- TaxTotal/cac-TaxSubtotal/cbc-TaxableAmount/
Type xs:normalizedString Rules PEPPOL-EN16931-CL007 - Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 - All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cbc:TaxAmount Occurrence 1 .. 1 Term name VAT category tax amount Type cbc:TaxAmountType Usage The calculated amount of the tax derived by multiplying Info req.ID BT-117 the taxable amount with the tax percentage. Example 486.25 For each VAT category an invoice must contain the amount of VAT for that category.
Rules Several rules apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac- TaxTotal/cac-TaxSubtotal/cbc-TaxAmount/
currencyID Type xs:normalizedString Rules PEPPOL-EN16931-CL007 - Currency code must be according to ISO 4217:2005. Use required PEPPOL-EN16931-R051 - All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cac:TaxCategory Occurrence 1 .. 1 Type cac:TaxCategoryType
Page 101 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:ID Occurrence 1 .. 1 Term name VAT category code Type cbc:IDType Usage A code that uniquely identifies each subtotal within the Info req.ID BT-118 transaction. Example S Each VAT category an invoice must be identified with a code.
Rules Several rules apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac- TaxTotal/cac-TaxSubtotal/cac-TaxCategory/cbc-ID/
cbc:Percent Occurrence 1 .. 1 Term name VAT category percentage Type cbc:PercentType Usage The tax rate that is to be applied to the taxable amount in Info req.ID BT-119 order to derive the tax amount. Example 20 For each VAT category an invoice must contain the VAT percentage for each sub total taxable amount so that it can be used to calculate the VAT amount. Where VAT category code is stated then VAT category percentage must also be stated.
Rules BR-48 - [BR-48]-Each VAT breakdown (BG-23) shall have a VAT category rate (BT- 119), except if the Invoice is not subject to VAT. SE-R-006 For Swedish suppliers, only standard VAT rate of 6, 12 or 25 are used
cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType Occurrence 1 .. 1 Term name Tax Scheme ID cbc:ID Type cbc:IDType Default VAT
cac:LegalMonetaryTotal Occurrence 1 .. 1 Info req.ID BG-22 Occurrence 1 .. 1 Term name Sum of line amounts Type cbc:LineExtensionAmountType Usage Sum of line amounts in the document. cbc:LineExtensionAmount Info req.ID BT-106 An invoice must contain the sum of all line amounts. The Example 3800.0 amount must be exclusive of VAT but inclusive of allowances or charges applied to the lines as well as taxes, other than VAT.
Rules BR-12 [BR-12]-An Invoice shall have the Sum of Invoice line net amount (BT-106). BR- CO-10 [BR-CO-10]-Sum of Invoice line net amount (BT-106) = Σ Invoice line net amount (BT-131). BR-DEC-09 [BR-DEC-09]-The allowed maximum number of decimals for the Sum of Invoice line net amount (BT-106) is 2. UBL-DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
Type xs:normalizedString Rules PEPPOL-EN16931-CL007 - Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
Page 102 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:TaxExclusiveAmount Occurrence 1 .. 1 Term name Document total without VAT Type Amount Usage The "Sum of line amounts" plus "sum of allowances on Info req.ID BT-109 document level" plus "sum of charges on document Example 3600.0 level". An invoice must contain the total amount of the invoice, including document level allowances and charges but exclusive of VAT.
Rules BR-13 [BR-13]-An Invoice shall have the Invoice total amount without VAT (BT-109). BR-CO-13 [BR-CO-13]-Invoice total amount without VAT (BT-109) = Σ Invoice line net amount (BT-131) - Sum of allowances on document level (BT-107) + Sum of charges on document level (BT-108). BR-DEC-12 [BR-DEC-12]-The allowed maximum number of decimals for the Invoice total amount without VAT (BT-109) is 2. UBL-DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cbc:TaxInclusiveAmount Occurrence 1 .. 1 Term name Document total including VAT Type Amount Usage The total value including VAT Info req.ID BT-112 An invoice must contain the total amount of the invoice Example 4500.0 inclusive VAT. I.e. the total value of the purchase irrespective of payment status.
Rules BR-14 [BR-14]-An Invoice shall have the Invoice total amount with VAT (BT-112). BR- CO-15 [BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110). BR-DEC-14 [BR-DEC-14]- The allowed maximum number of decimals for the Invoice total amount with VAT (BT- 112) is 2. UBL-DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
Page 103 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:AllowanceTotalAmount Occurrence 0 .. 1 Term name Sum of allowances on document level Type Amount Usage Sum of all allowances on header level in the document. Info req.ID BT-107 Allowances on line level are included in the line amount Example 200.0 and summed up into the "sum of line amounts" An invoice may contain the total amount of all allowances given on document level. Line allowances are included in the net line amount.
Rules BR-CO-11 [BR-CO-11]-Sum of allowances on document level (BT-107) = Σ Document level allowance amount (BT-92). BR-DEC-10 [BR-DEC-10]-The allowed maximum number of decimals for the Sum of allowanced on document level (BT-107) is 2. UBL- DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits currencyID Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cbc:ChargeTotalAmount Occurrence 0 .. 1 Term name Sum of charges on document level Type Amount Usage Sum of all charge on header level in the document. Info req.ID BT-108 Charges on line level are included in the line amount and Example 0.0 summed up into the "sum of line amounts" An invoice may contain the total amount of all charges given on document level. Line charges are included in the net line amount.
Rules BR-CO-12 [BR-CO-12]-Sum of charges on document level (BT-108) = Σ Document level charge amount (BT-99). BR-DEC-11 [BR-DEC-11]-The allowed maximum number of decimals for the Sum of charges on document level (BT-108) is 2. UBL-DT-01 [UBL-DT- 01]-Amounts shall be decimal up to two fraction digits
Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cbc:PayableRoundingAmount Occurrence 0 .. 1 Term name Rounding of document total Type Amount Usage Any rounding of the "Document total including VAT" Info req.ID BT-114 An invoice may contain the rounding amount (positive or Example 0.0 negative) added to the invoice to produce a rounded invoice total.
Rules BR-DEC-17 [BR-DEC-17]-The allowed maximum number of decimals for the Rounding amount (BT-114) is 2. UBL-DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
Page 104 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. Example GBP PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the currencyID invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cbc:PayableAmount Occurrence 1 .. 1 Term name Amount for payment Type Amount Usage The amount that is expected to be paid based on the Info req.ID BT-115 document. This amount is the "Document total including Example 3500.0 VAT" less the "paid amounts" that have been paid a- priori. An invoice must contain the total amount to be paid that is due. If the invoice is fully paid i.e. cash or card, the due amount for the invoice is zero.
Rules BR-15 [BR-15]-An Invoice shall have the Amount due for payment (BT-115). BR-CO-16 [BR-CO-16]-Amount due for payment (BT-115) = Invoice total amount with VAT (BT- 112) -Paid amount (BT-113) +Rounding amount (BT-114). BR-DEC-18 [BR-DEC-18]- The allowed maximum number of decimals for the Amount due for payment (BT-115) is 2. UBL-DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cac:InvoiceLine Occurrence 1 .. unbounded Rules BR-16 [BR-16]-An Invoice shall have at least one Invoice line (BG-25) Type cac:InvoiceLineType Info. Req.ID BG-25
Occurrence 1 .. 1 Term name Invoice line identifier Type cbc:IDType Usage Each line in an invoice must contain an identifier that is cbc:ID Info req.ID BT-126 unique within the document to make it possible to Example 1 reference the line. For example, from other documents like credit notes and in disputes.
Rules BR-21 [BR-21]-Each Invoice line (BG-25) shall have an Invoice line identifier (BT- 126).
Page 105 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cbc:InvoicedQuantity Occurrence 1 .. 1 Term name Invoiced quantity Type Quantity Usage Each line in an invoice must contain the invoiced Info req.ID BT-129 quantity. The quantity may be negative e.g. in case of Example 100 returns.
Rules BR-22 [BR-22]-Each Invoice line (BG-25) shall have an Invoiced quantity (BT-129).
Type Code Rules BR-23 [BR-23]-An Invoice line (BG-25) shall have an Invoiced quantity unit of measure unitCode Info req.ID BT-130 code (BT-130). Example PK cbc:LineExtensionAmount Occurrence 1 .. 1 Term name Invoice line net amount Type Identifier Usage Each line in an invoice must contain the total amount of Info req.ID BT-131 the line. The amount is “net” without VAT, i.e. inclusive Example 2145.00 of line level allowances and charges as well as relevant taxes, except VAT which must be excluded from the amount.
Rules BR-24 [BR-24]-Each Invoice line (BG-25) shall have an Invoice line net amount (BT-131). PEPPOL-EN16931-R120 Invoice line net amount MUST equal (Invoiced quantity * (Item net price/item price base quantity) + Sum of invoice line charge amount - sum of invoice line allowance amount. BR-DEC-23 [BR-DEC-23]-The allowed maximum number of decimals for the Invoice line net amount (BT-131) is 2. UBL-DT-01 [UBL-DT-01]-Amounts shall be decimal up to two fraction digits
currencyID Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
cac:Item Occurrence 1 .. 1 Type cac:ItemType Info req.ID BG-31
cbc:Description Occurrence 0 .. 1 Term name Item description Type Text Usage A detailed description of the item. Info req.ID BT -154 Example Long description of the item on the invoice line cbc:Name Occurrence 1 .. 1 Term name Item name Type Text Usage NHS Supply Chain Product Code. Info req.ID BT-153 Example Item Name Rules BR-25 [BR-25]-Each Invoice line (BG-25) shall contain the Item name (BT-153).
cac:SellersItemIdentification Occurrence 0 .. 1 Type cac:ItemIdentificationType
Page 106 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Occurrence 1 .. 1 Term name Item seller’s identifier Type Identifier Usage The seller’s identifier for the item. Info req.ID BT-155 Each line in an invoice may contain the seller’s identifier cbc:ID Example 9873242 for an item.
cac:StandardItemIdentification Occurrence 0 .. 1 Type cac:ItemIdentificationType Occurrence 1 .. 1 Term name Item standard identifier cbc:ID Type Identifier Usage Items Global Traded Identification Number (GTIN) Info req.ID BT-157 Rules BR-64 [BR-64]-The Item standard identifier (BT-157) shall have a Scheme identifier. Example 1234567891231
Type xs:normalizedString schemeID Use optional Example 0160
cac:ClassifiedTaxCategory Occurrence 1 .. 1 Type cac:TaxCategoryType Info req.ID BG-30
Occurrence 1 .. 1 Term name Item VAT category code cbc:ID Type cbc:IDType Usage Each line in an invoice may contain the VAT category/ Info req.ID BT-151 rate used for this invoice line. The category code acts as Example S a key for summing up line amounts pr. VAT category as well for relating the VAT category percentage given on document level, to the line. If the invoice is a VAT invoice each line must contain a category code.
Rules BR-CO-04 [BR-CO-04]-Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151). BR-O-12 [BR-O-12]-An Invoice that contains a VAT breakdown group (BG-23) with a VAT category code (BT-118) "Not subject to VAT" shall not contain an Invoice line (BG-25) where the Invoiced item VAT category code (BT- 151) is not "Not subject to VAT".
cbc:Percent Occurrence 0 .. 1 Term name Line VAT rate Type Percentage Usage The VAT percentage rate that applies to the invoice line Info req.ID BT-152 as a whole. Example 20 Rules There are several rules that apply: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl- invoice/cac-InvoiceLine/cac-Item/cac-ClassifiedTaxCategory/cbc-Percent/
cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType
Page 107 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists Occurrence 1 .. 1 Term name Tax Scheme ID Type cbc:IDType cbc:ID Default VAT
cac:Price Occurrence 1 .. 1 Type cac:PriceType Info req.ID BG-29 Occurrence 1 .. 1 Term name Item price cbc:PriceAmount Type cbc:PriceAmountType Usage Each line in an invoice may contain the net price of the Info req.ID BT-146 item including all allowances or charges that directly Example 23.45 relates to price (e.g. discount), and taxes but excluding VAT. The net price of an item including discounts or surcharges that apply to the price.
Rules BR-26 [BR-26]-Each Invoice line (BG-25) shall contain the Item net price (BT-146). BR- 27 [BR-27]-The Item net price (BT-146) shall NOT be negative. PEPPOL-EN16931- R046 Item net price MUST equal (Gross price - Allowance amount) when gross price is provided. Type xs:normalizedString Rules PEPPOL-EN16931-CL007 Currency code must be according to ISO 4217:2005. currencyID Use required PEPPOL-EN16931-R051 All currencyID attributes must have the same value as the Example GBP invoice currency code (BT-5), except for the invoice total VAT amount in accounting currency (BT-111).
Page 108 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
9.2 Example
Page 109 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 110 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 111 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 112 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 113 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 114 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
10. Credit Notes The following table contains the elements required by NHS Supply Chain within the Credit Note Document. 10.1 Requirements
Element/Attribute Description Usage/Rules/Code lists
CreditNote Type CreditNoteType cbc:UBLVersionID Occurrence 1 .. 1 Type cbc:UBLVersionIDType
cbc:CustomizationID Occurrence 1 .. 1 Term name Customization identifier Type cbc:CustomizationIDType Usage Identifies the specification of content and rules that apply Info req.ID tir14-001 to the transaction. Example Identifying the customization/implementation guide/ urn:www.cenbii.eu:transaction:biitrns014:ver2.0:extended:u contextualization of the syntax message and its rn:www.peppol.eu:bis:peppol5a:ver2.0 extension that applies to the credit note transaction, enables the receiver to apply the correct validation to the received document as well as to route the document to an appropriate service for processing.
Rules BII2-T14-R001 - A credit note MUST have a customization identifier
cbc:ProfileID Occurrence 1 .. 1 Term name Profile identifier Type cbc:ProfileIDType Usage Identifies the BII profile or business process context in Info req.ID tir14-002 which the transaction appears. Example urn:www.cenbii.eu:profile:bii04:ver2.0 Identifying the profile or business process context in which the transaction appears enables the buyer to direct the message to an appropriate service as well as controlling its relation to other documents exchanged as part of the same process.
Rules BII2-T14-R002 - A credit note MUST have a business process identifier
cbc:ID Occurrence 1 .. 1 Term name Document identifier Type cbc:IDType Usage Credit Note Number Info req.ID tir14-003 Bus req.ID tbr14-024 Rules BII2-T14-R003 - A credit note MUST have a credit note identifier
cbc:IssueDate Occurrence 1 .. 1 Term name Document issue date Type cbc:IssueDateType Usage Credit Note Date Info req.ID tir14-004 Bus req.ID tbr14-024 Rules BII2-T14-R004 - A credit note MUST have a credit note Example 2017-03-20 issue date
Page 115 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:DocumentCurrencyCode Occurrence 1 .. 1 Term name Credit note currency code Type cbc:DocumentCurrencyCodeType Usage The currency in which the monetary amounts are stated Info req.ID tir14-007 must be stated in the credit note. Bus req.ID tbr14-028 Example GBP Rules BII2-T14-R005 - A credit note MUST specify the currency code for the document CL-014-002 - DocumentCurrencyCode MUST be coded using ISO code list 4217 listID Type xs:normalizedString Rules EUGEN-T14-R026 - A currency code element MUST Use required have a list identifier attribute “ISO4217”.
cac:OrderReference Occurrence 1 .. 1 Type cac:OrderReferenceType cbc:ID Occurrence 1 .. 1 Term name Order reference identifier Type cbc:IDType Usage NHS Supply Chain Order Number Info req.ID OP-T14-003
cac:BillingReference Occurrence 1 .. 1 Rules EUGEN-T14-R047 - A credit note MUST refer either to Type cac:BillingReferenceType an invoice or a credit note cac:InvoiceDocumentReference Occurrence 1 .. 1 Type cac:DocumentReferenceType cbc:ID Occurrence 1 .. 1 Term name Document identifier Type cbc:IDType Usage Original Invoice Number Info req.ID tir14-118 Bus req.ID tbr14-050
cac:AccountingSupplierParty Occurrence 1 .. 1 Identifies the Supplier Type cac:SupplierPartyType cac:Party Occurrence 1 .. 1 Type cac:PartyType cbc:EndpointID Occurrence 1 .. 1 Term name Seller electronic address Type cbc:EndpointIDType Usage A credit note may contain the sellers electronic Info req.ID tir14-097 address. The address can be of any format and the Bus req.ID tbr14-037 format should be identified in the message.
Rules EUGEN-T14-R023 - An endpoint identifier MUST have a scheme identifier attribute. schemeID Type xs:normalizedString Rules OP-T14-R002 - An Endpoint Identifier Scheme MUST be Use required from the list of PEPPOL Party Identifiers described in the Example GLN "PEPPOL Policy for using Identifiers". cac:PartyName Occurrence 1 .. 1 Type cac:PartyNameType cbc:Name Occurrence 1 .. 1 Term name Seller name Type cbc:NameType Usage A credit note must contain the name of the seller. Info req.ID tir14-014 Bus req.ID tbr14-024, tbr14-048 Rules EUGEN-T14-R035 - A credit note MUST have a seller name cac:PostalAddress Occurrence 1 .. 1 Rules EUGEN-T14-R037 - A credit note MUST have a seller Type cac:AddressType postal address
Page 116 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type cbc:StreetNameType Usage The main address line in a postal address usually the Info req.ID tir14-015 street name and number. Bus req.ID tbr14-016, tbr14-024 A credit note must contain the seller’s street name and number or P.O.box.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type cbc:AdditionalStreetNameType Usage An additional address line in a postal address that can Info req.ID tir14-086 be used to give further details supplementing the main Bus req.ID tbr14-016, tbr14-024 line. Common use are secondary house number in a complex or in a building. A credit note may contain an additional address line for seller address.
cbc:CityName Occurrence 0 .. 1 Term name City Type cbc:CityNameType Usage The common name of the city where the postal address Info req.ID tir14-016 is. The name is written in full rather than as a code. Bus req.ID tbr14-016, tbr14-024 A credit note must contain the seller’s city.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type cbc:PostalZoneType Usage The identifier for an addressable group of properties Info req.ID tir14-017 according to the relevant national postal service, such as Bus req.ID tbr14-016, tbr14-024 a ZIP code or Post Code. A credit note may contain the seller’s post code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type cbc:CountrySubentityType Usage For specifying a region, county, state, province etc. Info req.ID tir14-018 within a country by using text. Bus req.ID tbr14-016, tbr14-024 In some countries regions or other type of country sub divisions are commonly used. A credit note may contain that information.
cac:Country Occurrence 0 .. 1 Type cac:CountryType cbc:IdentificationCode Occurrence 1 .. 1 Term name Country code Type cbc:IdentificationCodeType Usage The country where the address is. The country should Info req.ID tir14-019 always be given by using ISO code 3166 alpha 2 Bus req.ID tbr14-016, tbr14-024 The seller’s address country must be contained in a credit note in the form of a two letter code (ISO 3166-1 alpha-2). Code List ID: ISO3166-1:Alpha2
Rules CL-T14-R004 - Country codes in a credit note MUST be coded using ISO code list 3166-1
listID Type xs:normalizedString Rules EUGEN-T14-R027 - A country identification code MUST Use required have a list identifier attribute “ISO3166-1:Alpha2”. cac:PartyTaxScheme Occurrence 0 .. 1 Type cac:PartyTaxSchemeType
Page 117 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:CompanyID Occurrence 0 .. 1 Term name Seller VAT identifier Type cbc:CompanyIDType Usage When the credit note is a VAT credit note it must state Info req.ID tir14-020 the sellers VAT registration number and tax scheme. Bus req.ID tbr14-024 Rules BII2-T14-R044 - A seller VAT identifier MUST be provided if the credit note has a VAT total amount EUGEN-T14-R041 - The VAT identifier for the supplier SHOULD be prefixed with country code for companies with VAT registration in EU countries
schemeID Type xs:normalizedString Rules OP-T14-R008 - A Party Company Identifier Scheme Use required MUST be from the list of PEPPOL Party Identifiers described in the "PEPPOL Policy for using Identifiers".
cac:TaxScheme Occurrence 1 .. 1
cbc:ID OccurrenceType 1cac:TaxSchemeType .. 1 Term name Tax Scheme ID Type cbc:IDType BII Usage Identifies the tax scheme Info req.ID 22 Default VAT
cac:PartyLegalEntity Occurrence 0 .. 1 Type cac:PartyLegalEntityType cbc:RegistrationName Occurrence 0 .. 1 Term name Seller legal registration name Type cbc:RegistrationNameType Usage The name under which the seller is legally registered. Info req.ID tir14-108 Bus req.ID tbr14-022 Rules EUGEN-T14-R039 - A supplier SHOULD provide information about its legal entity information cbc:CompanyID Occurrence 0 .. 1 Term name Seller legal registration identifier Type cbc:CompanyIDType Usage A credit note may contain the identifier assigned to the Info req.ID tir14-021 party by the national company registrar. Bus req.ID tbr14-022 Rules EUGEN-T14-R039 - A supplier SHOULD provide information about its legal entity information schemeID Type xs:normalizedString Rules OP-T14-R008 - A Party Company Identifier Scheme Use required MUST be from the list of PEPPOL Party Identifiers described in the "PEPPOL Policy for using Identifiers". cac:AccountingCustomerParty Occurrence 1 .. 1 Identifies the Buyer - NHS Supply Chain Type cac:CustomerPartyType cac:Party Occurrence 1 .. 1 Type cac:PartyType cbc:EndpointID Occurrence 1 .. 1 Term name Buyers electronic address Type cbc:EndpointIDType Usage A credit note may contain the buyers electronic address. Info req.ID tir14-099 The address can be of any format and the format should Bus req.ID tbr14-037 be identified in the message.
Rules EUGEN-T14-R023 - An endpoint identifier MUST have a scheme identifier attribute. schemeID Type xs:normalizedString Rules OP-T14-R002 - An Endpoint Identifier Scheme MUST be Use required from the list of PEPPOL Party Identifiers described in the Example GLN "PEPPOL Policy for using Identifiers".
Page 118 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cac:PartyName Occurrence 1 .. 1 Type cac:PartyNameType cbc:Name Occurrence 1 .. 1 Term name Buyer name Type cbc:NameType Usage A Credit note must contain name of the buyer. Info req.ID tir14-026 Bus req.ID tbr14-024, tbr14-048 Rules EUGEN-T14-R036 - A credit note MUST have a buyer name cac:PostalAddress Occurrence 1 .. 1 Rules EUGEN-T14-R038 - A credit note MUST have a buyer Type cac:AddressType postal address cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type cbc:StreetNameType Usage The main address line in a postal address usually the Info req.ID tir14-027 street name and number. Bus req.ID tbr14-016, tbr14-024 A credit note must contain the buyer’s street name and number or P.O. box.
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type cbc:AdditionalStreetNameType Usage An additional address line in a postal address that can Info req.ID tir14-088 be used to give further details supplementing the main Bus req.ID tbr14-016, tbr14-024 line. Common use are secondary house number in a complex or in a building. A credit note may give an additional address line for buyer’s address.
cbc:CityName Occurrence 0 .. 1 Term name City Type cbc:CityNameType Usage The common name of the city where the postal address Info req.ID tir14-028 is. The name is written in full rather than as a code. Bus req.ID tbr14-016, tbr14-024 A credit note must contain the buyer’s city.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type cbc:PostalZoneType Usage The identifier for an addressable group of properties Info req.ID tir14-029 according to the relevant national postal service, such as Bus req.ID tbr14-016, tbr14-024 a ZIP code or Post Code. A credit note may contain the buyer’s post code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country subdivision Type cbc:CountrySubentityType Usage For specifying a region, county, state, province etc. Info req.ID tir14-030 within a country by using text. Bus req.ID tbr14-016, tbr14-024 In some countries regions or other type of country sub divisions are commonly used. A credit note may contain that information.
cac:Country Occurrence 0 .. 1 Type cac:CountryType
Page 119 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:IdentificationCode Occurrence 1 .. 1 Term name Country code Type cbc:IdentificationCodeType Usage The country where the address is. The country should Info req.ID tir14-031 always be given by using ISO code 3166 alpha 2 Bus req.ID tbr14-016, tbr14-024 The buyer’s address country must be given in a credit note in the form of a two letter code (ISO 3166-1 alpha- 2). Code List ID: ISO3166-1:Alpha2
Rules CL-T14-R004 - Country codes in a credit note MUST be coded using ISO code list 3166-1
listID Type xs:normalizedString Rules EUGEN-T14-R027 - A country identification code MUST Use required have a list identifier attribute “ISO3166-1:Alpha2”. cac:PartyTaxScheme Occurrence 0 .. 1 Type cac:PartyTaxSchemeType cbc:CompanyID Occurrence 0 .. 1 Term name Buyer VAT identifier Type cbc:CompanyIDType Usage A credit note may contain the buyers VAT identifier In Info req.ID tir14-032 order to facilitate reverse charge and intra community Bus req.ID tbr14-024, tbr14-019, tbr14-020 supply billing.
Rules BII2-T14-R047 - A buyer VAT identifier MUST be present if the VAT category code is reverse VAT schemeID Type xs:normalizedString Rules OP-T14-R008 - A Party Company Identifier Scheme Use required MUST be from the list of PEPPOL Party Identifiers described in the "PEPPOL Policy for using Identifiers". cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType cbc:ID Occurrence 1 .. 1 Term name Tax Scheme ID Type cbc:IDType Usage Identifies the tax scheme Info req.ID 22 Default VAT
cac:PartyLegalEntity Occurrence 0 .. 1 Type cac:PartyLegalEntityType cbc:CompanyID Occurrence 0 .. 1 Term name Buyer legal registration identifier Type cbc:CompanyIDType Usage A credit note may contain the identifier assigned to the Info req.ID tir14-033 Party by the national company registrar. Bus req.ID tbr14-022 Rules EUGEN-T14-R040 - A customer SHOULD provide information about its legal entity information schemeID Type xs:normalizedString Rules OP-T14-R008 - A Party Company Identifier Scheme Use required MUST be from the list of PEPPOL Party Identifiers described in the "PEPPOL Policy for using Identifiers". cac:Delivery Occurrence 0 .. 1 Type cac:DeliveryType cbc:ActualDeliveryDate Occurrence 0 .. 1 Term name Delivery date Type cbc:ActualDeliveryDateType Usage A credit note may contain the actual delivery date on Info req.ID OP-T14-016 which goods or consignments are delivered from the seller.
Page 120 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cac:DeliveryLocation Occurrence 0 .. 1 Type cac:LocationType cbc:ID Occurrence 0 .. 1 Term name Delivered to location identifier Type cbc:IDType Usage An identifier for the location to where the ordered items where be Info req.ID OP-T14-017 delivered. For Stock and Blue Diamond type orders this will be the GLN of the depot to deliver to. For eDirect type orders this will be the Delivery Point code allocated by NHS Supply Chain Rules EUGEN-T14-R034 - A delivery location identifier MUST have a scheme identifier attribute schemeID Type xs:normalizedString Usage GLN = Delivery GLN Use required ZZZ = eDirect Delivery Point Code Example GLN cac:Address Occurrence 0 .. 1 Type cac:AddressType cbc:StreetName Occurrence 0 .. 1 Term name Address line 1 Type cbc:StreetNameType Usage The main address line in a postal address usually the Info req.ID OP-T14-018a street name and number
cbc:AdditionalStreetName Occurrence 0 .. 1 Term name Address line 2 Type cbc:AdditionalStreetNameType Usage An additional address line in a postal address that can Info req.ID OP-T14-018b be used to give further details supplementing the main line. Common use are secondary house number in a complex or in a building.
cbc:CityName Occurrence 0 .. 1 Term name City Type cbc:CityNameType Usage The common name of the city where the postal address Info req.ID OP-T14-018c is. The name is written in full rather than as a code.
cbc:PostalZone Occurrence 0 .. 1 Term name Post code Type cbc:PostalZoneType Usage The identifier for an addressable group of properties Info req.ID OP-T14-018d according to the relevant national postal service, such as a ZIP code or Post Code.
cbc:CountrySubentity Occurrence 0 .. 1 Term name Country Subdivision Type cbc:CountrySubentityType Usage For specifying a region, county, state, province etc. Info req.ID OP-T14-018e within a country by using text.
cac:Country Occurrence 0 .. 1 Type cac:CountryType cbc:IdentificationCode Occurrence 1 .. 1 Term name Country code Type cbc:IdentificationCodeType Usage The country where the address is. The country should Info req.ID OP-T14-018f always be given by using ISO code 3166 alpha 2 Code List ID: ISO3166-1:Alpha2
Rules CL-T14-R004 - Country codes in a credit note MUST be coded using ISO code list 3166-1 listID Type xs:normalizedString Rules EUGEN-T14-R027 - A country identification code MUST Use required have a list identifier attribute “ISO3166-1:Alpha2”.
Page 121 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cac:PaymentMeans Occurrence 0 .. unbounded Type cac:PaymentMeansType cbc:PaymentMeansCode Occurrence 1 .. 1 Term name Payment means type Type cbc:PaymentMeansCodeType Usage Indication about how the payment should be handled. Info req.ID OP-T14-019 Code List ID: UNCL4461
Rules CL-T14-R006 - Payment means in a credit note MUST be coded using UNCL 4461 BII2 subset OP-T14-R041 - A payment means MUST specify the payment means type
listID Type xs:normalizedString Rules EUGEN-T14-R028 - A payment means code MUST have
cac:AllowanceCharge Occurrence 0 .. unbounded Used to specify Carriage or Delivery Charges
cbc:ChargeIndicator OccurrenceType 1cac:AllowanceChargeType .. 1 Term name Charge Indicator Type cbc:ChargeIndicatorType BII Usage Indicates whether the Allowance Charge is a Charge (True) and should Info req.ID OP-T14-008 be added or an Allowance (False) and should be subtracted. Example True
cbc:AllowanceChargeReasonCode Occurrence 0 .. 1 Term name Allowance and charges reason code Type cbc:AllowanceChargeReasonCodeType BII Usage A coded specification of what the allowance or charge is. A credit note Info req.ID tir14-092 may contain a coded description of what is being added or deducted. Bus req.ID tbr14-017 E.g. „volume discount" or "packing charges", for each allowance or Example ZZZ charge. Code List ID: UNCL4465 Rules CL-T14-R010 - Coded allowance and charge reasons SHOULD belong to the UNCL 4465 code list BII2 subset
listID Type xs:normalizedString Rules EUGEN-T14-R029 An allowance charge reason code MUST have a Use optional list identifier attribute “UNCL4465”. cbc:AllowanceChargeReason Occurrence 1 .. 1 Term name Allowance and charges reason Type cbc:AllowanceChargeReasonType BII Usage A textual reason for the allowance or the charge. Can also be its name. Info req.ID tir14-091 One textual description of what is being added or deducted. E.g. Bus req.ID tbr14-017 „volume discount" or "packing charges" must be stated for each Example Carriage allowance and charge on document level in a credit note. Rules BII2-T14-R025 - Each document level allowance or charge details MUST have an allowance and charge reason text.
cbc:Amount Occurrence 1 .. 1 Term name Allowance and charge amount Type cbc:AmountType BII Usage The net amount of the allowance or the charge. For each allowance or Info req.ID tir14-047 charge a credit note must contain the amount. Allowances are Bus req.ID tbr14-017 subtracted from the total credit note amount and charges are added to the amount. The amount is “net” without VAT. Rules EUGEN-T14-R022 - An allowance or charge amount MUST NOT be negative.
Page 122 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO code list 4217 Use required Code List ID: ISO4217 Example GBP cac:TaxTotal Occurrence 0 .. 1 Type cac:TaxTotalType cbc:TaxAmount Occurrence 1 .. 1 Term name VAT total amount Type cbc:TaxAmountType Usage The total VAT amount that is "added to the document Info req.ID tir14-049 total w/o VAT". This is the sum of all VAT subcategory Bus req.ID tbr14-024 amounts. A credit note may contain the total VAT amount. This amount is the sum of each subtotal for each VAT rate.
Rules BII2-T14-R015 - A credit note MUST specify the VAT total amount, if there are VAT line amounts EUGEN-T14-R043 - The total tax amount MUST equal the sum of tax amounts per category.
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Code List ID: ISO4217 cac:TaxSubtotal Occurrence 0 .. unbounded Type cac:TaxSubtotalType cbc:TaxableAmount Occurrence 1 .. 1 Term name VAT category taxable amount Type cbc:TaxableAmountType Usage The amount that is the base for the VAT rate applied in Info req.ID tir14-050 the subcategory. Bus req.ID tbr14-024 For each VAT category a credit note must contain the amount to which VAT percent (rate) is applied to calculate the VAT sub total amount for that category.
Rules BII2-T14-R027 - Each VAT category details MUST have a VAT category taxable amount BII2-T14-R049 - The credit note total without VAT MUST be equal to the VAT category taxable amount if the VAT category code is reverse charge
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Code List ID: ISO4217
Page 123 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:TaxAmount Occurrence 1 .. 1 Term name VAT category tax amount Type cbc:TaxAmountType Usage The calculated amount of the tax derived by multiplying Info req.ID tir14-051 the taxable amount with the tax percentage. Bus req.ID tbr14-024 For each VAT category a credit note must contain the amount of VAT for that category.
Rules BII2-T14-R050 - The VAT category tax amount MUST be zero if the VAT category code is reverse charge (since there is only one VAT category allowed it follows that the credit note tax total for reverse charge credit notes is zero) BII2-T14-R028 - Each VAT category details MUST have a VAT category tax amount EUGEN-T14-R042 - The tax amount per category MUST be the taxable amount multiplied by the category percentage.
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Code List ID: ISO4217 cac:TaxCategory Occurrence 1 .. 1 Type cac:TaxCategoryType cbc:ID Occurrence 1 .. 1 Term name VAT category code Type cbc:IDType Usage A code that uniquely identifies each subtotal within the Info req.ID tir14-052 transaction. Bus req.ID tbr14-024 Each VAT category a credit note must be identified with a code. Code List ID: UNCL5305
Rules BII2-T14-R026 - A credit note MUST contain VAT category details unless VAT total amount is omitted. BII2-T14-R029 - Every VAT category details MUST be defined through a VAT category code BII2-T14-R048 - A credit note with a VAT category code of reverse charge MUST NOT contain other VAT categories. CL-T14-R007 - Credit Note tax categories MUST be coded using UNCL 5305 code list BII2 subset EUGEN-T14-R008 - For each tax subcategory the category ID and the applicable tax percentage MUST be provided.
schemeID Type xs:normalizedString Rules EUGEN-T14-R032 - A tax category identifier MUST have Use required a scheme identifier attribute “UNCL5305”.
Page 124 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:Percent Occurrence 1 .. 1 Term name VAT category percentage Type cbc:PercentType Usage The tax rate that is to be applied to the taxable amount in Info req.ID tir14-096 order to derive the tax amount. Bus req.ID tbr14-024 For each VAT category a credit note must contain the VAT percentage for each sub total taxable amount so that it can be used to calculate the VAT amount. Where VAT category code is stated then VAT category percentage must also be stated.
Rules BII2-T14-R030 - The VAT category percentage MUST be provided if the VAT category code is standard. EUGEN-T14-R008 - for each tax subcategory the category ID and the applicable tax percentage MUST be provided.
cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType cbc:ID Occurrence 1 .. 1 Term name Tax Scheme ID Type cbc:IDType Usage Identifies the tax scheme Info req.ID 22 Default VAT
cac:LegalMonetaryTotal Occurrence 1 .. 1 Type cac:MonetaryTotalType cbc:LineExtensionAmount Occurrence 1 .. 1 Term name Sum of line amounts Type cbc:LineExtensionAmountType Usage Sum of line amounts in the document. Info req.ID tir14-054 A credit note must contain the sum of all line amounts. Bus req.ID tbr14-025 The amount must be exclusive of VAT but inclusive of allowances or charges applied to the lines as well as taxes, other than VAT.
Rules BII2-T14-R010 - A credit note MUST have the sum of line amounts BII2-T14-R051 - Sum of line amounts MUST equal the credit note line net amounts
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Example GBP Code List ID: ISO4217
Page 125 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:TaxExclusiveAmount Occurrence 1 .. 1 Term name Document total without VAT Type cbc:TaxExclusiveAmountType Usage The "Sum of line amounts" plus "sum of allowances on Info req.ID tir14-055 document level" plus "sum of charges on document Bus req.ID tbr14-025 level". A credit note must contain the total amount of the credit note, including document level allowances and charges but exclusive of VAT.
Rules BII2-T14-R011 - A credit note MUST have the credit note total without VAT BII2-T14-R049 - The credit note total without VAT MUST be equal to the VAT category taxable amount if the VAT category code is reverse charge BII2-T14-R052 - A credit note total without VAT MUST equal the sum of line amounts plus the sum of charges on document level minus the sum of allowances on document level BII2-T14-R058 - Credit Note total without VAT MUST be equal to the sum of VAT category taxable amounts
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Example GBP Code List ID: ISO4217 cbc:TaxInclusiveAmount Occurrence 1 .. 1 Term name Document total including VAT Type cbc:TaxInclusiveAmountType Usage The total value including VAT Info req.ID tir14-056 A credit note must contain the total amount of the credit Bus req.ID tbr14-025, tbr14-026 note inclusive VAT. I.e. the total value of the purchase irrespective of payment status.
Rules BII2-T14-R012 - A credit note MUST have the credit note total with VAT. BII2-T14-R035 - Credit Note total with VAT MUST NOT be negative BII2-T14-R053 - A credit note total with VAT MUST equal the credit note total without VAT plus the VAT total amount and the rounding of credit note total
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Example GBP Code List ID: ISO4217
Page 126 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:PayableAmount Occurrence 1 .. 1 Term name Amount for payment Type cbc:PayableAmountType Usage The amount that is expected to be paid based on the Info req.ID tir14-061 document. This amount is the "Document total including Bus req.ID tbr14-025, tbr14-026 VAT" less the "paid amounts" that have been paid a- priori. A credit note must contain the total amount to be paid that is due. If the credit note is fully paid i.e. cash or card, the due amount for the credit note is zero.
Rules BII2-T14-R013 - A credit note MUST have the amount due for payment BII2-T14-R037 - Amount due for payment in a credit note MUST NOT be negative BII2-T14-R056 - Amount due for payment MUST be equal to the credit note total amount with VAT minus the paid amounts
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Example GBP Code List ID: ISO4217 cac:CreditNoteLine Occurrence 1 .. unbounded Rules BII2-T14-R014 - A credit note MUST have at least one Type cac:CreditNoteLineType credit note line cbc:ID Occurrence 1 .. 1 Term name Credit note line identifier Type cbc:IDType Usage Each line in a credit note must contain an identifier that Info req.ID tir14-062 is unique within the document to make it possible to Bus req.ID tbr14-002 reference the line. For example, from other documents like credit notes and in disputes.
Rules BII2-T14-R017 - Each credit note line MUST have a credit note line identifier BII2-T14-R014 – A credit note MUST have at least one invoice line
cbc:CreditedQuantity Occurrence 1 .. 1 Term name Credited quantity Type cbc:CreditedQuantityType Usage Each line in a credit note must contain the credited Info req.ID tir14-064 quantity. The quantity may be negative in cases when Bus req.ID tbr14-024 the credit note is used to reverse an invoice line that was negative.
Rules BII2-T14-R018 - Each credit note line MUST have a credit noted quantity unitCode Type xs:normalizedString Rules BII2-T14-R019 - Each credit note line MUST have a Use optional quantity unit of measure Example EA OP-T14-R006 - Unit code MUST be coded according to the UN/ECE Recommendation 20 Code List ID: UNECERec20 unitCodeListID Type xs:normalizedString Rules EUGEN-T14-R030 - A unit code attribute MUST have a Use optional unit code list identifier attribute “UNECERec20”.
Page 127 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:LineExtensionAmount Occurrence 1 .. 1 Term name Credit note line net amount Type cbc:LineExtensionAmountType Usage Each line in a credit note must contain the total amount Info req.ID tir14-065 of the line. The amount is “net” without VAT, i.e. Bus req.ID tbr14-025 inclusive of line level allowances and charges as well as relevant taxes, except VAT which must be excluded from the amount.
Rules BII2-T14-R020 - Each credit note line MUST have a credit note line net amount
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Example GBP Code List ID: ISO4217
cac:Item Occurrence 1 .. 1 Type cac:ItemType cbc:Description Occurrence 0 .. 1 Term name Item description Type cbc:DescriptionType Usage A detailed description of the item. Info req.ID OP-T14-032
cbc:Name Occurrence 1 .. 1 Term name Item name Type cbc:NameType Usage NHS Supply Chain Product Code Info req.ID tir14-068 Bus req.ID tbr14-024, tbr14-048 Rules BII2-T14-R021 - Each credit note line MUST have a credit note line item name and/or the credit note line item identifier
Page 128 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Element/Attribute Description Usage/Rules/Code lists
cac:SellersItemIdentification Occurrence 0 .. 1 Type cac:ItemIdentificationType cbc:ID Occurrence 1 .. 1 Term name Item sellers identifier Type cbc:IDType Usage The sellers identifier for the item. Info req.ID tir14-069 Each line in a credit note may contain the seller’s Bus req.ID tbr14-034 identifier for an item.
cac:StandardItemIdentification Occurrence 0 .. 1 Type cac:ItemIdentificationType cbc:ID Occurrence 1 .. 1 Term name Item standard identifier Type cbc:IDType Usage Items Global Traded Identification Number (GTIN) Info req.ID tir14-070 Rules BII2-T14-R021 - Each credit note line MUST have a Bus req.ID tbr14-006 credit note line item name and/or the credit note line item identifier
schemeID Type xs:normalizedString Rules BII2-T14-R032 - A scheme identifier for the credit note Use optional line item registered identifier MUST be provided if credit GTIN note line item registered identifiers are used to identify a product.(e.g. GTIN) OP-T14-R007 - A standard item identifier scheme MUST be coded according to the list Item Identifier Scheme ID defined by PEPPOL cac:ClassifiedTaxCategory Occurrence 1 .. 1 Type cac:TaxCategoryType cbc:ID Occurrence 1 .. 1 Term name Item VAT category code Type cbc:IDType Usage Each line in a credit note may contain the VAT Info req.ID tir14-072 category/rate used for this credit note line. The category Bus req.ID tbr14-025 code acts as a key for summing up line amounts pr. VAT category as well for relating the VAT category percentage given on document level, to the line. If the credit note is a VAT credit note each line must contain a category code. Code List ID: UNCL5305
Rules BII2-T14-R046 - Each credit note line MUST be categorized with the credit note line VAT category if the credit note has a VAT total amount CL-T14-R007 - Credit Note tax categories MUST be coded using UNCL 5305 code list BII2 subset
schemeID Type xs:normalizedString Rules EUGEN-T10-R032 - A tax category identifier MUST have Use optional a scheme identifier attribute “UNCL5305”.
Page 129 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
cbc:Percent Occurrence 0 .. 1 Term name Line VAT rate Type cbc:PercentType Usage The VAT percentage rate that applies to the credit note Info req.ID tir14-115 line as whole. Bus req.ID tbr14-024
cac:TaxScheme Occurrence 1 .. 1 Type cac:TaxSchemeType cbc:ID Occurrence 1 .. 1 Term name Tax Scheme ID Type cbc:IDType Usage Identifies the tax scheme Info req.ID 25 Default VAT cac:Price Occurrence 0 .. 1 Type cac:PriceType cbc:PriceAmount Occurrence 1 .. 1 Term name Item price Type cbc:PriceAmountType Usage Each line in a credit note may contain the net price of the Info req.ID tir14-075 item including all allowances or charges that directly Bus req.ID tbr14-014, tbr14-024 relates to price (e.g. discount), and taxes but excluding VAT. The net price of an item including discounts or surcharges that apply to the price.
Rules BII2-T14-R034 - Credit Note line item net price MUST NOT be negative
currencyID Type xs:normalizedString Rules CL-T14-R003 - currencyID MUST be coded using ISO Use required code list 4217 Code List ID: ISO4217
Page 130 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
10.2 Example
Page 131 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 132 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 133 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Page 134 of 143 v3.61 11. PEPPOL Validation All data created by a PEPPOL provider must be validated using PEPPOL standards first before sending via the PEPPOL Access Point to NHS Supply Chain. NetEDI recommends the use of Validex XML Message tool which can be found at https://v2.validex.net. The Validex tool validates the messages for structure, data population against the global PEPPOL standards. Your messages will also be validated against NHS Supply Chain’s specific requirements when you send a message through your Access Point to them.
NHS Supply Chain Supplier Message Implementation Guide
Appendix A – PEPPOL Connectivity
To exchange Orders, Order Responses, Despatch Advices, Invoices and Credit Notes with NHS Supply Chain you must sign-up with a PEPPOL Access Provider. The PEPPOL Access Provider should be Department of Health accredited and have performed interoperability testing with other Access Providers to ensure that data can be exchanged seamlessly. I already have a PEPPOL Access Point provider If you are already with an Access Point you simply need to provide the NHS Supply Chain’s Onboarding team with your PEPPOL ID. This usually starts with 0088: and then a GS1 allocated GLN number. To start connectivity testing via PEPPOL please reply to [email protected] with your PEPPOL ID. I don’t have a PEPPOL Access Point provider If you do not currently have an Access Point provider you can contact NHS Supply Chain’s Access Provider, NetEDI, for details on how to become compliant with not only the NHS Supply Chains requirements, but also the Department of Health’s Scan4Safety initiative. NetEDI can be contact on +44 (0) 1772 97778, selecting Option 1, or by email [email protected].
Page 136 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Appendix B – Labels This section comprises of two parts: 1. ASN Labels 2. Legacy Non ASN Labels
ASN Labels All the data required to produce valid NHS Supply Chain labels is provided in the PEPPOL Order message. Labels are required to be in EAN Code 128 format with a subset of B. The labels should be Avery (or compatible) L7168 (for laser) or J8168 (for inkjet) address labels. A4 199.6 x 143.53 mm - 2 per sheet. The following tables describe the elements from the PEPPOL Despatch Advice (Or Order) message that should be used to produce the data for the individual fields on the labels. Type of label to print should be determined by the type of order. Order type is specified on element cbc:OrderTypeCode within the PEPPOL Order message.
Blue Diamond Label for ASN deliveries cbc:OrderTypeCode = 402 Handling Units Label – recommended A5 label.
PEPPOL ASN Field – Left PEPPOL ASN Field - Right Fixed Value: NHS Supply Chain System must populate Supplier Name Fixed Value: Blue Diamond Delivery 1.Delivery Point Name 2. Requisition Point 4.Requisition Point Number (a) 3. Requisition Point Name 4.Requisition Point Number (b) 5.Sorting Reference 6.NHS Supply Chain Order Reference 7.Item Identifier (NPC/MPC/EAN/GTIN) 8.Batch Number 9.Expiry Date 10.SSCC - using GS1-128 System must determine number of items within the handling unit System must determine number of Cartons
1. Delivery Point Name (cac:DeliveryCustomerParty/cac:PartyName/cbc:Name) 2. Requisition Point Name - cac:AdditionalDocumentReference* [cbc:DocumentType=” Reqpt Name”]/cbc:ID 3. Requisition Point - cac:AdditionalDocumentReference - [cbc:DocumentType=”Reqpt”]/cbc:ID* 4. Requisition Point Number a. cac:AdditionalDocumentReference[cbc:DocumentType=”Reqptno”]/cbc:ID Text before the / * b. cac:AdditionalDocumentReference[cbc:DocumentType=”Reqptno”]/cbc:ID Text after the / * 5. Sorting Reference a. cac:AdditionalDocumentReference [cbc:DocumentType=”SortRef”]/cbc:ID* 6. NHS Supply Chain Order Reference - cac:DespatchLine/cac:OrderLineReference/cbc:LineID/cac:OrderReference/cbc:ID 7. Item Identifier – Use “Mixed” if multiple item identifiers within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:BuyersItemIdentification/cbc:ID (For NPC) b. cac:DespatchLine/cac:Item/cac:SellersItemIdentification/cbc:ID (For MPC) c. cac:DespatchLine/cac:Item/cac:StandardItemIdentification/cbc:ID (For EAN or GTIN) 8. Batch Number – Blank if multiple Batch Numbers within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:ItemInstance/cac:LotIdentification/cbc:LotNumberID 9. Expiry Date – Blank if multiple Expiry Dates within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:ItemInstance/cac:LotIdentification/cbc:ExpiryDate 10. SSCC - cac:DespatchLine/cac:Shipment/cac:TransportHandlingUnit/cbc:ShippingMarks
* This information can be taken from the Despatch Advice within the AdditionalDocumentReference or taken from original Order. It is recommended to populate this information in the Despatch Advice for ease of reprinting labels without access to the original Order.
Page 137 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Example Label
Page 138 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide eDirect Label for ASN deliveries cbc:OrderTypeCode = 220 Handling Units Label – recommended A5 label.
PEPPOL ASN Field – Left PEPPOL ASN Field - Right System must populate Supplier Name 1. Requisition Point + “-“ + 2. Requisition Point Name
3.Requisition Point Number 4.Delivery Point Name 5.Additional address information 6.NHS Supply Chain Order Reference 7.Item Identifier (NPC/MPC) 8.Delivery Date 9.Batch Number 10.SSCC - using GS1-128 System must determine number of items within the handling unit System must determine number of Cartons
1. Requisition Point - cac:AdditionalDocumentReference * [cbc:DocumentType=”Reqpt”]/cbc:ID 2. Requisition Point Name - cac:AdditionalDocumentReference [cbc:DocumentType=” Reqpt Name”]/cbc:ID * 3. Requisition Point Number (Taken from original Order) a. cac:AdditionalDocumentReference[cbc:DocumentType=”Reqptno”]/cbc:ID 4. Delivery Point Name (cac:DeliveryCustomerParty/cac:PartyName/cbc:Name) 5. Additional address information a. cac:DeliveryCustomerParty/cac:DeliveryLocation/cac:Address/cbc:StreetName b. cac:DeliveryCustomerParty/cac:DeliveryLocation/cac:Address/cbc:AdditionalStreetName c. cac:DeliveryCustomerParty/cac:DeliveryLocation/cac:Address/cbc:CityName + “, “ + d. cac:DeliveryCustomerParty/cac:DeliveryLocation/cac:Address/cbc:CountrySubentity e. cac:DeliveryCustomerParty/cac:DeliveryLocation/cac:Address/cbc:PostalZone 6. NHS Supply Chain Order Reference - cac:DespatchLine/cac:OrderLineReference/cbc:LineID/cac:OrderReference/cbc:ID 7. Item Identifier – Use “Mixed” if multiple item identifiers within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:BuyersItemIdentification/cbc:ID (For NPC) b. cac:DespatchLine/cac:Item/cac:SellersItemIdentification/cbc:ID (For MPC) c. cac:DespatchLine/cac:Item/cac:StandardItemIdentification/cbc:ID (For EAN or GTIN) 8. Delivery Date - cac:Shipment/cac:Delivery/cac:EstimatedDeliveryPeriod/cbc:EndDate 9. Batch Number – Blank if multiple Batch Numbers within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:ItemInstance/cac:LotIdentification/cbc:LotNumberID 10. SSCC - cac:DespatchLine/cac:Shipment/cac:TransportHandlingUnit/cbc:ShippingMarks
* This information can be taken from the Despatch Advice within the AdditionalDocumentReference or taken from original Order. It is recommended to populate this information in the Despatch Advice for ease of reprinting labels without access to the original Order.
Page 139 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Example Label
Page 140 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Stock Label for ASN Deliveries cbc:OrderTypeCode = 105 Handling Unit Label – recommended A5 label.
PEPPOL ASN Field – Left PEPPOL ASN Field - Right
1.Delivery Point Name System must populate Supplier Name
2.NHS Supply Chain Order Reference 3.Item Identifier (NPC/MPC)
4.Delivery Date 5.Expiry Date 7.Batch Number
7.SSCC - using GS1-128
System must determine number of items within the handling unit System must determine number of Cartons
1. Delivery Point Name (cac:DeliveryCustomerParty/cac:PartyName/cbc:Name) 2. NHS Supply Chain Order Reference - cac:DespatchLine/cac:OrderLineReference/cbc:LineID/cac:OrderReference/cbc:ID 3. Item Identifier – Use “Mixed” if multiple item identifiers within the Handling Unit a. cac:DespatchLine/cac:Item/cac:BuyersItemIdentification/cbc:ID (For NPC) b. cac:DespatchLine/cac:Item/cac:SellersItemIdentification/cbc:ID (For MPC) 4. Delivery Date - cac:Shipment/cac:Delivery/cac:EstimatedDeliveryPeriod/cbc:EndDate 5. Expiry Date – Blank if multiple Expiry Dates within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:ItemInstance/cac:LotIdentification/cbc:ExpiryDate 6. Batch Number – Blank if multiple Batch Numbers within the Handling Unit e.g. pallet level a. cac:DespatchLine/cac:Item/cac:ItemInstance/cac:LotIdentification/cbc:LotNumberID 7. SSCC - cac:DespatchLine/cac:Shipment/cac:TransportHandlingUnit/cbc:ShippingMarks
Example Label
Page 141 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide
Legacy Non ASN Labels This section covers the existing Labels used prior to the ASN message. If sending ASN messages the below labels are no longer required, instead use the labels from the ASN Label section above. All the data required to produce valid NHS Supply Chain labels is provided in the PEPPOL Order message. Labels are required to be in EAN Code 128 format with a subset of B. The labels should be Avery (or compatible) L7166 (for laser) or J8166 (for inkjet) address labels. A4 sheets 99.1mm x 93.1mm labels, six per sheet. The following tables describe the elements from the PEPPOL Order message that should be used to produce the data for the individual fields on the labels. Type of label to print should be determined by the type of order. Order type is specified on element cbc:OrderTypeCode within the PEPPOL Order message.
Blue Diamond Label for non ASN deliveries cbc:OrderTypeCode = 402
Label PEPPOL Order Field - Left PEPPOL Order Field - Right Fixed Value: NHS Supply Chain Fixed Value: Blue Diamond Delivery cac:Delivery/cac:DeliveryParty/cac:PartyName/cbc:Name
cac:AdditionalDocumentReferenc cac:AdditionalDocumentReferenc e e [cbc:DocumentType=” Reqpt [cbc:DocumentType=”Reqpt”]/ Name”]/cbc:ID cbc:ID cac:AdditionalDocumentReferenc e [cbc:DocumentType=”Reqpt”]/ cbc:ID cac:AdditionalDocumentReference[cbc:DocumentType=”Reqptno”]/cbc :ID Text before the / cac:AdditionalDocumentReference[cbc:DocumentType=”Reqptno”]/cbc :ID Text after the / cac:AdditionalDocumentReferenc cbc:ID e [cbc:DocumentType=”SortRef”]/ cbc:ID System must determine number cbc:ID of parcels
Page 142 of 143 v3.61 NHS Supply Chain Supplier Message Implementation Guide eDirect Label for non ASN deliveries cbc:OrderTypeCode = 220
Label PEPPOL Order Field cac:SellerSupplierParty/cac:Party/cac:PartyName/cbc:Name
cbc:ID
cac:AdditionalDocumentReference[cbc:DocumentType=”Reqptno”] /cbc:ID cac:Delivery/cac:RequestedDeliveryPeriod/cbc:StartDate
cac:AdditionalDocumentReference[cbc:DocumentType=”Reqpt”]/cbc:ID + “ – “ + cac:AdditionalDocumentReference[cbc:DocumentType=”Reqpt Name”]/cbc:ID cac:Delivery/cac:DeliveryParty/cac:PartyName/cbc:Name
cac:Delivery/cac:DeliveryLocation/cac:Address/cbc:StreetName cac:Delivery/cac:DeliveryLocation/cac:Address/cbc:AdditionalStre etName cac:Delivery/cac:DeliveryLocation/cac:Address/cbc:CityName + “, “ + cac:Delivery/cac:DeliveryLocation/cac:Address/cbc:CountrySubent ity cac:Delivery/cac:DeliveryLocation/cac:Address/cbc:PostalZone
Stock Label for non ASN deliveries cbc:OrderTypeCode = 105
Labe PEPPOL Order Field PEPPOL Order Field - - Left Right
cac:Delivery/cac:DeliveryParty/cac:PartyName/cbc:Name
cac:OrderLine/cac:LineItem/cac:Item/cbc:Name cac:OrderLine/cac:LineIte cac:OrderLine/cac:LineItem/cac:Ite m/ m cac:Item/cbc:Description /cbc:Name
cac:Delivery/cac:RequestedDeliveryPeriod/cbc:StartDate
cbc:ID
System must determine cbc:ID number of parcels
Page 143 of 143 v3.61