Requesting an ApplicationID
Developing with a Sample ApplicationID
The ApplicationIDs that the HealthVault SDK sample applications use have been given a rather lenient set of permissions. An application that uses one of these IDs (along with the Private Key that is distributed with the sample code) is allowed to read, create, update, and delete any type of HealthRecordItem in a record that a custodian has authorized for use with that sample ApplicationID.
Here are the things that are not available with a sample's ApplicationID:
offline access
logo placement, custom application description, and configuration text
OpenQuery and Send Email functionality
Requesting an ApplicationID
When you reach a point in your application's development where the sample applications' configurations no longer meet your needs, you can request your own ApplicationID by sending an e-mail message containing the following information to HvAppId@microsoft.com:
Application Configuration Requirements
see the Learn section on http://msdn.microsoft.com/HealthVault for more information about many of these items |
| Logo | A logo that represents the application; it does not need to be the same as the company logo in the Application Directory.
Size: 145 px (w) x 145 px (h); 120-KB maximum |
| Application name | Name of the application that will be used to identify it. For example, this name will be shown to the user when they are authorizing the application for access to their HealthVault record. |
| Short description | Text summary of the application that is shown to the user when they are authorizing the application. Suggested character limit is 200. |
| Data access reason | End-user-facing text that gives the reasons for needing access to specific data types. This information is shown to the user when they are authorizing the application. |
| Data access while the user is logged in | For each data type, specify the type of access that the application requires (read, update, create, delete). You can find a list of types in the Learn section of the HealthVault Dev Center on MSDN. |
| Data access while the user is not logged in | For each data type, specify the type of access that the application requires (read, update, create, delete). You can find a list of types in the Learn section of the HealthVault Dev Center on MSDN. |
| ApplicationID | The ApplicationID that you are using and expect to go live with. |
| Public certificate | A 2048-bit key that corresponds to the private key that the application will be using to identify itself to HealthVault. Learn more about Creating A Private Key-Public Key Pair. |
| Access to create an OpenQuery | [yes/no] Do you require this? This may require an extra clause in your partner agreement. |
| Access to send e-mail messages from HealthVault | [yes/no] Do you require this? This may require an extra clause in your strategic collaboration agreement.
Provide the domain name from which e-mail will originate. |
| Action URL | The HealthServiceActionPage URL that will handle the following target values: Home, ServiceAgreement, Help, AppAuthReject, AppAuthSuccess, SelectedRecordChanged, ShareRecordSuccess, ShareRecordFailed, Privacy, and SignOut. |
| Automatic user sign in | Specify whether your users should be able to elect to be signed in automatically the next time they return to your application, and if so, specify how many seconds the user should stay signed in (unless they click Sign out or delete their cookies). |