Data Model Libraries
    Preparing search index...

    VirtualServiceDetail Class

    VirtualServiceDetail Type: Virtual Service Contact Details.

    FHIR Specification

    • Short: Virtual Service Contact Details
    • Definition: Virtual Service Contact Details.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    channelType?: Coding

    VirtualServiceDetail.channelType Element

    FHIR Specification

    • Short: Channel Type
    • Definition: The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp).
    • Comment: As this type defines what the virtual service is, it then defines what address and additional information might be relevant. Some profiles could be used for specific types to define what the other values could/should be.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    address?: IDataType

    VirtualServiceDetail.address[x] Element

    @ChoiceDataTypesMeta('VirtualServiceDetail.address[x]', ['url','string','ContactPoint','ExtendedContactDetail',]

    FHIR Specification

    • Short: Contact address/number
    • Definition: What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).
    • FHIR Types: 'url', 'string', 'ContactPoint', 'ExtendedContactDetail',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    additionalInfo?: UrlType[]

    VirtualServiceDetail.additionalInfo Element

    FHIR Specification

    • Short: Address to see alternative connection details
    • Definition: Address to see alternative connection details.
    • Comment: This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services.
    • FHIR Type: url
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    maxParticipants?: PositiveIntType

    VirtualServiceDetail.maxParticipants Element

    FHIR Specification

    • Short: Maximum number of participants supported by the virtual service
    • Definition: Maximum number of participants supported by the virtual service.
    • Comment: Some services have only a limitted number of participants permitted to connect at a time, this is typically used in "shared" virtual services that you might find on location resources. Typically on-demand services might not have these restrictions.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    sessionKey?: StringType

    VirtualServiceDetail.sessionKey Element

    FHIR Specification

    • Short: Session Key required by the virtual service
    • Definition: Session Key required by the virtual service.
    • Comment: Some services require a session key to be able to access the service once connected. This could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR VirtualServiceDetail

      • OptionaloptSourceField: string

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

      Returns undefined | VirtualServiceDetail

      VirtualServiceDetail data model or undefined for VirtualServiceDetail

      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