Contact
From OpenIndivo Documentation Wiki
Contents |
[edit]
Overview
Each Indivo record is expected to contain exactly one ContactInformation document, identifying the record holder, and containing his important medical contacts. The core component of that document, however -- the ConciseContactInformationType -- is used throughout the document model whenever one must identify a person, organization, or electronic system.
[edit]
Schema
[edit]
Detailed Schema Description
[edit]
ConciseContactInformationType
When used, choose either a PersonName (with optional JobTitle and Affiliation fields), OrganizationName, or SystemName.
PersonName- NameType (required, multiple - choice among this, OrganizationName, and SystemName)
- Name of this contact person. When multiple names are provided, first in the list will be considered default.
JobTitle- string (optional)
- Contact person's job title, used especially when medically relevant.
Affiliation- string (optional)
- Contact person's institutional affiliation.
OrganizationName- string (required - choice among this, PersonName, and SystemName)
- Name of this organizational contact. Suitable for hospitals, businesses, etc.
SystemName- string (required - choice among this, PersonName, and SystemName)
- Name of this electronic system contact. Suitable for subscription agents, third-party health applications, etc.
Address- AddressType (optional, multiple)
- Addresses for this contact.
ContactMethod- CommunicationType (optional, multiple)
- Methods to contact this person, e.g. phone, e-mail, fax, pager, etc.
[edit]
NameType
Salutation- string (optional)
- The contact's title, prefixing his name to signify veneration, official position, or a professional or academic qualification, e.g. Mr., Dr., Prof., Hon., etc.
FirstName- string (optional)
- The contact's first name.
MiddleName- string (optional)
- The contact's middle name.
LastName- string (optional)
- The contact's last, or family, name.
Suffix- string (optional)
- A professional, academic, or familial addition to the contact's name, e.g. Jr., Sr., III., MD., PhD.
Type- string (optional)
- Optional description of this name's purpose, most suitable for when multiple names are used for a single contact, e.g. birth/maiden name, alias, etc.
- Usage: Common values include birth (birth name), premarital (pre-marital, or "maiden," name), and alias.
[edit]
AddressType
Type- string (required)
- Purpose of this addresses vis-a-vis the contact, e.g. default, home, office, mailing.
- Usage: Set Type to default when describing the primary address of an organization or system, or when great specificity is unavailable. Home and office are suitable for persons. Mailing addresses should be provided when they differ from a contact's geographical location. Using other values is at the discretion of the data source. Data processors should treat this field in a case-insensitive manner, and should display addresses marked default before other types.
Priority- integer (required)
- The relative priority of this address among others listed for this contact.
- Usage: Set Priority to 1 by default. Data processors should display addresses in order of Priority, then Type.
StreetAddress1- string (optional)
- First line of the contact's street address.
StreetAddress2- string (optional)
- Second line of the contact's street address.
County- string (optional)
- Contact's county name.
City- string (optional)
- Contact's city or town name.
State- string (optional)
- Contact's state, province, or other national subdivision.
- Usage: The Indivo Reference User Interface expects state abbreviations, rather than full state names, but either is permissible.
PostalCode- string (optional)
- Contact's ZIP or other postal code.
Country- string (optional)
- Contact's country name.
[edit]
CommunicationType
Medium- string (required)
- The communication method described in by this element.
- Usage: Commonly used values include phone, email (no hyphen), pager, and fax. Data processors should treat this field in a case-insensitive manner.
Priority- integer (required)
- The relative priority of this communication method among others listed for this contact.
- Usage: Set Priority to 1 by default. Data processors should display communication types in order of Medium, then Priority (note distinction from AddressType).
Class- string (required)
- Describes the general destination of this communication method.
- Usage: Commonly used values include default, home, mobile, and office. Choose default when greater specificity is unavailable. Data processors should treat this field in a case-insensitive manner.
Value- string (required)
- The actual unique code to reach the contact via this communication method, e.g. telephone number, e-mail address, etc.
[edit]
ContactInformationType
Each Indivo Record must contain exactly one ContactInformation document, defined by the ContactInformationType. This type extends the ConciseContactInformationType (described above), adding the following three fields.
PersonalIdentifier- PersonalIdentifierType (optional, multiple)
- Government- or institution-issued identifiers, e.g. social security number, driver's license number, etc.
Contacts- RelationInformationType (optional, multiple)
- Record holder's important family or medical contacts.
Photo- ImageType (optional, multiple)
- Photograph of record holder.
[edit]
RelationInformationType
This type extends the ConciseContactInformationType (described above), adding the following two fields.
Emergency- boolean (required)
- A true value indicates that this individual is the record holder's emergency contact.
Relationship- CodedValueType (required)
- The relationship of this contact to the record holder.
- » Refer to coding systems indivo-personal-relationships-1.0, indivo-medical-relationships-1.0, and indivo-org-relationships-1.0.
[edit]
PersonalIdentifierType
Identifier- string (required)
- The identifier value.
Type- string (required)
- Description of this identifier.
- Usage: Common values include ssn (social security number) or drivers-license (driver's license number). Data processors should treat this field in a case-insensitive manner.
[edit]
