Supplier Person Contact (level 2)
3.4 /CandidateSupplier/PersonContact (level 2)¶
3.4.1 PersonContact Element Description¶
<img>A diagram showing the PersonContact element with its sub-elements: PersonContactType, Attributes, PersonName, and Communication.</img>
| Element | Description | Cardinality | Rule | Examples |
|---|---|---|---|---|
| PersonContact | A detailed set of data about one or more people who should be contacted in order to communicate with the supplier of the candidate | 1..n | N/A | N/A |
Sub-elements
| Element | Description | Cardinality | Rule | Examples |
|---|---|---|---|---|
| PersonName | Name of the contact of the supplier See section /CandidateSupplier/PersonContact/PersonName for more information |
1 | N/A | N/A |
| Communication | A detailed set of data about communication data of the supplier contact person See section /CandidateSupplier/PersonContact/Communication for more information |
1..n | BR-COM-10: If the Communication element is filled in, at least one of its sub elements should be filled in too. | N/A |
3.4.2 PersonContact Attributes¶
<img>A diagram showing the PersonContact element with its sub-element: PersonContactType, which includes Attributes and contactTypeCode.</img>
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| contactTypeCode | The person's type of contact, such as "CompanyManager" or "WorkplaceContact" This is a free text element. |
0..1 | N/A |
PersonName attributes
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| See section /CandidateSupplier/PersonContact/PersonName for more information | |||
Communication attributes
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| See section /CandidateSupplier/PersonContact/Communication for more information | |||
3.4.3 Sub-element: /CandidateSupplier/PersonContact/PersonName (level 3)¶
3.4.3.1 PersonName Element Description¶
<img>UML Diagram showing PersonNameType, PersonNameBaseType (extension base), FormattedName, LegalName, GivenName, FamilyName, Attributes, and their descriptions.</img>
| Element | Description | Cardinality | Rule | Example |
|---|---|---|---|---|
| PersonName | Name of the contact of the supplier | 1 | N/A | N/A |
| Sub-elements | ||||
| FormattedName | This is a formatted presentation of a name (for example, a Person Name) that might alternatively be presented
as discretely fielded components, or it could be a name with alternative formatted representations. The formatCode is an optional available attribute for specifying the applicable "mask" or type of format presentation to which the content conforms. |
0..1 | N/A | "Paula Cook", "James Black", etc. |
| LegalName | The name that an individual is given at birth and/or is recognised by a government or other legal entity, or that appears on a birth certificate | 0..1 | N/A | "Paula Cook", "James Black", etc. |
| GivenName | A people given name or first name. | 1 | N/A | "Mark", "Silvia", etc. |
erDiagram
PersonNameType ||--o{ PersonName : "It contains name of the supplier contact person."
PersonNameType {
@ Attributes
@ scriptCode
It contains type of alphabet that the name is written with such as "Roman", "Kenji", etc.
@ hr:EffectiveDateAttributeGroup
@ validFrom
@ validTo
HR-XML's 3.0 architecture makes a distinction between effective-date meta data and effective dating that is an
integral...
@ nameTypeCode
A code classifying the type of name, such as "CurrentName" or "FormerName".
@ legalNameIndicator
Indicates whether or not the PersonName represents a "legal" or "official" name. Note that in some business contexts,
a...
}
3.4.3.2 PersonName Attributes¶
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| scriptCode | Type of alphabet that the name is written with such as “Roman”, “Kenji”, etc. | 0..1 | N/A |
| nameTypeCode | A code classifying the type of name, such as “CurrentName” or “FormerName” (full code list “4.28.21 Name
Enum-Type Codes [CL32]”) This is an HR-Open Standards open list. |
0..1 | BR-COM-09: Compulsory use of the Name Enum Type Codes [CL32]. |
| legalNameIndicator | Boolean indicating if it is the legal name or not | 0..1 | N/A |
| validFrom | Validity start date for this Person Name | 0..1 | BR-COM-06: Compulsory Date Format is: YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDThh:mm:ss. |
| validTo | Validity end date for this Person Name | 0..1 | BR-COM-06: Compulsory Date Format is: YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDThh:mm:ss. |
| LegalName attributes | |||
|---|---|---|---|
| Attributes | Description | Card. | Rule |
| formatCode | Type of format shown | 0..1 | N/A |
| languageID | Language in which the LegalName is mentioned | 0..1 | "en" |
| FormattedName attributes | |||
|---|---|---|---|
| Attributes | Description | Card. | Rule |
| The same as the "LegalName" attributes | |||
| GivenName attributes | |||
|---|---|---|---|
| Attributes | Description | Card. | Rule |
| Refer to NameType Attributes section for additional attributes. | |||
| FamilyName sub-element | |||
|---|---|---|---|
| Attributes | Description | Card. | Rule |
| primaryIndicator | Boolean indicating that it is a single name | 0..1 | N/A |
| sequence | Establishes the name order as an integer | 0..1 | N/A |
| prefix | A family name's prefix | 0..1 | N/A |
| languageID | Language in which the LegalName is mentioned | 0..1 | "en" |
3.4.4 Sub-element: /CandidateSupplier/PersonContact/Communication (level 3)¶
3.4.4.1 Communication Element Description¶
graph TD
A[CommunicationABlEType] --> B[Attributes]
B --> C[ChannelCode]
B --> D[UseCode]
B --> E[OtherTitle]
C --> F[ChannelCodeDesc]
D --> G[UseCodeDesc]
E --> H[OtherTitleDesc]
C --> I[CountryDialing]
C --> J[AreaDialing]
C --> K[DialNumber]
C --> L[CountryCode]
C --> M[Address]
C --> N[URI]
I --> O[CountryDialingDesc]
J --> P[AreaDialingDesc]
K --> Q[DialNumberDesc]
L --> R[CountryCodeDesc]
M --> S[AddressDesc]
N --> T[URIDesc]
subgraph CommunicationABlEType
A
end
subgraph Attributes
B
end
subgraph ChannelCode
C
end
subgraph ChannelCodeDesc
ChannelCodeDesc[The communication channel used to contact a person or an organization. (e.g. "Telephone",
"MobileTelephone", "Fax",...)]
end
subgraph UseCode
D
end
subgraph UseCodeDesc
UseCodeDesc[The type of use given to the communication channel used to contact a person or an organization.
(e.g."Personal"...)]
end
subgraph OtherTitle
E
end
subgraph OtherTitleDesc
OtherTitleDesc[It specifies the title of ChannelCode or UseCode when Other is chosen.]
end
subgraph CountryDialing
I
end
subgraph AreaDialing
J
end
subgraph DialNumber
K
end
subgraph DialNumberDesc
DialNumberDesc[The communication number, not including country dialing or area dialing codes.]
end
subgraph CountryCode
L
end
subgraph Address
M
end
subgraph AddressDesc
AddressDesc[Properties which specify the physical location of an entity.]
end
subgraph URI
N
end
subgraph URIDesc
URIDesc[Uniform Resource Identifier Reference (URI). A URI value can be absolute or relative, and may have an optional
fragment..]
end
style A fill:#f9f,stroke:#333,stroke-width:2px
style B fill:#f9f,stroke:#333,stroke-width:2px
style C fill:#f9f,stroke:#333,stroke-width:2px
style D fill:#f9f,stroke:#333,stroke-width:2px
style E fill:#f9f,stroke:#333,stroke-width:2px
style F fill:#fff,stroke:#333,stroke-width:2px
style G fill:#fff,stroke:#333,stroke-width:2px
style H fill:#fff,stroke:#333,stroke-width:2px
style I fill:#fff,stroke:#333,stroke-width:2px
style J fill:#fff,stroke:#333,stroke-width:2px
style K fill:#fff,stroke:#333,stroke-width:2px
style L fill:#fff,stroke:#333,stroke-width:2px
style M fill:#fff,stroke:#333,stroke-width:2px
style N fill:#fff,stroke:#333,stroke-width:2px
style O fill:#fff,stroke:#333,stroke-width:2px
style P fill:#fff,stroke:#333,stroke-width:2px
style Q fill:#fff,stroke:#333,stroke-width:2px
style R fill:#fff,stroke:#333,stroke-width:2px
style S fill:#fff,stroke:#333,stroke-width:2px
style T fill:#fff,stroke:#333,stroke-width:2px
This flexibly allows capture of information about a variety of communication channels (telephone, email, fax,...
| Element | Description | Cardinality | Rule | Examples |
|---|---|---|---|---|
| Communication | A person's contact information: ChannelCode, Address, URI –for email, for instance—, etc. |
1..n | BR-COM-10: If the Communication element is filled in, at least one of its sub elements should be filled in too. | N/A |
| Sub-elements | ||||
| ChannelCode | The communication channel used to contact a person or an organization. (e.", "MobileTelephone", "Fax", "Email", "InstantMessage", "Web") | 0..1 | ECV05: ChannelCodeContentType must be used to codify the /ChannelCode
element. BR-CV-31: If URI element is provided, ChannelCode element must contain either "Email" or "Web". For Email: Maximum number of 99 characters, allow adding more than one email address [1-n]. |
Europass2: ChannelCodeContentType [ECV04] |
| UseCode | The type of use given to the communication channel used to contact a person or an
organization. (e.g.“Personal”, “Business”). |
0..1 | ECV04: ContactUseCodeContentTypemust be used to codify the /UseCode element. |
Europass2: ContactUseCodeContentType [ECV03] |
| OtherTitle | It specifies the tile of ChannelCode or UseCode when Other is chosen. | 0..n | N/A | N/A |
| CommunicationChoice | Selection between the types of communication channels. See section /CandidateSupplier/PersonContact/Communication/CommunicationChoice for more information |
N/A | BR-CV-30: At least one of the following sub-elements (either Address or URI or DialNumber) must be provided. | N/A |
3.4.4.2 Communication Attributes¶
<img>Diagram showing "Communication" with attributes "sequence", "preferredIndicator", "validFrom", "validTo". It also shows "hr:EffectiveDateAttributeGroup" with "validFrom" and "validTo". A note says "HR-XML's 3.0 architecture makes a distinction between effective-date meta data and effective dating that is an integral...". Another note says "This flexibly allows capture of information about a variety of communication channels (telephone, email, fax,...".</img>
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| sequence | Establishes the order of the contact data | 0..1 | N/A |
| preferredIndicator | Boolean indicating if the current contact data is the preferred one | 0..1 | N/A |
| validFrom | Validity start date for this Communication | 0..1 | BR-COM-06: Compulsory Date Format is: YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDThh:mm:ss. |
| validTo | Date up to when the communication channel is available | 0..1 | BR-COM-06: Compulsory Date Format is: YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDThh:mm:ss. |
ChannelCode attributes¶
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| Refer to CodeListAttributeGroup Attributes for additional attributes. | |||
UseCode attributes¶
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| Refer to CodeListAttributeGroup Attributes for additional attributes. | |||
CommunicationChoice attributes¶
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| See section CommunicationChoice Attributes for more information | |||
3.4.5 Sub-element: /CandidateSupplier/PersonContact/Communication/CommunicationChoice (level 4)¶
3.4.5.1 CommunicationChoice Element Description¶
| Element | Description | Cardinality | Rule | Examples |
|---|---|---|---|---|
| CommunicationChoice | Selection between the types of channels 1-Address 2-Telephone 3-URL 4-Text |
N/A | N/A | |
| Choice 1 Elements | ||||
| CountryDialling | The country dialling code for a contact number | 0..1 | PhonePrefix [ECV07] code list must be used. | Europass2: PhonePrefix [ECV07] |
| AreaDialling | The area dialling code for a contact number | 0..1 | N/A | N/A |
| DialNumber | The contact number, not including country dialling or area dialling codes | 0..1 | N/A | N/A |
| CountryCode | It specifies code identifying the country. | 0..1 | CountriesAndNationalities [ECV02], AuxCountriesAndNationalities [ECV10] code list must be used. | Europass2: CountriesAndNationalities [ECV02], Europass2: AuxCountriesAndNationalities [ECV10] |
| Choice 2 Elements | ||||
| Address | Properties specifying an entity's physical location | 0..1 | N/A | N/A |
| See section /CandidatePerson/Communication/CommunicationChoice/Address for more information | ||||
| Choice 3 Elements | ||||
| URI | Uniform Resource Identifier Reference (URI). A URI value can be absolute or relative, and may have an optional fragment identifier (i.e., it may be a URI Reference). This type should be used to specify that the value is to fulfil the role of a URI, as defined by [RFC 2396] and as amended by [RFC 2732]. | 0..1 | N/A | "mymail@test.org", "mymail@noreply.com", etc. |
3.4.5.2 CommunicationChoice Attributes¶
| Attributes | Description | Card. | Rule |
|---|---|---|---|
| It has no attributes. | |||
| CountryDialling attributes | |||
| Attributes | Description | Card. | Rule |
| Refer to CodeListAttributeGroup for additional attributes. | |||
| AreaDialling attributes | |||
| Attributes | Description | Card. | Rule |
| languageID | Language in which the AreaDialling is mentioned | 0..1 | "en" |
| DialNumber attributes | |||
| Attributes | Description | Card. | Rule |
| languageID | Language in which the DialNumber is mentioned | 0..1 | "en" |
| CountryCode attributes | |||
| Attributes | Description | Card. | Rule |
| validFrom | Validity start date for this entity's information | 0..1 | BR-COM-06: Compulsory Date Format is: YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDThh:mm:ss. |
| validTo | Validity end date for this entity's information | 0..1 | BR-COM-06: Compulsory Date Format is: YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDThh:mm:ss. |
| Refer to CodeListAttributeGroup Attributes section for additional attributes | |||
| Address attributes | |||
| Attributes | Description | Card. | Rule |
| See section /CandidatePerson/Communication/CommunicationChoice/Address for more information | |||
| URLs attributes | |||
| Attributes | Description | Card. | Rule |
| It has no attributes. | |||