Skip to main content

How-To Guides

These how-to guides cover a variety of topics to help you develop your application.

Basic Information

Generating an ApplicationID

The steps for generating your own ApplicationID, generating a public/private key pair, providing the information to the HealthVault team, and installing and configuring the certificate.

Master and Child Application IDs

Explains when and how to use master and child application IDs.

HealthVault Environments and URLs

Information about the HealthVault Developer environment and the HealthVault Consumer environment.

HealthVault Hello World Application

Instructions for creating a HealthVault Hello World application.

Creating a HealthVault SODA Client Application

Instructions for creating a simple HealthVault SODA client application.

Interacting with ActionUrl

Each application must register an ActionUrl on the HealthVault server. The page at this ActionUrl should be capable of understanding ten different targets that can be passed to the application by the HealthVault Web site.

Customizing HealthVault Redirection

Dynamically redirecting and handling shell targets

HealthVault Shell Redirect Interfaces

Information about interfaces between Web applications and the HealthVault Shell

Batching Queries

Information about batching queries and deciding when to use batching.

Uploading a File to HealthVault

Code for the file wrapper you can use to upload files to HealthVault.

Configuring the Network Firewall

Enabling firewall ports.

Connecting a Clinical System to HealthVault

Master and Child Application IDs

Master and child application IDs can be used for single-practice systems and for multi-physician or multi-practice online services, such as online electronic medical records and e-prescribing services.

Connecting a Back-End Clinical System to HealthVault

Make sure that patient data is sent to the right person's HealthVault record from a clinical system that has no online front-end for the patient.

Patient and Provider Data Exchange Stories

Review example scenarios of data exchange between HealthVault and a HealthVault-compatible clinical system.

Connection Center

Enabling HealthVault Connection Center to Detect a non-PnP Health Device Automatically

Strategies for working around issues with non-PnP buses

HealthVault Connection Center Guide for Solution Providers

You can control the way your application or device appears in HealthVault Connection Center.

Switching Connection Center Between Developer and Consumer Environments

Using reg files or add-in wrapper icons to switch between environments

Devices

Code 10 Errors with WPD Drivers

Steps to debug your device driver when you receive a "This device cannot start. (Code 10)" error message

HealthVault Devices and WPD Technology

Information about Windows Portable Devices (WPD) technology used for HealthVault-compatible devices

Data Types

Extending HealthVault Data Types

How to add an extension to an existing data type.

HealthVault Data Types: Custom Data Types

If the data type you need doesn't already exist, you need to create a custom data type. If you need more than one custom data type, you need to create a wrapper that you can use with each custom data type.

Requesting a new Data Type

Information on how to contact the HealthVault team to create a new platform Data Type. This is useful when you think your date can be used across multiple HealthVault ecosystem applications.

HealthVault Data Types: HealthRecordItem

Information about the properties of the HealthRecordItem data type

HealthVault Data Types: Weight, Measurements, and Display Values

Converting measurement units between display values and stored values

HealthVault Data Types: PersonalImage

Information about and code for the PersonalImage type, which encapsulates the picture in a person's health record.

Tracking HealthVault Data Items

Using different views to track the history of a data item

Vocabularies and CodableValue

Working with vocabularies, and with CodedValue types and CodableValue within a vocabulary.

Scheming for Schema

Accessing schemas programmatically.

Storing CCR and CCD Data in HealthVault

Working with Continuity of Care Records and Continuity of Care Documents in HealthVault

Using CCR Data in HealthVault

Information about using CCR data in HealthVault, including detailed descriptions of the transforms used to import and export data to and from a CCR.

Data Types and Versioning

Keeping original versions of data types distinct from updated versions

Version Stamps on Data Items

Explains the use of version stamps

Security

Authentication, Authorization, and Single Sign-In

How to redirect to the HealthVault Shell’s authentication and authorization pages, plus some information on simulating single sign-in using an offline connection

Optional Authorization

Optional authorization allows the user to authorize access to individual data types.

Building a Multi-Record Application

A few details on building an application that can work with multiple health records simultaneously. This is in contrast to a Single-Record Application that always operates with a single record in scope.

Creating a Private Key-Public Key Pair

The HealthVault platform relies on asymmetric key cryptography to ensure that a rogue application cannot imitate a legitimate application. This document describes how to generate your private key – public key pair and register the public key with HealthVault.

Offline Access

Offline connections can be used to simulate single sign-in or to allow a batch process to read to and write from HealthVault records.

Digital Signatures

Using digital signatures to verify the sources of data items

Configuring the Network Firewall

Enabling firewall ports.

Code Access Security Requirements for HealthVault Applications

CAS permissions and security demands required to run a HealthVault ASP.NET application.

Troubleshooting and Debugging

Code 10 Errors with WPD Drivers

Steps to debug your device driver when you receive a "This device cannot start. (Code 10)" error message

Request-Response Tracing

Useful for debugging traffic between your application and the HealthVault servers

Troubleshooting Application Connection Problems

A few things to try if you are having connection issues with your HealthVault application

Troubleshooting Certificate and Network Problems

Using the Troubleshooting utility to diagnose certificate and network problems