Data Model Libraries
    Preparing search index...

    Class OrganizationContactComponent

    OrganizationContactComponent Class

    FHIR Specification

    • Short: Contact for the organization for a certain purpose
    • Definition: Contact for the organization for a certain purpose.
    • Comment: Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
    • Requirements: Need to keep track of assigned contact points within bigger organization.

    FHIR Organization

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    purpose? name? telecom? address?

    Methods

    parse getPurpose setPurpose hasPurpose getName setName hasName getTelecom setTelecom addTelecom hasTelecom getAddress setAddress hasAddress fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initTelecom

    Constructors

    Properties

    purpose?: CodeableConcept

    Organization.contact.purpose Element

    FHIR Specification

    • Short: The type of contact
    • Definition: Indicates a purpose for which the contact can be reached.
    • Requirements: Need to distinguish between multiple contact persons.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    name?: HumanName

    Organization.contact.name Element

    FHIR Specification

    • Short: A name associated with the contact
    • Definition: A name associated with the contact.
    • Requirements: Need to be able to track the person by name.
    • FHIR Type: HumanName
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    telecom?: ContactPoint[]

    Organization.contact.telecom Element

    FHIR Specification

    • Short: Contact details (telephone, email, etc.) for a contact
    • Definition: A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
    • Requirements: People have (primary) ways to contact them in some way such as phone, email.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    address?: Address

    Organization.contact.address Element

    FHIR Specification

    • Short: Visiting or postal addresses for the contact
    • Definition: Visiting or postal addresses for the contact.
    • Requirements: May need to keep track of a contact party's address for contacting, billing or reporting requirements.
    • FHIR Type: Address
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR OrganizationContactComponent

      • OptionaloptSourceField: string

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

      Returns undefined | OrganizationContactComponent

      OrganizationContactComponent data model or undefined for OrganizationContactComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods