Health​Vault​Platform Class

Definition

Provides low-level access to the HealthVault service.

public static class HealthVaultPlatform
Inheritance
HealthVaultPlatform

Remarks

HealthServicePlatform provides access to the HealthVault service at a low level.

        For an easier-to-use interface, please see the following abstractions:
        <strong>Data item operations</strong><xref href="Microsoft.Health.HealthRecordAccessor"></xref> and <xref href="Microsoft.Health.HealthRecordInfo"></xref>

Methods

Add​Child​Application(​Offline​Web​Application​Connection, ​Application​Info)

Adds a HealthVault application instance for a "child" application of the calling application.

Allocate​Connect​Package​Id(​Offline​Web​Application​Connection)

Allocates a package ID within HealthVault and returns it.

Associate​Alternate​Id(​Application​Connection, ​Health​Record​Accessor, ​String)

Associates an alternate ID with a record.

Clear​Item​Type​Cache()

Removes all item type definitions from the client-side cache.

Create​Connect​Package(​Connect​Package​Creation​Parameters, ​Password​Protected​Package)

Asks HealthVault to create a pending package for the application specified by the connection with the specified user specific parameters and the pre-allocated identity code.

Create​Connect​Package(​Connect​Package​Creation​Parameters, ​Password​Protected​Package, ​IEnumerable<​Uri>)

Asks HealthVault to create a pending package for the application specified by the connection with the specified user specific parameters and the pre-allocated identity code.

Create​Patient​Connection(​Offline​Web​Application​Connection, ​String, ​String, ​String, ​Uri, ​String)

Asks HealthVault to create a pending patient connection for the application specified by the connection with the specified user specific parameters.

Delete​Pending​Connection​Package​For​Identity​Code(​Offline​Web​Application​Connection, ​String)

Deletes a single package that has been created by the calling application but has not been accepted by the user.

Delete​Pending​Connect​Packages(​Offline​Web​Application​Connection, ​String)

Deletes all packages that have been created by the calling application for the applicationPatientId and have not been accepted by the user.

Delete​Pending​Patient​Connection(​Offline​Web​Application​Connection, ​String)

Deletes a request for a connection that has been made by the calling application but has not been validated by the user.

Disassociate​Alternate​Id(​Application​Connection, ​String)

Disassociates an alternate id with a record.

Disassociate​Alternate​Id(​Application​Connection, ​Health​Record​Accessor, ​String)

Disassociates an alternate id with a record.

Get​Alternate​Ids(​Application​Connection, ​Health​Record​Accessor)

Gets the list of alternate IDs that are associated with a record.

Get​Application​Info(​Health​Service​Connection)

Gets the application configuration information for the calling application.

Get​Application​Info(​Health​Service​Connection, ​Boolean)

Gets the application configuration information for the calling application.

Get​Application​Settings(​Health​Service​Connection)

Gets the application settings for the current application and person.

Get​Application​Settings​As​Xml(​Health​Service​Connection)

Gets the application settings for the current application and person.

Get​Authorized​People(​Application​Connection)

Gets information about people authorized for an application.

Get​Authorized​People(​Application​Connection, ​Get​Authorized​People​Settings)

Gets information about people authorized for an application.

Get​Authorized​Records(​Application​Connection, ​IList<​Guid>)

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

Get​Child​Application(​Offline​Web​Application​Connection, ​Guid)

Gets the configuration information for the specified child application ID.

Get​Health​Record​Item​Type​Definition(​IList<​Guid>, ​Health​Record​Item​Type​Sections, ​IList<​String>, ​Nullable<​Date​Time>, ​Health​Service​Connection)

Gets the definitions for one or more health record item type definitions supported by HealthVault.

Get​Matching​Items(​Application​Connection, ​Health​Record​Accessor, ​Health​Record​Searcher)

Gets the health record items that match the filters as specified by the properties of this class.

Get​Matching​Items​Raw(​Application​Connection, ​Health​Record​Accessor, ​Health​Record​Searcher)

Gets the health record items that match the filters as specified by the properties of this class.

Get​Matching​Items​Reader(​Application​Connection, ​Health​Record​Accessor, ​Health​Record​Searcher)

Gets the health record items that match the filters as specified by the properties of this class.

Get​Meaningful​Use​Timely​Access​Document​Report(​Health​Service​Connection, ​Date​Range)

Retrieves the Meaningful Use Timely Access Report for the application.

Get​Meaningful​Use​Timely​Access​DO​PU​Document​Report(​Health​Service​Connection, ​Date​Range)

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

Get​Meaningful​Use​VD​TReport(​Health​Service​Connection, ​Date​Range)

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

Get​Person​And​Record​For​Alternate​Id(​Application​Connection, ​String)

Gets the person and record IDs that were previosly associated with an alternate ID.

Get​Person​Info(​Application​Connection)

Gets the information about the person specified.

Get​Service​Definition(​Health​Service​Connection, ​Service​Info​Sections, ​Date​Time)

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

Get​Service​Definition(​Health​Service​Connection, ​Date​Time)

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

Get​Service​Definition(​Health​Service​Connection)

Gets information about the HealthVault service.

Get​Service​Definition(​Health​Service​Connection, ​Service​Info​Sections)

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

Get​Transformed​Items(​Application​Connection, ​Health​Record​Accessor, ​Health​Record​Searcher, ​String)

Gets the health record items specified by the HealthRecordSearcher and runs them through the specified transform.

Get​Updated​Record​Info​For​Application(​Health​Service​Connection, ​Nullable<​Date​Time>)

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

Get​Updated​Records​For​Application(​Health​Service​Connection, ​Nullable<​Date​Time>)

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

Get​Validated​Patient​Connections(​Offline​Web​Application​Connection, ​Date​Time)

Gets the connections for the application that people have accepted since the specified date.

Get​Valid​Group​Membership(​Application​Connection, ​Health​Record​Accessor, ​IList<​Guid>)

Gets valid group memberships for a record.

Get​Vocabulary(​Health​Service​Connection, ​String)

Retrieves a list of vocabulary items for the specified vocabulary.

Get​Vocabulary(​Health​Service​Connection, ​Vocabulary​Key, ​Boolean)

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

Get​Vocabulary(​Health​Service​Connection, ​IList<​Vocabulary​Key>, ​Boolean)

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

Get​Vocabulary​Keys(​Health​Service​Connection)

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

New​Items(​Application​Connection, ​Health​Record​Accessor, ​IList<​Health​Record​Item>)

Creates new health record items associated with the record.

New​Signup​Code(​Health​Service​Connection)

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

Query​Permissions(​Application​Connection, ​Health​Record​Accessor, ​IList<​Guid>)

Gets the permissions which the authenticated person has when using the calling application for the specified item types in this health record.

Query​Permissions​By​Types(​Application​Connection, ​Health​Record​Accessor, ​IList<​Guid>)

Gets the permissions which the authenticated person has when using the calling application for the specified item types in this record.

Query​Record​Permissions(​Application​Connection, ​Health​Record​Accessor, ​IList<​Guid>)

Gets the permissions which the authenticated person has when using the calling application for the specified item types in this health record as well as the other permission settings such as IsMeaningfulUseTrackingEnabled.

Remove​Application​Authorization(​Application​Connection, ​Health​Record​Accessor)

Releases the authorization of the application on the health record.

Remove​Items(​Application​Connection, ​Health​Record​Accessor, ​IList<​Health​Record​Item​Key>)

Marks the specified health record item as deleted.

Search​Vocabulary(​Health​Service​Connection, ​Vocabulary​Key, ​String, ​Vocabulary​Search​Type, ​Nullable<​Int32>)

Searches a specific vocabulary and retrieves the matching vocabulary items.

Search​Vocabulary​Keys(​Health​Service​Connection, ​String, ​Vocabulary​Search​Type, ​Nullable<​Int32>)

Searches the keys of vocabularies defined by the HealthVault service.

Select​Instance(​Health​Service​Connection, ​Location)

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

Send​Insecure​Message(​Health​Service​Connection, ​IList<​Mail​Recipient>, ​String, ​String, ​String)

Sends an insecure message to the specified message recipients.

Send​Insecure​Message(​Health​Service​Connection, ​IList<​Guid>, ​Boolean, ​String, ​String, ​String)

Sends an insecure message to the specified message recipients.

Send​Insecure​Message​From​Application(​Health​Service​Connection, ​IList<​Mail​Recipient>, ​String, ​String, ​String, ​String, ​String)

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

Send​Insecure​Message​From​Application(​Health​Service​Connection, ​IList<​Guid>, ​Boolean, ​String, ​String, ​String, ​String, ​String)

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

Send​Insecure​Message​To​Custodians(​Health​Service​Connection, ​Guid, ​Boolean, ​String, ​String, ​String)

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

Send​Insecure​Message​To​Custodians​From​Application(​Health​Service​Connection, ​Guid, ​Boolean, ​String, ​String, ​String, ​String, ​String)

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

Set​Application​Settings(​Health​Service​Connection, ​IX​Path​Navigable)

Sets the application settings for the current application and person.

Update​Child​Application(​Application​Connection, ​Application​Info)

Updates the application's configuration in HealthVault.

Update​Connect​Package​Application​Patient​Id(​Offline​Web​Application​Connection, ​String, ​String)

Updates existing pending packages with a new application patient identifier.

Update​Connect​Package​Application​Patient​Id​For​Identity​Code(​Offline​Web​Application​Connection, ​String, ​String)

Updates an existing pending package with a new application patient identifier.

Update​Items(​Application​Connection, ​Health​Record​Accessor, ​IList<​Health​Record​Item>)

Updates the specified health record items in one batch call to the service.

Update​Patient​Connection​Application​Patient​Id(​Offline​Web​Application​Connection, ​String, ​String)

Updates an existing pending patient connection with a new application patient identifier.