XHE-1.0-CSD03
XHE 1.0 CSD03 Business Entity Summary
1.0
oasis:cefact:xhe:BIE
oasis:cefact:xhe:BIE:1.0
http://docs.oasis-open.org/bdxr/xhe/v1.0/csd03/mod/XHE-Entities-1.0.gc
OASIS Business Document Exchange (BDXR) TC
BDXR
ModelName
Model Name
ComponentName
Component Name
CEFACTDictionaryEntryName
CEFACT Dictionary Entry Name
DictionaryEntryName
Dictionary Entry Name
Cardinality
Cardinality
ObjectClassQualifier
Object Class Qualifier
ObjectClass
Object Class
PropertyTermQualifier
Property Term Qualifier
PropertyTermPossessiveNoun
Property Term Possessive Noun
PropertyTermPrimaryNoun
Property Term Primary Noun
PropertyTerm
Property Term
RepresentationTerm
Representation Term
DataTypeQualifier
Data Type Qualifier
DataType
Data Type
AssociatedObjectClassQualifier
Associated Object Class Qualifier
AssociatedObjectClass
Associated Object Class
AlternativeBusinessTerms
Alternative Business Terms
ComponentType
Component Type
Definition
Definition
CurrentVersion
Current Version
Examples
Examples
EditorsNotes
Editor's Notes
Key
ExchangeHeaderEnvelope
XHE
XHE_ Envelope. Details
XHE. Details
XHE
ABIE
The Exchange Header Envelope
1.0
ExchangeHeaderEnvelope
XHEVersionID
XHE_ Envelope. Version. Identifier
XHE. XHE Version Identifier. Identifier
1
XHE
XHE Version
Identifier
XHE Version Identifier
Identifier
Identifier. Type
BBIE
The version of the specific envelope model in use.
1.0
ExchangeHeaderEnvelope
CustomizationID
XHE_ Envelope. Customization. Identifier
XHE. Customization Identifier. Identifier
0..1
XHE
Customization
Identifier
Customization Identifier
Identifier
Identifier. Type
BBIE
The identification of a customization or use of the envelope model.
1.0
ExchangeHeaderEnvelope
ProfileID
XHE_ Envelope. Profile. Identifier
XHE. Profile Identifier. Identifier
0..1
XHE
Profile
Identifier
Profile Identifier
Identifier
Identifier. Type
BBIE
The identification of a specific profile found within the customization.
1.0
ExchangeHeaderEnvelope
ProfileExecutionID
XHE_ Envelope. Profile Execution. Identifier
XHE. Profile Execution Identifier. Identifier
0..1
XHE
Profile Execution
Identifier
Profile Execution Identifier
Identifier
Identifier. Type
BBIE
The identification of a particular instance of using the given profile.
1.0
ExchangeHeaderEnvelope
Header
XHE_ Envelope. Metadata. XHE_ Document
XHE. Header
1
XHE
Header
Header
Header
ASBIE
Information relevant to the header/envelope itself, independent of the information it contains or references.
1.0
ExchangeHeaderEnvelope
Payloads
XHE_ Envelope. Included. XHE_ Payload
XHE. Payloads
0..1
XHE
Payloads
Payloads
Payloads
ASBIE
The set of payloads.
1.0
XHE-CommonLibrary-1.0
BusinessScope
XHE_ Context. Details
Business Scope. Details
Business Scope
ABIE
Documentation of the scope of business or other contextual details useful to understand the purpose of the envelope and its contents.
1.0
XHE-CommonLibrary-1.0
BusinessScopeCriterion
XHE_ Context. Specified. XHE_ Parameter
Business Scope. Business Scope Criterion
0..n
Business Scope
Business Scope Criterion
Business Scope Criterion
Business Scope Criterion
ASBIE
Internal specification of the scope and/or context of business.
1.0
XHE-CommonLibrary-1.0
ExternalReference
XHE_ Context. Scope. XHE_ Reference
Business Scope. External Reference
0..n
Business Scope
External Reference
External Reference
External Reference
ASBIE
External documentation of the scope and/or context of business.
1.0
XHE-CommonLibrary-1.0
BusinessScopeCriterion
XHE_ Parameter. Details
Business Scope Criterion. Details
Business Scope Criterion
ABIE
Documentation of one aspect of the scope of business or other contextual detail useful to understand the purpose of the envelope and its contents.
1.0
XHE-CommonLibrary-1.0
BusinessScopeCriterionTypeCode
XHE_ Parameter. Type. Code
Business Scope Criterion. Business Scope Criterion Type. Code
1
Business Scope Criterion
Business Scope Criterion
Type
Business Scope Criterion Type
Code
Code. Type
BBIE
Identifies the property of the scope by a code.
1.0
XHE-CommonLibrary-1.0
BusinessScopeCriterionValue
XHE_ Parameter. Value. Text
Business Scope Criterion. Business Scope Criterion Value. Text
1
Business Scope Criterion
Business Scope Criterion
Value
Business Scope Criterion Value
Text
Text. Type
BBIE
Specifies the value of the given property.
1.0
XHE-CommonLibrary-1.0
ExternalReference
XHE_ Reference. Details
External Reference. Details
External Reference
ABIE
A reference to a business case, document or other issues which are relevant to the handling of the envelope.
1.0
XHE-CommonLibrary-1.0
ID
XHE_ Reference. Identification. Identifier
External Reference. Identifier
1
External Reference
Identifier
Identifier
Identifier
Identifier. Type
BBIE
Identifies the referenced object by some identifier or URI.
1.0
XHE-CommonLibrary-1.0
AvailabilityStartDateTime
XHE_ Reference. Start_ Availability. Date Time
External Reference. Availability Start Date Time. Date Time
0..1
External Reference
Availability Start
Date Time
Availability Start Date Time
Date Time
Date Time. Type
BBIE
The start date and time when the information is available
1.0
XHE-CommonLibrary-1.0
AvailabilityEndDateTime
XHE_ Reference. End_ Availability. Date Time
External Reference. Availability End Date Time. Date Time
0..1
External Reference
Availability End
Date Time
Availability End Date Time
Date Time
Date Time. Type
BBIE
The end date and time when the information is available
1.0
XHE-CommonLibrary-1.0
Login
XHE_ Reference. Login. Text
External Reference. Login. Text
0..1
External Reference
Login
Login
Text
Text. Type
BBIE
Text describing any login details to access the information.
1.0
XHE-CommonLibrary-1.0
Password
XHE_ Reference. Password. Text
External Reference. Password. Text
0..1
External Reference
Password
Password
Text
Text. Type
BBIE
A password needed to access the information.
1.0
XHE-CommonLibrary-1.0
Header
XHE_ Document. Details
Header. Details
Header
ABIE
Information relevant to the header/envelope itself, independent of the information it contains or references.
1.0
XHE-CommonLibrary-1.0
ID
XHE_ Document. Identification. Identifier
Header. Identifier
1
Header
Identifier
Identifier
Identifier
Identifier. Type
BBIE
Unique ID of the envelope for tracking purposes.
1.0
XHE-CommonLibrary-1.0
UUID
XHE_ Document. UUID. Identifier
Header. UUID. Identifier
0..1
Header
UUID
UUID
Identifier
Identifier. Type
BBIE
An additional identifier of the envelope.
1.0
XHE-CommonLibrary-1.0
CreationDateTime
XHE_ Document. Creation. Date Time
Header. Creation Date Time. Date Time
1
Header
Creation
Date Time
Creation Date Time
Date Time
Date Time. Type
BBIE
Date and time when the envelope was created.
1.0
XHE-CommonLibrary-1.0
BusinessScope
XHE_ Document. Scope. XHE_ Context
Header. Business Scope
0..1
Header
Business Scope
Business Scope
Business Scope
ASBIE
Documentation of the scope of business or other contextual details useful to understand the purpose of the envelope and its contents.
1.0
Europe vs Asia, Direct-to-Consumer vs Replenishment, or Prepaid vs Credit.
XHE-CommonLibrary-1.0
FromParty
XHE_ Document. Sender. XHE_ Party
Header. From_ Party. Party
0..1
Header
From
Party
Party
Party
ASBIE
Information about the party that originated the envelope.
1.0
XHE-CommonLibrary-1.0
ToParty
XHE_ Document. Recipient. XHE_ Party
Header. To_ Party. Party
1..n
Header
To
Party
Party
Party
ASBIE
Information about the parties to receive the envelope.
1.0
XHE-CommonLibrary-1.0
Party
XHE_ Party. Details
Party. Details
Party
ABIE
The information about a party.
1.0
XHE-CommonLibrary-1.0
PartyIdentification
XHE_ Party. Specified. XHE_ Identity
Party. Party Identification
1..n
Party
Party Identification
Party Identification
Party Identification
ASBIE
Unambiguous identifications of a party.
1.0
XHE-CommonLibrary-1.0
PartyIdentification
XHE_ Identity. Details
Party Identification. Details
Party Identification
ABIE
The information about a party's identification.
1.0
XHE-CommonLibrary-1.0
ID
XHE_ Identity. Identification. Identifier
Party Identification. Identifier
1
Party Identification
Identifier
Identifier
Identifier
Identifier. Type
BBIE
An unambiguous identification of a party.
1.0
XHE-CommonLibrary-1.0
Payload
XHE_ Payload Instance. Details
Payload. Details
Payload
ABIE
The actual payload instance, such as a single invoice, conveyed within the envelope.
1.0
XHE-CommonLibrary-1.0
ID
XHE_ Payload Instance. Identification. Identifier
Payload. Identifier
0..1
Payload
Identifier
Identifier
Identifier
Identifier. Type
BBIE
A unique identification of this payload instance contained within the envelope.
1.0
XHE-CommonLibrary-1.0
Description
XHE_ Payload Instance. Description. Text
Payload. Description. Text
0..n
Payload
Description
Description
Text
Text. Type
BBIE
Text description of the payload instance.
1.0
XHE-CommonLibrary-1.0
DocumentTypeCode
XHE_ Payload Instance. Document_ Type. Code
Payload. Document Type Code. Code
0..1
Payload
Document Type
Code
Document Type Code
Code
Code. Type
BBIE
Identifies the abstract archetype of the payload instance.
1.0
XHE-CommonLibrary-1.0
ContentTypeCode
XHE_ Payload Instance. Content_ Type. Code
Payload. Content Type Code. Code
0..1
Payload
Content Type
Code
Content Type Code
Code
Code. Type
BBIE
Identifies the file format or octet representation of the payload instance.
1.0
XHE-CommonLibrary-1.0
CustomizationID
XHE_ Payload Instance. Customization. Identifier
Payload. Customization Identifier. Identifier
0..1
Payload
Customization
Identifier
Customization Identifier
Identifier
Identifier. Type
BBIE
Identifies the customization that applies to the payload instance.
1.0
XHE-CommonLibrary-1.0
ProfileID
XHE_ Payload Instance. Profile. Identifier
Payload. Profile Identifier. Identifier
0..1
Payload
Profile
Identifier
Profile Identifier
Identifier
Identifier. Type
BBIE
Identifies the profile that the payload instance is part of.
1.0
XHE-CommonLibrary-1.0
ProfileExecutionID
XHE_ Payload Instance. Profile Execution. Identifier
Payload. Profile Execution Identifier. Identifier
0..1
Payload
Profile Execution
Identifier
Profile Execution Identifier
Identifier
Identifier. Type
BBIE
Identifies the particular instance of an executing profile that the payload instance is part of.
1.0
XHE-CommonLibrary-1.0
HandlingServiceID
XHE_ Payload Instance. Handling Service. Identifier
Payload. Handling Service Identifier. Identifier
0..1
Payload
Handling Service
Identifier
Handling Service Identifier
Identifier
Identifier. Type
BBIE
Identifies the service that should process the payload instance.
1.0
XHE-CommonLibrary-1.0
ValidationTypeCode
XHE_ Payload Instance. Validation_ Type. Code
Payload. Validation Type Code. Code
0..1
Payload
Validation Type
Code
Validation Type Code
Code
Code. Type
BBIE
The type of the payload instance, used for the task of verifying that the grammar is valid.
1.0
XHE-CommonLibrary-1.0
ValidationVersionID
XHE_ Payload Instance. Validation Version. Identifier
Payload. Validation Version Identifier. Identifier
0..1
Payload
Validation Version
Identifier
Validation Version Identifier
Identifier
Identifier. Type
BBIE
Descriptor containing version information of the validation type.
1.0
XHE-CommonLibrary-1.0
InstanceEncryptionIndicator
XHE_ Payload Instance. Encrypted. Indicator
Payload. Instance Encryption Indicator. Indicator
1
Payload
Instance Encryption
Indicator
Instance Encryption Indicator
Indicator
Indicator. Type
BBIE
Indicator stating whether the payload instance is encrypted or not.
1.0
XHE-CommonLibrary-1.0
InstanceEncryptionMethod
XHE_ Payload Instance. Encryption Method. Text
Payload. Instance Encryption Method. Text
0..1
Payload
Instance Encryption
Method
Instance Encryption Method
Text
Text. Type
BBIE
Method used to encrypt the payload instance.
1.0
XHE-CommonLibrary-1.0
InstanceHashValue
XHE_ Payload Instance. Encryption Hash Value. Text
Payload. Instance Hash Value. Text
0..1
Payload
Instance Hash
Value
Instance Hash Value
Text
Text. Type
BBIE
SHA-256 hash total of the unencrypted payload instance.
1.0
XHE-CommonLibrary-1.0
InstanceDecryptionInformationExternalReference
XHE_ Payload Instance. Decryption. XHE_ Reference
Payload. Instance Decryption Information_ External Reference. External Reference
0..1
Payload
Instance Decryption Information
External Reference
External Reference
External Reference
ASBIE
Decryption information that is available external to the envelope.
1.0
XHE-CommonLibrary-1.0
InstanceDecryptionKeyExternalReference
XHE_ Payload Instance. Decryption Key. XHE_ Reference
Payload. Instance Decryption Key_ External Reference. External Reference
0..1
Payload
Instance Decryption Key
External Reference
External Reference
External Reference
ASBIE
Decryption key data that is available external to the envelope.
1.0
XHE-CommonLibrary-1.0
RelevantExternalReference
XHE_ Payload Instance. Relevant. XHE_ Reference
Payload. Relevant_ External Reference. External Reference
0..n
Payload
Relevant
External Reference
External Reference
External Reference
ASBIE
A reference to a business case, document or other issues which are relevant to the handling of the payload.
1.0
XHE-CommonLibrary-1.0
PayloadExternalReference
XHE_ Payload Instance. Payload. XHE_ Reference
Payload. Payload_ External Reference. External Reference
0..1
Payload
Payload
External Reference
External Reference
External Reference
ASBIE
The reference to the payload when it is not included within the envelope.
1.0
XHE-CommonLibrary-1.0
Payloads
XHE_ Payload. Details
Payloads. Details
Payloads
ABIE
The complete set of payloads.
1.0
XHE-CommonLibrary-1.0
Payload
XHE_ Payload. Included. XHE_ Payload Instance
Payloads. Payload
1..n
Payloads
Payload
Payload
Payload
ASBIE
An individual payload within the set of payloads.
1.0