| Datatypes UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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 |
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 |
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 |
"Telecommunications form for contact point - what communications system is required to make use of the contact." - HL7 FHIR, ContactPoint.system. |
«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. |
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. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | TEL |
Name | ContactPoint |
Name Expression | |
Namespace | Datatypes |
Owned Template Signature | |
Owner | Datatypes |
Owning Template Parameter | |
Package | Datatypes |
Qualified Name | FHIM::Datatypes::ContactPoint |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «TEL» ContactPoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | effectiveDateRange |
Name Expression | |
Namespace | «TEL» ContactPoint |
Opposite | |
Owner | «TEL» ContactPoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::ContactPoint::effectiveDateRange |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «TEL» ContactPoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isTextMessageEnabled |
Name Expression | |
Namespace | «TEL» ContactPoint |
Opposite | |
Owner | «TEL» ContactPoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::ContactPoint::isTextMessageEnabled |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «TEL» ContactPoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | rank |
Name Expression | |
Namespace | «TEL» ContactPoint |
Opposite | |
Owner | «TEL» ContactPoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::ContactPoint::rank |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code system
"Telecommunications form for contact point - what communications system is required to make use of the contact." - HL7 FHIR, ContactPoint.system.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «TEL» ContactPoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | system |
Name Expression | |
Namespace | «TEL» ContactPoint |
Opposite | |
Owner | «TEL» ContactPoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::ContactPoint::system |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «TEL» ContactPoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | use |
Name Expression | |
Namespace | «TEL» ContactPoint |
Opposite | |
Owner | «TEL» ContactPoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::ContactPoint::use |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «TEL» ContactPoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | value |
Name Expression | |
Namespace | «TEL» ContactPoint |
Opposite | |
Owner | «TEL» ContactPoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::ContactPoint::value |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Datatypes UML Documentation |
Summary:AttributesProperties | Detail:Attributes |