HealthClientAuthorizedConnection HealthClientAuthorizedConnection HealthClientAuthorizedConnection Class

Definition

Represents an authorized connection between a HealthVault client application and the HealthVault service.

public class HealthClientAuthorizedConnection : Microsoft.Health.Web.OfflineWebApplicationConnection
type HealthClientAuthorizedConnection = class
    inherit OfflineWebApplicationConnection
Public Class HealthClientAuthorizedConnection
Inherits OfflineWebApplicationConnection
Inheritance

Remarks

HealthClientAuthorizedConnection is a connection used by a HealthVault client application. The connection is authenticated using an application certificate in the user store, and does not require an authenticated user. The connection is only valid for HealthClientApplication instances, and each instance must be authorized using the HealthVault Shell service.

Constructors

HealthClientAuthorizedConnection() HealthClientAuthorizedConnection() HealthClientAuthorizedConnection()

Creates an instance of HealthClientAuthorizedConnection using connection information stored in a configuration file.

HealthClientAuthorizedConnection(WebApplicationCredential) HealthClientAuthorizedConnection(WebApplicationCredential) HealthClientAuthorizedConnection(WebApplicationCredential)

Creates an instance of HealthClientAuthorizedConnection using a specified WebApplicationCredential and connection information stored in a configuration file..

HealthClientAuthorizedConnection(WebApplicationCredential, Guid, HealthServiceInstance) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, HealthServiceInstance) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, HealthServiceInstance)

Creates a new instance of HealthClientAuthorizedConnection using a specified WebApplicationCredential, application ID, and HealthVault web-service instance.

HealthClientAuthorizedConnection(WebApplicationCredential, Guid, HealthServiceInstance, Guid) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, HealthServiceInstance, Guid) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, HealthServiceInstance, Guid)

Creates a new instance of HealthClientAuthorizedConnection with a WebApplicationCredential, an application ID, HealthVault web-service instance, and person ID.

HealthClientAuthorizedConnection(WebApplicationCredential, Guid, Uri) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, Uri) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, Uri)

Creates a new instance of HealthClientAuthorizedConnection using a specified WebApplicationCredential, application ID, and health service URL.

HealthClientAuthorizedConnection(WebApplicationCredential, Guid, Uri, Guid) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, Uri, Guid) HealthClientAuthorizedConnection(WebApplicationCredential, Guid, Uri, Guid)

Creates a new instance of HealthClientAuthorizedConnection with a WebApplicationCredential, an applicationID, healthServiceUri and personId

HealthClientAuthorizedConnection(WebApplicationCredential, HealthServiceInstance) HealthClientAuthorizedConnection(WebApplicationCredential, HealthServiceInstance) HealthClientAuthorizedConnection(WebApplicationCredential, HealthServiceInstance)

Creates a new instance of HealthClientAuthorizedConnection using a specified WebApplicationCredential and HealthVault web-service instance.

Methods

Authenticate() Authenticate() Authenticate()

Authenticates the application with HealthVault.

(Inherited from OfflineWebApplicationConnection)
CreateRequest(HealthRecordAccessor, String, Int32) CreateRequest(HealthRecordAccessor, String, Int32) CreateRequest(HealthRecordAccessor, String, Int32)

Represents a simple wrapper around the XML request for the web service.

(Inherited from ApplicationConnection)
CreateRequest(String, Int32) CreateRequest(String, Int32) CreateRequest(String, Int32)

Provides a wrapper around the XML request for the web service.

(Inherited from HealthServiceConnection)
GetAllApplicationSettings() GetAllApplicationSettings() GetAllApplicationSettings()

Gets the application settings for the current application and person.

(Inherited from OfflineWebApplicationConnection)
GetApplicationInfo() GetApplicationInfo() GetApplicationInfo()

Gets the application configuration information for the calling application.

(Inherited from ApplicationConnection)
GetApplicationInfo(Boolean) GetApplicationInfo(Boolean) GetApplicationInfo(Boolean)

Gets the application configuration information for the calling application.

(Inherited from ApplicationConnection)
GetApplicationSettings() GetApplicationSettings() GetApplicationSettings()

Gets the application settings for the current application and person.

(Inherited from OfflineWebApplicationConnection)
GetAuthorizedPeople() GetAuthorizedPeople() GetAuthorizedPeople()

Gets information about people authorized for an application.

(Inherited from ApplicationConnection)
GetAuthorizedPeople(GetAuthorizedPeopleSettings) GetAuthorizedPeople(GetAuthorizedPeopleSettings) GetAuthorizedPeople(GetAuthorizedPeopleSettings)

Gets information about people authorized for an application.

(Inherited from ApplicationConnection)
GetAuthorizedRecords(IList<Guid>) GetAuthorizedRecords(IList<Guid>) GetAuthorizedRecords(IList<Guid>)

Gets the HealthRecordInfo for the records identified by the specified recordIds.

(Inherited from ApplicationConnection)
GetMeaningfulUseTimelyAccessDOPUDocumentReport(DateRange) GetMeaningfulUseTimelyAccessDOPUDocumentReport(DateRange) GetMeaningfulUseTimelyAccessDOPUDocumentReport(DateRange)

Retrieves the Meaningful Use Timely Access Report for applications that use DOPU to transfer CCDA documents to HealthVault.

GetMeaningfulUseTimelyAccessDocumentReport(DateRange) GetMeaningfulUseTimelyAccessDocumentReport(DateRange) GetMeaningfulUseTimelyAccessDocumentReport(DateRange)

Retrieves the Meaningful Use Timely Access Report for the application.

GetMeaningfulUseVDTReport(DateRange) GetMeaningfulUseVDTReport(DateRange) GetMeaningfulUseVDTReport(DateRange)

Retrieves the Meaningful Use View, Download, and Transmit (VDT) Report for the application.

GetPersonInfo() GetPersonInfo() GetPersonInfo()

Gets the information about the person specified.

(Inherited from ApplicationConnection)
GetServiceDefinition() GetServiceDefinition() GetServiceDefinition()

Gets information about the HealthVault service.

(Inherited from HealthServiceConnection)
GetServiceDefinition(DateTime) GetServiceDefinition(DateTime) GetServiceDefinition(DateTime)

Gets information about the HealthVault service only if it has been updated since the specified update time.

(Inherited from HealthServiceConnection)
GetServiceDefinition(ServiceInfoSections) GetServiceDefinition(ServiceInfoSections) GetServiceDefinition(ServiceInfoSections)

Gets information about the HealthVault service corresponding to the specified categories.

(Inherited from HealthServiceConnection)
GetServiceDefinition(ServiceInfoSections, DateTime) GetServiceDefinition(ServiceInfoSections, DateTime) GetServiceDefinition(ServiceInfoSections, DateTime)

Gets information about the HealthVault service corresponding to the specified categories if the requested information has been updated since the specified update time.

(Inherited from HealthServiceConnection)
GetUpdatedRecordInfoForApplication(Nullable<DateTime>) GetUpdatedRecordInfoForApplication(Nullable<DateTime>) GetUpdatedRecordInfoForApplication(Nullable<DateTime>)

Gets a list of HealthRecordUpdateInfo objects for the current application, that optionally have been updated since a specified date.

(Inherited from ApplicationConnection)
GetUpdatedRecordsForApplication(Nullable<DateTime>) GetUpdatedRecordsForApplication(Nullable<DateTime>) GetUpdatedRecordsForApplication(Nullable<DateTime>)

Gets a list of health record IDs for the current application, that optionally have been updated since a specified date.

(Inherited from ApplicationConnection)
GetVocabulary(IList<VocabularyKey>, Boolean) GetVocabulary(IList<VocabularyKey>, Boolean) GetVocabulary(IList<VocabularyKey>, Boolean)

Retrieves lists of vocabulary items for the specified vocabularies and culture.

(Inherited from ApplicationConnection)
GetVocabulary(String) GetVocabulary(String) GetVocabulary(String)

Retrieves a list of vocabulary items for the specified vocabulary.

(Inherited from ApplicationConnection)
GetVocabulary(VocabularyKey, Boolean) GetVocabulary(VocabularyKey, Boolean) GetVocabulary(VocabularyKey, Boolean)

Retrieves a list of vocabulary items for the specified vocabulary and culture.

(Inherited from ApplicationConnection)
GetVocabularyKeys() GetVocabularyKeys() GetVocabularyKeys()

Retrieves a collection of key information for identifying and describing the vocabularies in the system.

(Inherited from ApplicationConnection)
NewSignupCode() NewSignupCode() NewSignupCode()

Generates a new signup code that should be passed to HealthVault Shell in order to create a new user account.

(Inherited from ApplicationConnection)
SearchVocabulary(VocabularyKey, String, VocabularySearchType, Nullable<Int32>) SearchVocabulary(VocabularyKey, String, VocabularySearchType, Nullable<Int32>) SearchVocabulary(VocabularyKey, String, VocabularySearchType, Nullable<Int32>)

Searches a specific vocabulary and retrieves the matching vocabulary items.

(Inherited from ApplicationConnection)
SearchVocabularyKeys(String, VocabularySearchType, Nullable<Int32>) SearchVocabularyKeys(String, VocabularySearchType, Nullable<Int32>) SearchVocabularyKeys(String, VocabularySearchType, Nullable<Int32>)

Searches the keys of vocabularies defined by the HealthVault service.

(Inherited from ApplicationConnection)
SelectInstance(Location) SelectInstance(Location) SelectInstance(Location)

Gets the instance where a HealthVault account should be created for the specified account location.

(Inherited from ApplicationConnection)
SendInsecureMessageFromApplication(IList<Guid>, Boolean, String, String, String, String, String) SendInsecureMessageFromApplication(IList<Guid>, Boolean, String, String, String, String, String) SendInsecureMessageFromApplication(IList<Guid>, Boolean, String, String, String, String, String)

Sends an insecure message originating from the application to the specified message recipients.

(Inherited from ApplicationConnection)
SendInsecureMessageFromApplication(IList<MailRecipient>, String, String, String, String, String) SendInsecureMessageFromApplication(IList<MailRecipient>, String, String, String, String, String) SendInsecureMessageFromApplication(IList<MailRecipient>, String, String, String, String, String)

Sends an insecure message originating from the application to the specified message recipients.

(Inherited from ApplicationConnection)
SendInsecureMessageToCustodiansFromApplication(Guid, Boolean, String, String, String, String, String) SendInsecureMessageToCustodiansFromApplication(Guid, Boolean, String, String, String, String, String) SendInsecureMessageToCustodiansFromApplication(Guid, Boolean, String, String, String, String, String)

Sends an insecure message originating from the application to custodians of the specified health record.

(Inherited from ApplicationConnection)
SetApplicationSettings(IXPathNavigable) SetApplicationSettings(IXPathNavigable) SetApplicationSettings(IXPathNavigable)

Sets the application settings for the current application and person.

(Inherited from OfflineWebApplicationConnection)

Properties

ApplicationId ApplicationId ApplicationId

Gets the calling application's ID.

(Inherited from HealthServiceConnection)
AuthenticationToken AuthenticationToken AuthenticationToken

Gets the authorization token to be used in all requests for this user.

(Inherited from HealthServiceConnection)
CancelAllRequests CancelAllRequests CancelAllRequests

Cancels any pending request to HealthVault that was initiated with this connection instance and prevents any new requests from being made.

(Inherited from HealthServiceConnection)
Credential Credential Credential

Gets or sets the application credential that is used to access HealthVault.

(Inherited from HealthServiceConnection)
Culture Culture Culture

Gets or sets the language to be sent to the server when making requests.

(Inherited from HealthServiceConnection)
OfflinePersonId OfflinePersonId OfflinePersonId

Gets or sets the unique identifier of the offline person who granted permissions to the calling application to perform certain operations.

(Inherited from OfflineWebApplicationConnection)
RequestCompressionMethod RequestCompressionMethod RequestCompressionMethod

Gets or sets the request compression method for this connection.

(Inherited from HealthServiceConnection)
RequestTimeToLive RequestTimeToLive RequestTimeToLive

Gets or sets the request time-to-live in seconds.

(Inherited from HealthServiceConnection)
RequestTimeoutSeconds RequestTimeoutSeconds RequestTimeoutSeconds

Gets or sets the request timeout in seconds.

(Inherited from HealthServiceConnection)
RequestUrl RequestUrl RequestUrl

Gets the HealthVault web-service URL.

(Inherited from HealthServiceConnection)
ResponseCompressionMethods ResponseCompressionMethods ResponseCompressionMethods

Gets or sets the comma-separated response compression methods.

(Inherited from HealthServiceConnection)
ServiceInstance ServiceInstance ServiceInstance

Gets the HealthVault web-service instance associated with this connection.

(Inherited from HealthServiceConnection)
WebProxy WebProxy WebProxy

Gets or sets the proxy to use with this instance of HealthServiceConnection.

(Inherited from HealthServiceConnection)

Applies to