Deactivate Event Guidelines (EPCIS v1.2)

See How To Use this Guide before interpreting the guidelines below.

Message Type: SOM_DEACTIVATE_EVENT

Info Exchange Display Name: Deactivate Event

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1…1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. *1
  @creationDate [1…1]
[1/*]		 DateTime Required. The date the message created in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ. *2
  EPCISHeader [0…1]
[-]		 - Required. XML file control header record.
    sbdh:StandardBusinessDocumentHeader [1…1]
[-]		 - Required. This element contains business header information including EPCIS Header Version, Sender, and Receiver information along with the document identification.
      sbdh:HeaderVersion [1…1]
[0/*]		 String Required. The version number of the SBDH standard used. The sbdh:HeaderVersion value must be set to 1.0. *3
      sbdh:Sender [1…*]
[-]		 - Required. A unique identification key for the Sender party of the message, representing the organization which created the standard business document. The sbdh:Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The value of the sbdh:Identifier element may be a GLN, SGLN, or any other supported business party type. *4

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have a urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.

          @Authority [1…1]
[1/*]		 String Required. The Authority was previously expected to be set to GLN for GS1 XML messages. Update made in December 2016 changed this to take additional values. *5

See the MDPartyTypeEnums enumeration list for valid values.

      sbdh:Receiver [1…*]
[-]		 - Required. A unique identification key for the direct Receiver party of the message, representing the organization which receives the standard business document. The sbdh:Receiver element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The value of the sbdh:Identifier element may be a GLN, SGLN, or any other supported business party type. *6

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have a urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.

          @Authority [1…1]
[1/*]		 String Required. The Authority was previously expected to be set to GLN for GS1 XML messages. Update made in December 2016 changed this to take additional values. *7

See the MDPartyTypeEnums enumeration list for valid values.

      sbdh:DocumentIdentification [1…1]
[-]		   Required. Message identification group.
        sbdh:Standard [1…1]
[0/*]		 String Required. The name of the document standard contained in the payload. The sbdh:Standard value must be set to EPCglobal. *8
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. The version of the document included in the payload of SBDH. This is the "complete" version of the document itself and is different than the sbdh:HeaderVersion. The sbdh:TypeVersion value must be set to 1.0. *9
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. Description containing reference information to uniquely identify this instance of the Standard Business Document between the Sender and the Receiver. This identifier identifies this document as being distinct from others. *10
        sbdh:Type [1…1]
[0/*]		 String Required. The type of the document. The sbdh:Type value must be set to Events. *11
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime Required. Date and time of the SBDH document creation in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ. *12
    extension [0…1]
[-]		 - Header extension area with master data attributes.
      EPCISMasterData [0…1]
[-]		 - Master data extension header. May contain location address information for deactivating events. Location master data = urn:epcglobal:epcis:vtype:Location.
Full GS1 conformance requires that all party master data be stored in the EPCIS header extension EPCISMasterData | VocabularyList | Vocabulary | VocabularyElementList | VocabularyElement. It is strongly urged that all party address info for deactivating events be sent in the VocabularyElement within the EPCISMasterData header extension.
        VocabularyList [1…1]
[-]		 - Required. Vocabulary list group master data elements.
          Vocabulary [0…*]
[-]		 - Looping vocabulary element with discrete location address master data element groups for deactivating events. Vocabulary occurs only once for all location address information present in the message, if the group is populated.

Group is optional. If it does not appear in the master data header extension, no error will be thrown.
            @type [1…1]
[0/*]		 String Required. Vocabulary type identifying location master data elements for deactivating events. Master data type defined by VocabularyElement | @id.

Valid value: urn:epcglobal:epcis:vtype:Location = location master data.

Location address info for deactivating events should be sent in header master data.
            VocabularyElementList [0…1]
[-]		 - List of vocabulary elements that includes all location master information for deactivating events. Location party identifiers and address info are stored in instances of the looping group VocabularyElement.
              VocabularyElement [1…*]
[-]		 - Required. Looping group header for data elements that identify all location master data, including identifiers, identifier types, and address info.
VocabularyElement occurs once for each unique location identifier and address across all deactivating events:
  • Deactivate event: Location party (optional).
  • If party address info is added to Vocabulary element in the message header, create only one instance of VocabularyElement for each unique location across all deactivating events, if present.
  • Master data lookup is also supported for deactivating events, from the readPoint | id if the VocabularyElement is not populated with location address.
  • If master data lookup is not intended, send complete address information for the location of the deactivating event.
                @id [1…1]
[0/*]		 String Required. SGLN or other partner identifier and type for party master data in VocabularyElement. Must match readPoint | id in deactivating events from ObjectEvent | readPoint | id where bizStep = http://epcis.tracelink.com/bizstep/deactivating.

The identifier value is required for regulatory reporting. The identifier type must include a valid urn or http string prefix. GLN is not supported, only SGLN. Valid prefix formats by namespace:

  • GS1: urn:epc:id:sgln:[CompanyPrefix].[LocationReference].[Extension]
  • GS1 USHC: http://epcis.gs1us.org/hc/[identifierType]/loc/[identificationValue]
  • GS1 Brazil: http://epcis.gs1br.org/hc/[identifierType]/loc/[identificationValue]
  • TraceLink: http://epcis.tracelink.com/hc/[identifierType]/loc/[identificationValue]
Different countries require different values:
  • Argentina: Provide both the SGLN and the CUIT number associated with the sold from party.
  • For company's physically located in Brazil: Provide the BR_CNPJ number associated with the sold from party.
  • China: Provide the company identifier registered with China SFDA used to identify the sold from party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • Turkey: Provide the SGLN associated with the sold from party.
  • US: Provide a SGLN, DEA, or HIN identifier associated with the sold from party.

The following types are supported in the US:

  • urn:epc:id:sgln: = SGLN (Serialized Global Location Number).
  • http://epcis.tracelink.com/hc/companyId/loc/ = Company Id in Internal ERP System.
  • http://epcis.tracelink.com/hc/company-site-id/loc/ = Internal Location or Site Id in Internal ERP System.
  • http://epcis.gs1us.org/hc/dea/loc/ = DEA (Drug Enforcement Agency Number).
  • http://epcis.gs1us.org/hc/duns/loc/ = DUNS (Dun & Bradstreet Number).
  • http://epcis.gs1us.org/hc/duns_plus_four/loc/ = DUNS4 (Dun & Bradstreet Number + 4 digit location code).
  • http://epcis.gs1us.org/hc/hin/loc/ = HIN (Health Industry Number partner address ID).

See the MDPartyTypeAttributes enumeration list for valid values.

                attribute(1) [0…*]
[0/*]		 String Conditionally required if attribute(2) is present. Looping Name/Value pairs identifying partner address master data elements. This is the value element in the Name/Value pair attribute | @id. Stores master data item value defined by @id. Create one instance of the Name/Value pair attribute and @id for each master data element returned.
Partner master data items currently supported:
  • Business name - mandatory if the address is populated in VocabularyElement.
  • Business classification - optional.
  • Street address 1 - mandatory if the address is populated.
  • Street address 2 - optional.
  • City - mandatory if the address is populated.
  • District - optional, mandatory for India.
  • State/Province/Region - mandatory if the address is populated.
  • Postal code - optional.
  • Country code - mandatory if the address is populated.
                  @id [1…1]
[0/*]		 String Conditionally required if attribute(1) is populated. The name in the Name/Value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix.

Valid values:

  • http://epcis.tracelink.com/mda/AddressObjectGUID
  • http://epcis.tracelink.com/mda/district
  • http://epcis.tracelink.com/mda/HouseGUID
  • http://epcis.tracelink.com/mda/partyRoleCode
  • urn:epcglobal:cbv:mda#name
  • urn:epcglobal:cbv:mda#streetAddressOne
  • urn:epcglobal:cbv:mda#streetAddressTwo
  • urn:epcglobal:cbv:mda#streetAddressThree
  • urn:epcglobal:cbv:mda#city
  • urn:epcglobal:cbv:mda#state
  • urn:epcglobal:cbv:mda#postalCode
  • urn:epcglobal:cbv:mda#countryCode
                attribute(2) [0…*]
[0/*]		 String Conditionally required if attribute(1) is present. Looping Name/Value pairs identifying additional party identifier elements. This is the value element in the Name/Value pair attribute | @id. Stores additional party identifiers and identifier types defined by @id.

Partner master data items currently supported:

  • Additional party identifier - Optional (1 or more supported).
  • Additional party identifier type - Optional (1 or more supported).

Create one instance of the Name/Value pair attribute and @id for each master data element returned.

Additional party identifiers must be sent in a double attribute combination. The sequence must be:

  • Attribute 1 identifies and provides the party identifier value.
  • Attribute 2 identifies the party identifier type.

For example:

  • <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationValue">10023141</attribute>
  • <attribute id="http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode">DUNS_PLUS_FOUR</attribute>
If this sequence of double attributes is not followed for additional party identifiers, the additional party identifier will not be mapped to the TraceLink system and no error will be thrown.
Only one of the following values may be used per message:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the BusinessAndLocationId enumeration list for valid values.

                  @id [1…1]
[0/*]		 String Conditionally required if attribute(2) is populated. The name in the Name/Value pair attribute | @id. Identifies the master data value stored in the attribute value element, using urn or http prefix.

Valid values:

  • http://epcis.tracelink.com/mda/additionalPartyIdentificationValue
  • http://epcis.tracelink.com/mda/additionalPartyIdentificationTypeCode
  EPCISBody [1…1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1…1]
[-]		 - Required. The ObjectEvent Deactivate is the only event expected in the EventList.
      ObjectEvent [1…*]
[-]		 - Required. ObjectEvent recording deactivating events.

EventList = ObjectEvent Deactivate when all of the following is true:

  • action = DELETE
  • bizStep = http://epcis.tracelink.com/bizstep/deactivating
  • disposition = http://epcis.tracelink.com/disp/deactivated
        eventTime [1…1]
[1/*]		 DateTime Required. Timestamp of date/time when the event occurred in XML datetime format YYYY-MM-DDTHH:MM:SS.mmZ. *13
        recordTime [0…1]
[0/*]		 DateTime Not used.
        eventTimeZoneOffset [1…1]
[1/*]		 String Required. Time zone offset in effect at the time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *14
        epcList [1…1]
[-]		 - Required. The EPCs of each item, case, and/or pallet destroyed.
          epc [1…*]
[1/*]		 String Required. The EPC identifier in EPC Pure Identity URI format. See EPC Pure Identifier Format Examples. *15
        action [1…1]
[0/*]		 String Required. The action value must be set to DELETE. *16
        bizStep [0…1]
[0/*]		 AnyURI Required. The bizStep value must be set to http://epcis.tracelink.com/bizstep/deactivating. *17
        disposition [0…1]
[0/*]		 AnyURI Required. The disposition value must be set to http://epcis.tracelink.com/disp/deactivated. *18
        readPoint [1…1]
[-]		 - Required. Location where the event occurred.
          id [1…1]
[0/*]		 AnyURI Required. The SGLN EPC of the location where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. *19
        bizLocation [1…1]
[-]		 - The location where the event occurred.
          id [1…1]
[1/*]		 AnyURI The SGLN EPC of the location where the event occurred. This may be a site-level SGLN, or a finer-grain location identifier. Omitted for destroying event.
        bizTransactionList [0…1]
[-]		 - Not used.
        locationId [0…1]
[0/*]		 String Serialized Operations Manager External Partner Location identifier. Not mapped.
          @type [0…1]
[0/*]		 String The location types.
        tl:deactivateEventExtensions [1…1]
[-]		 - Required. Extensions used for Deactivate ObjectEvent.
          tl:transactionDate [0…1]
[0/*]		 date Date associated with the business transaction document in bizTransactionList in XML date format YYYY-MM-DD. This date may or may not be the same as the eventTime. *20
          tl:marketCountryCode [0…1]
[0/2]		 String Market country code. *21
          tl:businessPartyInfo [0…1]
[-]		 - The full business information associated with the business entity that destroyed the serial numbers. The group is optional but if present the required fields within the group must be populated.
            tl:businessId [1…*]
[1/*]		 String Required. The identifier associated with the sold from or transfer from business entity. This value is mandatory for regulatory reporting. Different countries require different values as noted below. *22
Country Requirement:
  • Argentina: Provide both the SGLN and the CUIT number associated with the sold from party.
  • For company's physically located in Brazil: Provide the BR_CNPJ number associated with the sold from party.
  • China: Provide the company identifier registered with China SFDA used to identify the sold from party. This is the identifier provided in the China SFDA application master data and must match up. Use the appropriate qualifier code to identify this value.
  • Turkey: Provide the SGLN associated with the sold from party.
  • US: Provide a SGLN, DEA, or HIN identifier associated with the sold from party.
              @type [1…1]
[1/*]		 String Required. The type of the tl:businessId identifier. One of the supported enumerations must be provided. *23

See the BusinessAndLocationId enumeration list for valid values.

            tl:businessClassification [0…1]
[0/*]		 String Conditionally required for Argentina. The business classification of the sold from party using one of the provided enumerations. *24

See the BusinessClassification enumeration list for valid values.

            tl:BusinessPartyDetail [0…1]
[-]		 - The business name and address of the sold from or transfer from business entity. The group is optional but if present, the required fields within group must be populated.
              tl:businessName [1…1]
[1/*]		 String Required. The business name of the trading partner. *25
              tl:street1 [1…1]
[1/*]		 String Required. The first line of the street address. *26
              tl:street2 [0…1]
[0/*]		 String The second line of the street address. *27
              tl:city [1…1]
[1/*]		 String Required. The city. *28
              tl:district [0…1]
[0/*]		 String Conditionally required for India. District Code only for India. *29
Must be a 3-digit numeric code.
              tl:stateOrRegion [1…1]
[1/*]		 String Required. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *30
              tl:postalCode [0…1]
[1/*]		 String The ZIP or other postal code. *31
              tl:country [1…1]
[1/*]		 String Required. The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *32
          tl:warehouseOperatorName [0…1]
[0/*]		 String Name of the person responsible for warehouse operations. *33
          tl:decommissionReasonCode [0…1]
[0/*]		 String Reason for deactivating serial numbers. *34
Country Requirements:
  • Turkey
  • Brazil

See the DecommissionReasonCode enumeration list for valid values.

          tl:reasonDescription [0…1]
[0/*]		 String Description for decommission reason code. *35