Microsoft HealthVault provides access to health and fitness data through XML web services. The following schemas describe how data is stored (thing types) and what the XML web-service methods that can be used to access the data.
The methods that can be used to communicate with the Microsoft Health Service.
| Method Name | Version | Summary |
|---|---|---|
| AddApplication | 1 | Adds an application configuration. |
| AllocatePackageId | 1 | The unique identity code (to access the package) or failure result. |
| BeginPutBlob | 1 | The authentication token to be supplied with a streaming put blob request. |
| BeginPutConnectPackageBlob | 1 | <Documentation pending> |
| CreateAuthenticatedSessionToken | 1 | Provides a way for clients to establish an authenticated session with Microsoft HealthVault. |
| CreateAuthenticatedSessionToken2 | 1 | Provides a way for clients to establish an authenticated session with Microsoft HealthVault. |
| CreateConnectPackage | 1 | Creates a package containing a data that the user can claim using the identity code returned by this method |
| CreateConnectPackage2 | 1 | Creates a package containing a data that the user can claim using the identity code returned by this method |
| CreateConnectRequest | 1 | Creates a connect request which will allow the user to tie their HealthVault account to the calling application once the user validates the connect request. |
| DeleteOpenQuery | 1 | Deletes a saved open query given the query identifier. |
| DeletePendingConnectPackage | 1 | Deletes the pending connect package. |
| DeletePendingConnectRequest | 1 | Deletes the pending connect request for the supplied external id. |
| GetApplicationInfo | 1 | Retrieves the settings for the current application. |
| GetApplicationSettings | 1 | Gets the application specific settings for the person. |
| GetAuthorizedConnectRequests | 1 | Returns all found authorized connect requests associated with the calling application. |
| GetAuthorizedPeople | 1 | Gets information about the people that are authorized for an application. |
| GetAuthorizedRecords | 1 | Gets information about the specified health records for which the authenticated person is authorized to use with the calling application. |
| GetOpenQueryInfo | 1 | Retrieves information about a saved open query given the query identifier. |
| GetPersonInfo | 1 | Gets basic information about the authenticated person. |
| GetServiceDefinition | 1 | Gets information about Microsoft HealthVault and its related features. |
| GetServiceDefinition2 | 1 | Gets information about Microsoft HealthVault and its related features. |
| GetThings | 1 | Schema for the GetThings method request. |
| GetThings3 | 1 | Schema for the GetThings3 method request. |
| GetThingType | 1 | This method is used to get information about supported thing types |
| GetUpdatedRecordsForApplication | 1 | Gets a list of records for an application with things that have been updated since a specified date. |
| GetValidGroupMembership | 1 | Gets a list of valid things of type Group Membership. |
| GetVocabulary | 1 | This method is used to get the code items associated with a vocabulary. |
| NewSignupCode | 1 | The unique signup code or failure result. |
| OverwriteThings | 1 | This method allows a Thing to be updated even if the type version is less than the instance type version that already exists. |
| OverwriteThings2 | 1 | This method allows a Thing to be updated even if the type version is less than the instance type version that already exists. |
| PutThings | 1 | This method allows a Thing to be created or updated. |
| PutThings2 | 1 | This method allows a Thing to be created or updated. |
| QueryPermissions | 1 | Gets the permissions the authenticated person has for the specified thing type for the specified record. |
| RemoveThings | 1 | This method deletes things from a record. |
| SaveOpenQuery | 1 | Saves an open query and returns the query identifier. |
| SearchVocabulary | 1 | This method is used to search a vocabulary and retrieve the code items that match a given search criteria. |
| SendInsecureMessage | 1 | Sends an insecure email message to the specified recipients. |
| SendInsecureMessageFromApplication | 1 | Sends an insecure email message originating from the application to the specified recipients. |
| SetApplicationSettings | 1 | Sets the application specific settings for the person. |
| UpdateApplication | 1 | Updates an application configuration. |
| UpdateExternalId | 1 | Updates the external id for a connect request. |
Schemas for the types of data that can be stored and retrieved from the Microsoft Health Service.
| Thing Type Name | Version | Summary |
|---|---|---|
| Advance Directive | 1 | A single advance directive. |
| Aerobic Exercise Session | 1 | A single session of aerobic exercise. |
| Aerobic Profile | 1 | A summary of a person's aerobic condition. |
| Allergic Episode | 1 | Information related to a single instance of an allergic reaction. |
| Allergy | 1 | Information related to an allergy. |
| Application Data Reference | 1 | Information that can be used by an application to render content from another application. |
| Application-Specific Information | 1 | Defines a thing type to store arbitrary application data. |
| Appointment | 1 | Information related to a medical appointment. |
| Asthma Inhaler | 1 | Any inhaler unit used to treat asthma. |
| Asthma Inhaler Usage | 1 | A single use of an inhaler. |
| Basic Demographic Information | 1 | Defines a set of data about the health record that is considered not to be personally-identifiable. |
| Blood Glucose Measurement | 1 | Defines a single blood glucose reading. |
| Blood Oxygen Saturation | 1 | Percentage of oxygen saturation in the blood. |
| Blood Pressure Measurement | 1 | Defines a single blood pressure reading. |
| Body Composition | 1 | Information about the body composition of the record owner. |
| Body Dimension | 1 | Stores a body dimension. |
| Calorie Guideline | 1 | Stores suggested calorie intake guidelines. |
| Cardiac Profile | 1 | A summary of a person's cardiac condition. |
| Cholesterol Profile (Lipid Profile) | 1 | Cholesterol test results. Also referred to as lipid profile. |
| Concern | 1 | A concern that a person has about a condition or life issue. |
| Condition | 1 | Defines a single health or medical issue/problem. |
| Contact | 1 | This is the contact information for the person owning a health record in Microsoft HealthVault. |
| Contraindication | 1 | Information related to an contraindication. |
| Daily Dietary Intake | 1 | The amount of dietary nutrients and minerals consumed in a day. |
| Daily Medication Usage | 1 | Record regular medication and dietary supplement usage. |
| Device | 1 | Information related to medical equipment. |
| Diabetes Insulin Injection Usage | 1 | A single use of an insulin-injection. |
| Diabetic Profile | 1 | A summary of a person's diabetic condition. |
| Discharge Summary | 1 | Information related to the discharge summary. |
| Emergency or Provider Contact | 1 | Information related to a contact. |
| Emotional State | 1 | A subjective record of an emotional state. |
| Encounter | 2 | Information related to a medical encounter. |
| Encounter | 1 | Information related to a medical encounter. |
| Exercise | 2 | Records the completion of an exercise. |
| Exercise Samples | 1 | Stores a set of samples related to an exercise. |
| Family History | 2 | A condition of a relative. |
| Family History | 1 | Information related to a family history. |
| Family History Condition | 1 | A condition of a relative. |
| FamilyHistoryPerson | 1 | Information about a relative of the record owner. |
| File | 1 | Defines the schema for a file which can be uploaded to Microsoft HealthVault. |
| Genetic SNP Result | 1 | Stores a collection of results of a SNP genetic test. |
| Group Membership | 1 | Memberships of the record owner. |
| Group Membership Activity | 1 | Describes an activity related to group membership. |
| HbA1C Measurement | 1 | Defines a single HbA1C reading. |
| Health Assessment | 1 | Contains the results of a health assessment. |
| HealthCare Proxy | 1 | Information related to a healthcare proxy. |
| Heart Rate | 1 | A measurement of the record owner's heart rate. |
| Height Measurement | 1 | Information about a height measurement. |
| Immunization | 2 | Information related to an immunization. |
| Immunization | 1 | Information related to an immunization. |
| Insulin Injection | 1 | Any insulin injection used to treat diabetes. |
| Insurance Plan | 1 | Information about the person or organization that pays for health and medical related bills. |
| Lab Test Result | 1 | A series of lab test results. |
| Lab Test Result | 1 | Information related to a lab test. |
| Life Goal | 1 | An unmeasurable "checklist" goal of the type you might stick up on the fridge as a New Year's resolution. |
| Link | 1 | Defines the schema for a web link saved as a favorite in Microsoft HealthVault. |
| Medical Annotation | 1 | Information related to a medical annotation. |
| Medical Image Study | 1 | A study containing medical images. |
| Medical Problem | 1 | Information related to a medical problem (please see remarks). |
| Medication | 2 | Information related to a medication. |
| Medication | 1 | Information related to a medication. |
| Medication Fill | 1 | Information related to filling a medication. |
| Microbiology Lab Test Result | 1 | Information related to a microbiology lab test. |
| Password Protected Package | 1 | Defines the schema for a package that can contain a pkcs5v2 encrypted blob. |
| Peak Flow Measurement | 2 | A peak flow measurement. |
| Personal Demographic Information | 1 | Personal demographic information this is more sensitve in nature. |
| Personal Image | 1 | An image that represents the person. |
| Pregnancy | 1 | Record of a pregnancy. |
| Procedure | 1 | Information related to a procedure. |
| Procedure | 2 | Information related to a procedure. |
| Question Answer | 1 | A question that was asked and the answers given. |
| Radiology Lab Result | 1 | Information related to a radiology lab results. |
| Respiratory Profile | 1 | A summary of a person's respiratory condition. |
| Sleep Related Activity | 1 | Defines an evening sleep journal. |
| Sleep Session | 1 | Schema for a morning sleep journal. |
| Spirometer Measurement | 1 | A single reading from a spirometer. |
| Status | 1 | Stores status information about a specific health record item. |
| Vital Signs | 1 | Information related to vital signs. |
| Weekly Aerobic Exercise Goal | 1 | Defines a weekly goal for aerobic exercise. |
| Weight Goal | 1 | A target weight range with an associated target date. |
| Weight Measurement | 1 | A single weight measurement. |
The schemas that get included into the method or thing type schemas.
| Namespace | Summary |
|---|---|
| urn:astm-org:CCR | |
| urn:com.microsoft.wc.application | <Documentation pending> |
| urn:com.microsoft.wc.auth | <Documentation pending> |
| urn:com.microsoft.wc.authMethod | <Documentation pending> |
| urn:com.microsoft.wc.dates | <Documentation pending> |
| urn:com.microsoft.wc.person | <Documentation pending> |
| urn:com.microsoft.wc.record | <Documentation pending> |
| urn:com.microsoft.wc.request | <Documentation pending> |
| urn:com.microsoft.wc.response | <Documentation pending> |
| urn:com.microsoft.wc.thing | <Documentation pending> |
| urn:com.microsoft.wc.thing.types | Types that are used across multiple thing types. |
| urn:com.microsoft.wc.types | <Documentation pending> |
| urn:com.microsoft.wc.vocab | Defines common types for interfacing with vocabularies in the system. |
| urn:hl7-org:v3 | <Documentation pending> |