Data Model Libraries
    Preparing search index...

    Class ExtendedContactDetail

    ExtendedContactDetail Class

    ExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.

    Need to track contact and address information in the same way across multiple resources.

    FHIR Specification

    • Short: Contact information
    • Definition: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
    • Comment: This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.
    • FHIR Version: 5.0.0

    FHIR ExtendedContactDetail

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    purpose? name? telecom? address? organization? period?

    Methods

    parse getPurpose setPurpose hasPurpose getName setName addName hasName getTelecom setTelecom addTelecom hasTelecom getAddress setAddress hasAddress getOrganization setOrganization hasOrganization 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 initName initTelecom

    Constructors

    Properties

    purpose?: CodeableConcept

    ExtendedContactDetail.purpose Element

    FHIR Specification

    • Short: The type of contact
    • Definition: The purpose/type of contact.
    • Comment: If no purpose is defined, then these contact details may be used for any purpose.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: HumanName[]

    ExtendedContactDetail.name Element

    FHIR Specification

    • Short: Name of an individual to contact
    • Definition: The name of an individual to contact, some types of contact detail are usually blank.
    • Comment: If there is no named individual, the telecom/address information is not generally monitored by a specific individual.
    • FHIR Type: HumanName
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    telecom?: ContactPoint[]

    ExtendedContactDetail.telecom Element

    FHIR Specification

    • Short: Contact details (e.g.phone/fax/url)
    • Definition: The contact details application for the purpose defined.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    address?: Address

    ExtendedContactDetail.address Element

    FHIR Specification

    • Short: Address for the contact
    • Definition: Address for the contact.
    • Comment: More than 1 address would be for different purposes, and thus should be entered as a different entry,.
    • FHIR Type: Address
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    organization?: Reference

    ExtendedContactDetail.organization Element

    FHIR Specification

    • Short: This contact detail is handled/monitored by a specific organization
    • Definition: This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.
    • Requirements: Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    ExtendedContactDetail.period Element

    FHIR Specification

    • Short: Period that this contact was valid for usage
    • Definition: Period that this contact was valid for usage.
    • Comment: If the details have multiple periods, then enter in a new ExtendedContact with the new period.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExtendedContactDetail

      • OptionaloptSourceField: string

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

      Returns undefined | ExtendedContactDetail

      ExtendedContactDetail data model or undefined for ExtendedContactDetail

      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