Data Model Libraries
    Preparing search index...

    Class ContactPoint

    ContactPoint Class

    ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

    Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc.

    FHIR Specification

    • Short: Details of a Technology mediated contact point (phone, fax, email, etc.)
    • Definition: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
    • FHIR Version: 5.0.0

    FHIR ContactPoint

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    contactPointSystemEnum system? value? contactPointUseEnum use? rank? period?

    Methods

    parse getSystemEnumType setSystemEnumType hasSystemEnumType getSystemElement setSystemElement hasSystemElement getSystem setSystem hasSystem getValueElement setValueElement hasValueElement getValue setValue hasValue getUseEnumType setUseEnumType hasUseEnumType getUseElement setUseElement hasUseElement getUse setUse hasUse getRankElement setRankElement hasRankElement getRank setRank hasRank getPeriod setPeriod hasPeriod fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    contactPointSystemEnum: ContactPointSystemEnum

    FHIR CodeSystem: ContactPointSystem

    ContactPointSystemEnum

    system?: EnumCodeType

    ContactPoint.system Element

    FHIR Specification

    • Short: phone | fax | email | pager | url | sms | other
    • Definition: Telecommunications form for contact point - what communications system is required to make use of the contact.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ContactPointSystemEnum

    value?: StringType

    ContactPoint.value Element

    FHIR Specification

    • Short: The actual contact point details
    • Definition: The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
    • Comment: Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
    • Requirements: Need to support legacy numbers that are not in a tightly controlled format.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contactPointUseEnum: ContactPointUseEnum

    FHIR CodeSystem: ContactPointUse

    ContactPointUseEnum

    use?: EnumCodeType

    ContactPoint.use Element

    FHIR Specification

    • Short: home | work | temp | old | mobile - purpose of this contact point
    • Definition: Identifies the purpose for the contact point.
    • Comment: Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
    • Requirements: Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
    • isSummary: true

    CodeSystem Enumeration: ContactPointUseEnum

    rank?: PositiveIntType

    ContactPoint.rank Element

    FHIR Specification

    • Short: Specify preferred order of use (1 = highest)
    • Definition: Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
    • Comment: Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    ContactPoint.period Element

    FHIR Specification

    • Short: Time period when the contact point was/is in use
    • Definition: Time period when the contact point was/is in use.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided ContactPoint JSON to instantiate the ContactPoint data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ContactPoint

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ContactPoint

      Returns undefined | ContactPoint

      ContactPoint data model or undefined for ContactPoint

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods