Ancestor: HL7Connect.Cda.ANY

A locatable resource that is identified by a URI, such as a web page, a telephone number (voice, fax or some other resource mediated by telecommunication equipment), an e-mail address, or any other locatable resource that can be specified by a URL.

The address is specified as a Universal Resource Locator (URL) qualified by time specification and use codes that help in deciding which address to use for a given time and purpose.

The value attribute is constrained to be a uniform resource locator specified according to IETF RFCs 1738 and 2806 when used in this datatype.

Note: The intent of this datatype is to be a locator, not an identifier; this datatype is used to refer to a locatable resource using a URL, and knowing the URL allows one to locate the object. However some use cases have arisen where a URI is used to refer to a locatable resource. Though this datatype allows for URIs to be used, the resource identified SHOULD always be locatable. A common use of locatable URI's is to refer to SOAP attachments

Properties

string value;
   A uniform resource identifier specified according to IETF RFC 2396.

The URI specifies the protocol and the contact point defined by that protocol for the resource.

Examples: Notable uses of the telecommunication address datatype are for telephone and telefax numbers, e-mail addresses, Hypertext references, FTP references, etc.

If the TEL has a nullFlavor, it is not necessary for the value to contain a valid URL. For instance, if the flavor is UNK, the value may be just "tel:" to indicate that what is unknown is a telephone number.

ISet use;
   One or more codes advising system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

The telecommunication use code is not a complete classification for equipment types or locations. Its main purpose is to suggest or discourage the use of a particular telecommunication address. There are no easily defined rules that govern the selection of a telecommunication address. Conformance statements may clarify what rules may apply or how additional rules are applied.

If populated, the values contained in this attribute SHALL be taken from the HL7 TelecommunicationAddressUse code system

ISet capabilities;
   One or more codes advising a system or user what telecommunication capabilities are known to be associated with the telecommunication address.

If populated, the values contained in this attribute SHALL be taken from the HL7 TelecommunicationCapability code system

HL7Connect.Cda.QSET useablePeriod;
   The periods of time during which the telecommunication address can be used.

For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.


Methods

string canonical();
   the canonical representation of the URL (consult ISO 21090 for further details)


© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: Value, canonical, capabilities, use, useablePeriod, TEL, HL7Connect.Cda.TEL