Datatypes
Class ContactPoint

A collection of electronic addresses at which the person or organization may be reached. This includes telephones, email addresses, etc.
"Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc. " - HL7 FHIR, ContactPoint.

Attributes
«IVL_TS» Period effectiveDateRange effectiveDateRange

The time period during which the phone number or communications address is valid for the person or organization. The data type is a TimeInterval, which includes both a start date and end date, either of which may be empty.
"Time period when the contact point was/is in use." - HL7 FHIR, ContactPoint.period.

Boolean isTextMessageEnabled isTextMessageEnabled

Indicates whether the endpoint can receive text messages. Used for phone numbers only. Added for ONC S&I Clinical Element Data Dictionary (CEDD).

Integer rank rank

This optional property is included for compatibility with FHIR. It allows for the ordering of contact points within a list or collection of contact points.
"Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values." - HL7 FHIR, ContactPoint.rank

«CS» Code system system

"Telecommunications form for contact point - what communications system is required to make use of the contact." - HL7 FHIR, ContactPoint.system.

«CS» Code use use

Indicates the kind of communications address that is contained within this class. Examples include primaryHome, Work, etc. This facilitates the selection of a particular communications address from a list of contact points that may apply to the person or organization.
"Identifies the purpose for the contact point." - HL7 FHIR, ContactPoint.use.

String value value

Represents a telecommunications address at which the person or organization may be reached. Note that this property is a simply a string, the formatting of which will depend on the type of communications address employed.
"The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)." - HL7 FHIR, ContactPoint.value.


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsTEL
NameContactPoint
Name Expression
NamespaceDatatypes
Owned Template Signature
OwnerDatatypes
Owning Template Parameter
PackageDatatypes
Qualified NameFHIM::Datatypes::ContactPoint
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 effectiveDateRange
Public «IVL_TS» Period effectiveDateRange

The time period during which the phone number or communications address is valid for the person or organization. The data type is a TimeInterval, which includes both a start date and end date, either of which may be empty.
"Time period when the contact point was/is in use." - HL7 FHIR, ContactPoint.period.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«TEL» ContactPoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameeffectiveDateRange
Name Expression
Namespace«TEL» ContactPoint
Opposite
Owner«TEL» ContactPoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::ContactPoint::effectiveDateRange
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 isTextMessageEnabled
Public Boolean isTextMessageEnabled

Indicates whether the endpoint can receive text messages. Used for phone numbers only. Added for ONC S&I Clinical Element Data Dictionary (CEDD).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«TEL» ContactPoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisTextMessageEnabled
Name Expression
Namespace«TEL» ContactPoint
Opposite
Owner«TEL» ContactPoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::ContactPoint::isTextMessageEnabled
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 rank
Public Integer rank

This optional property is included for compatibility with FHIR. It allows for the ordering of contact points within a list or collection of contact points.
"Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values." - HL7 FHIR, ContactPoint.rank

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«TEL» ContactPoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namerank
Name Expression
Namespace«TEL» ContactPoint
Opposite
Owner«TEL» ContactPoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::ContactPoint::rank
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 system
Public «CS» Code system

"Telecommunications form for contact point - what communications system is required to make use of the contact." - HL7 FHIR, ContactPoint.system.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«TEL» ContactPoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namesystem
Name Expression
Namespace«TEL» ContactPoint
Opposite
Owner«TEL» ContactPoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::ContactPoint::system
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 use
Public «CS» Code use

Indicates the kind of communications address that is contained within this class. Examples include primaryHome, Work, etc. This facilitates the selection of a particular communications address from a list of contact points that may apply to the person or organization.
"Identifies the purpose for the contact point." - HL7 FHIR, ContactPoint.use.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«TEL» ContactPoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameuse
Name Expression
Namespace«TEL» ContactPoint
Opposite
Owner«TEL» ContactPoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::ContactPoint::use
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 value
Public String value

Represents a telecommunications address at which the person or organization may be reached. Note that this property is a simply a string, the formatting of which will depend on the type of communications address employed.
"The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)." - HL7 FHIR, ContactPoint.value.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«TEL» ContactPoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namevalue
Name Expression
Namespace«TEL» ContactPoint
Opposite
Owner«TEL» ContactPoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::ContactPoint::value
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic