HazardousMaterialShipmentDocumentHeader

Provides general information about the document that is used to transport a specific quantity of material goods from a supplier to a single customer business partner destination.

Element information

Content

• Sequence [1..1]
  from type DocumentIdentificationBaseType
  ID [0..1]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  RevisionID [0..1]    Is the revision of the semantically named document. The combination of the ID and its revision uniquely identifies the associated entity.
  VariationID [0..1]    
  DocumentIDSet [0..*]    
  from type HeaderBaseType
  LastModificationDateTime [0..1]    The datetime on which the object was last modified
  DocumentDateTime [0..1]    The date that document was created within the system of record.
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  from group ReferencesGroup
  DocumentReference [0..*]    
  Attachment [0..*]    The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
  from type StatusHeaderBaseType
  Status [0..*]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  from type HazardousMaterialShipmentDocumentHeaderBaseType
  ContainerQuantity [0..1]    A numeric expression of the number of outer containers for product shipping.
  Port [0..1]    Specifies details for a specific logistical location
  ActualShipDate [0..1]    
  GrossWeightMeasure [0..1]    Gross weight of the associated entity. The total weight of the entity without reduction of packaging or container. I.e The Gross wieght of a pallet of goods includes the weight of the pallet.
  TotalVolumeMeasure [0..1]    Quantifies the volume, or amount of space, that is occupied by an item, container or shipment.
  IntraCompanyTransferIndicator [0..1]    
  ShippingRoute [0..*]    Specifies details for a logistical segment of a transport process
  ShipFromParty [0..1]    Identifies the party that the goods or services are being shipped or sent from.
  ShipToParty [0..1]    Identifies the ShipToParty for the document or the line. In a lot of cases, this is the same as the CustomerParty. In multi-organization purchasing, the CustomerParty may be different from the BuyerParty
  ShipperParty [0..1]    
  DeclarantParty [0..1]    
  TransportID [0..1]    
  EmergencyContact [0..1]    
  Event [0..*]    Specifies details about a specific occurrence in time
  1. Extension [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.

Attributes

None

Used in

• Type HazardousMaterialShipmentDocumentType (Element HazardousMaterialShipmentDocument)

Sample instance

<HazardousMaterialShipmentDocumentHeader>
   <ID/>
   <RevisionID>normalizedString</RevisionID>
   <VariationID>normalizedString</VariationID>
   <DocumentIDSet>
      <ID/>
   </DocumentIDSet>
   <LastModificationDateTime></LastModificationDateTime>
   <DocumentDateTime></DocumentDateTime>
   <Description/>
   <Note/>
   <DocumentReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </DocumentReference>
   <Attachment>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <EmbeddedDataBinaryObject/>
      <URI>normalizedString</URI>
      <ISBN>normalizedString</ISBN>
      <FileName/>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <FileTypeCode>normalizedString</FileTypeCode>
      <FileSizeQuantity>1.0</FileSizeQuantity>
      <Title/>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Attachment>
   <Status>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Code/>
      <Description/>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason/>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </EffectiveTimePeriod>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Status>
   <ContainerQuantity>1.0</ContainerQuantity>
   <Port>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Description/>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Port>
   <ActualShipDate></ActualShipDate>
   <GrossWeightMeasure>1.0</GrossWeightMeasure>
   <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
   <IntraCompanyTransferIndicator>true</IntraCompanyTransferIndicator>
   <ShippingRoute>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <ShippingTrackingID>normalizedString</ShippingTrackingID>
      <PaymentBasisCode>token</PaymentBasisCode>
      <TransportationMethodCode>normalizedString</TransportationMethodCode>
      <SpecialHandlingNote/>
      <ForwardingAgentParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID>
         <BranchParty>...
         </BranchParty>
         <FinancialAccount>...
         </FinancialAccount>
         <CountryCode>token</CountryCode>
         <Extension>.......................................
         </Extension>
      </ForwardingAgentParty>
      <CarrierParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </CarrierParty>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ShippingRoute>
   <ShipFromParty>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ShipFromParty>
   <ShipToParty>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <AppointmentRequiredIndicator>true</AppointmentRequiredIndicator>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ShipToParty>
   <ShipperParty>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ShipperParty>
   <DeclarantParty>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </DeclarantParty>
   <TransportID>normalizedString</TransportID>
   <EmergencyContact>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <PersonName>
         <ID/>
         <IDSet>...
         </IDSet>
         <FormattedName/>
         <PreferredName/>
         <GivenName/>
         <MiddleName/>
         <FamilyName/>
         <TitleAffixCode>normalizedString</TitleAffixCode>
         <PreferredSalutationCode>normalizedString</PreferredSalutationCode>
         <GenerationAffixCode>normalizedString</GenerationAffixCode>
         <QualificationAffixCode>normalizedString</QualificationAffixCode>
         <Initials/>
         <Usage>...
         </Usage>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </PersonName>
      <RoleCode>normalizedString</RoleCode>
      <JobTitle/>
      <Responsibility/>
      <OrganizationUnitID>normalizedString</OrganizationUnitID>
      <Communication>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <ChannelCode>normalizedString</ChannelCode>
         <UseCode>normalizedString</UseCode>
         <CountryDialingCode>normalizedString</CountryDialingCode>
         <AreaDialingCode>normalizedString</AreaDialingCode>
         <DialNumber/>
         <PhoneExtension/>
         <Access/>
         <Address>...
         </Address>
         <URI>normalizedString</URI>
         <HTMLPreferredIndicator>true</HTMLPreferredIndicator>
         <Text/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Preference>...
         </Preference>
         <Extension>.......................................
         </Extension>
      </Communication>
      <TelephoneCommunication>
         <ID/>
         <IDSet>...
         </IDSet>
         <ChannelCode>normalizedString</ChannelCode>
         <CountryDialingCode>normalizedString</CountryDialingCode>
         <AreaDialingCode>normalizedString</AreaDialingCode>
         <DialNumber/>
         <PhoneExtension/>
         <Access/>
         <FormattedNumber/>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Usage>...
         </Usage>
         <Extension>.......................................
         </Extension>
      </TelephoneCommunication>
      <EMailAddressCommunication>
         <ID/>
         <IDSet>...
         </IDSet>
         <UseCode>normalizedString</UseCode>
         <EMailAddressID>normalizedString</EMailAddressID>
         <HTMLPreferredIndicator>true</HTMLPreferredIndicator>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </EMailAddressCommunication>
      <InternetAddressCommunication>
         <ID/>
         <IDSet>...
         </IDSet>
         <UseCode>normalizedString</UseCode>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </InternetAddressCommunication>
      <Preference>
         <ID/>
         <IDSet>...
         </IDSet>
         <PrioritySequenceValue>1</PrioritySequenceValue>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <UnavailableTimePeriod>..................
         </UnavailableTimePeriod>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </Preference>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </EffectiveTimePeriod>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </EmergencyContact>
   <Event>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <StartDateTime></StartDateTime>
      <Duration>P1Y2M3DT10H</Duration>
      <EndDateTime></EndDateTime>
      <Description/>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Event>
   <Extension>
      <AnyExtension>
         <!--any element-->
      </AnyExtension>
      <Amount/>
      <Code/>
      <DateTime></DateTime>
      <ID/>
      <Indicator>true</Indicator>
      <Measure/>
      <Name/>
      <Number>1.0</Number>
      <Quantity/>
      <Text/>
      <Time></Time>
      <ValueText>string</ValueText>
   </Extension>
</HazardousMaterialShipmentDocumentHeader>