Microsoft Health Schemas

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.

Web-service Methods

The methods that can be used to communicate with the Microsoft Health Service.

Method NameVersionSummary
AddApplication1,2 Adds an application configuration.
AllocatePackageId1 The unique identity code (to access the package) or failure result.
BeginPutBlob1 The authentication token to be supplied with a streaming put blob request.
BeginPutConnectPackageBlob1
<Documentation pending>
CreateAuthenticatedSessionToken1 Provides a way for clients to establish an authenticated session with Microsoft HealthVault.
CreateAuthenticatedSessionToken22 Provides a way for clients to establish an authenticated session with Microsoft HealthVault.
CreateConnectPackage1 Creates a package containing a data that the user can claim using the identity code returned by this method
CreateConnectPackage22 Creates a package containing a data that the user can claim using the identity code returned by this method
CreateConnectRequest1 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.
DeletePendingConnectPackage1 Deletes the pending connect package.
DeletePendingConnectRequest1 Deletes the pending connect request for the supplied external id.
GetAlternateIds1
<Documentation pending>
GetApplicationDirectory1 Gets information for HealthVault application directory
GetApplicationInfo1,2 Retrieves the settings for the current application.
GetApplicationSettings1 Gets the application specific settings for the person.
GetAuthorizedConnectRequests1 Returns all found authorized connect requests associated with the calling application.
GetAuthorizedPeople1 Gets information about the people that are authorized for an application.
GetAuthorizedRecords1 Gets information about the specified health records for which the authenticated person is authorized to use with the calling application.
GetDeviceDirectory1 Gets information for HealthVault device directory
GetMeaningfulUseTimelyAccessReport1 Retrieves Meaningful Use Timely Access Report for an application.
GetMeaningfulUseVDTReport1 Retrieves Meaningful Use VDT Report for an application.
GetPersonAndRecordForAlternateId1 Find the person and record ids associated with an alternate id.
GetPersonInfo1 Gets basic information about the authenticated person.
GetServiceDefinition1 This method is used to get information about Microsoft HealthVault and its related features.
GetServiceDefinition21 This method is used to get information about Microsoft HealthVault and its related features.
GetThings1,2 Schema for the GetThings method request.
GetThings33 Schema for the GetThings3 method request.
GetThingType1 This method is used to get information about supported thing types
GetUpdatedRecordsForApplication1 Gets a list of records for an application with things that have been updated since a specified date.
GetUpdatedRecordsForApplication21 The list of records and their corresponding person-ids for an application with things that have been updated since a specified date.
GetValidGroupMembership1 Gets a list of valid things of type Group Membership.
GetVocabulary1,2 This method is used to get the code items associated with a vocabulary.
NewApplicationCreationInfo1 Create information to register a new SODA application for an existing master SODA application.
NewSignupCode1 The unique signup code or failure result.
OverwriteThings1 This method allows a Thing to be updated even if the type version is less than the instance type version that already exists.
OverwriteThings22 This method allows a Thing to be updated even if the type version is less than the instance type version that already exists.
PutThings1 This method allows a Thing to be created or updated.
PutThings22 This method allows a Thing to be created or updated.
QueryPermissions1 Gets the permissions the authenticated person has for the specified thing type for the specified record.
RemoveThings1 This method deletes things from a record.
SearchVocabulary1 This method is used to search a vocabulary and retrieve the code items that match a given search criteria.
SelectInstance1 Schema for the SelectInstance method request.
SendInsecureMessage1 Sends an insecure email message to the specified recipients.
SendInsecureMessageFromApplication1 Sends an insecure email message originating from the application to the specified recipients.
SetApplicationSettings1 Sets the application specific settings for the person.
SubscribeToEvent1 Creates an event subscription for the calling application.
UnsubscribeToEvent1 Removes the subscription identified by the supplied id.
UpdateApplication1,2 Updates an application configuration.
UpdateEventSubscription1 Updates an event subscription for the calling application.
UpdateExternalId1 Updates the external id for a connect request.

XML Data Schemas (Thing Types)

Schemas for the types of data that can be stored and retrieved from the Microsoft Health Service.

Thing Type NameVersionSummary
Advance Directive1 A single advance directive.
Aerobic Exercise Session1 A single session of aerobic exercise.
Aerobic Profile1 A summary of a person's aerobic condition.
Allergic Episode1 Information related to a single instance of an allergic reaction.
Allergy1 Information related to an allergy.
Application Data Reference1 Information that can be used by an application to render content from another application.
Application-Specific Information1 Defines a thing type to store arbitrary application data.
Appointment1 Information related to a medical appointment.
Asthma Inhaler1 Any inhaler unit used to treat asthma.
Asthma Inhaler Usage1 A single use of an inhaler.
Basic Demographic Information1 Defines a set of data about the health record that is considered not to be personally-identifiable.
Basic Demographic Information2 Defines a set of data about the health record that is considered not to be personally-identifiable.
Blood Glucose Measurement1 Defines a single blood glucose reading.
Blood Oxygen Saturation1 Percentage of oxygen saturation in the blood.
Blood Pressure Measurement1 Defines a single blood pressure reading.
Blue Button Text File1 Defines the schema for a Blue Button text file which can be uploaded to Microsoft HealthVault.
Body Composition1 Information about the body composition of the record owner.
Body Dimension1 Stores a body dimension.
Calorie Guideline1 Stores suggested calorie intake guidelines.
Cardiac Profile1 A summary of a person's cardiac condition.
CarePlan1 Information related to a care plan and tasks, goals associated with the care plan.
Cholesterol Measurement1 Defines a single cholesterol reading.
comment1 A comment associated with another data item.
Concern1 A concern that a person has about a condition or life issue.
Condition1 Defines a single health or medical issue/problem.
Contact1 This is the contact information for the person owning a health record in Microsoft HealthVault.
Contraindication1 Information related to an contraindication.
Daily Dietary Intake1 The amount of dietary nutrients and minerals consumed in a day.
Daily Medication Usage1 Record regular medication and dietary supplement usage.
Defibrillator Episode1 Defines implantable defibrillator episode data.
Device1 Information related to medical equipment.
Diabetes Insulin Injection Usage1 A single use of an insulin-injection.
Diabetic Profile1 A summary of a person's diabetic condition.
Dietary Intake1 The amount of dietary nutrients and minerals consumed.
Discharge Summary1 Information related to the discharge summary.
Education Document1 Defines the schema for an education document which can be uploaded to Microsoft HealthVault.
Emergency or Provider Contact1 Information related to a contact.
Emotional State1 A subjective record of an emotional state.
Encounter1 Information related to a medical encounter.
Encounter2 Information related to a medical encounter.
Exercise2 Records the completion of an exercise.
Exercise Samples1 Stores a set of samples related to an exercise.
Explanation of Benefits1 Describes the benefits received from an insurance plan.
Family History1 Information related to a family history.
Family History2 A condition of a relative.
Family History Condition1 A condition of a relative.
FamilyHistoryPerson1 Information about a relative of the record owner.
File1 Defines the schema for a file which can be uploaded to Microsoft HealthVault.
Genetic SNP Result1 Stores a collection of results of a SNP genetic test.
Group Membership1 Memberships of the record owner.
Group Membership Activity1 Describes an activity related to group membership.
HbA1C Measurement1 Defines a single HbA1C reading.
Health Assessment1 Contains the results of a health assessment.
Health Event1 Represents a health event.
HealthCare Proxy1 Information related to a healthcare proxy.
HealthGoal1 A health goal defines a target for a measurement or action to be performed by a user.
HealthJournalEntry1 Information related to a health journal entry.
Heart Rate1 A measurement of the record owner's heart rate.
Height Measurement1 Information about a height measurement.
Immunization2 Information related to an immunization.
Immunization1 Information related to an immunization.
Insulin Injection1 Any insulin injection used to treat diabetes.
Insurance Plan1 Information about the person or organization that pays for health and medical related bills.
Lab Test Result1 Information related to a lab test.
Lab Test Result1 A series of lab test results.
Life Goal1 An unmeasurable "checklist" goal of the type you might stick up on the fridge as a New Year's resolution.
Link1 Defines the schema for a web link saved as a favorite in Microsoft HealthVault.
Meal Definition1 A meal definition can be used to define typical meals that might be consumed, such as meals a user commonly eats or meals associated with a particular diet plan. This type should not be used for storing consumption data, it is intended only to define the contents of what a meal may contain.
Medical Annotation1 Information related to a medical annotation.
Medical Image Study1 A study containing medical images.
Medical Problem1 Information related to a medical problem (please see remarks).
Medication2 Information related to a medication.
Medication1 Information related to a medication.
Medication Fill1 Information related to filling a medication.
Message1 The Message type is used to store a multipart message, including message text and attachments.
Microbiology Lab Test Result1 Information related to a microbiology lab test.
MyData Education File1 Defines the schema for a MyData education file which can be uploaded to Microsoft HealthVault.
PAP Session1 The Positive Airway Pressure (PAP) Session records data collected during a PAP session. A common use for PAP therapy is in the treatment of sleep apnea.
Password Protected Package1 Defines the schema for a package that can contain a pkcs5v2 encrypted blob.
Peak Flow Measurement2 A peak flow measurement.
Personal Demographic Information1 Personal demographic information this is more sensitve in nature.
Personal Image1 An image that represents the person.
Pregnancy1 Record of a pregnancy.
Procedure1 Information related to a procedure.
Procedure2 Information related to a procedure.
Question Answer1 A question that was asked and the answers given.
Radiology Lab Result1 Information related to a radiology lab results.
Respiratory Profile1 A summary of a person's respiratory condition.
Sleep Related Activity1 Defines an evening sleep journal.
Sleep Session1 Schema for a morning sleep journal.
Spirometer Measurement1 A single reading from a spirometer.
Status1 Stores status information about a specific health record item.
Vital Signs1 Information related to vital signs.
Weekly Aerobic Exercise Goal1 Defines a weekly goal for aerobic exercise.
Weight Goal1 A target weight range with an associated target date.
Weight Measurement1 A single weight measurement.

Other Schemas

The schemas that get included into the method or thing type schemas.

NamespaceSummary
http://www.sifinfo.org/infrastructure/2.x
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.direct
<Documentation pending>
urn:com.microsoft.wc.directory
<Documentation pending>
urn:com.microsoft.wc.location Schema for types representing location information supported for a given health record, application or device.
urn:com.microsoft.wc.MeaningfulUse
urn:com.microsoft.wc.messages
<Documentation pending>
urn:com.microsoft.wc.notification
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.subscription
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:sdtc
<Documentation pending>
urn:hl7-org:v3
<Documentation pending>