HealthRecordInfo HealthRecordInfo HealthRecordInfo Class

Definition

Represents the APIs and information about a health record for an individual.

public class HealthRecordInfo : Microsoft.Health.HealthRecordAccessor, Microsoft.Health.IMarshallable
type HealthRecordInfo = class
    inherit HealthRecordAccessor
    interface IMarshallable
Public Class HealthRecordInfo
Inherits HealthRecordAccessor
Implements IMarshallable
Inheritance
Implements

Remarks

A HealthRecordInfo represents a person's view of a health record and

information about the health record such as the state, name, date of

expiration, and so on. This view may vary based upon the access rights the

person has to the record and multiple people may have access to the

same record but have different views. For instance, a husband may

have a HealthRecordInfo instance for himself and another for his

wife's health record which she shared with him.

Constructors

HealthRecordInfo(ApplicationConnection, Guid) HealthRecordInfo(ApplicationConnection, Guid) HealthRecordInfo(ApplicationConnection, Guid)

Creates a new instance of the HealthRecordInfo class, providing a new view of a personal health record.

Properties

ApplicationSpecificRecordId ApplicationSpecificRecordId ApplicationSpecificRecordId

Gets the application specific record id for the specified record and application.

Connection Connection Connection

Gets a reference to the HealthVault service that created this HealthRecordAccessor.

(Inherited from HealthRecordAccessor)
DateAuthorizationExpires DateAuthorizationExpires DateAuthorizationExpires

Gets the date/time that the authorization for the record expires.

DateCreated DateCreated DateCreated

Gets the date the record was created, in UTC.

DateUpdated DateUpdated DateUpdated

Gets the date the record was updated, in UTC.

DisplayName DisplayName DisplayName

Gets the display name of the record.

HasAuthorizationExpired HasAuthorizationExpired HasAuthorizationExpired

true if the authorization of the authenticated person has expired for this record; otherwise, false.

HealthRecordAuthorizationStatus HealthRecordAuthorizationStatus HealthRecordAuthorizationStatus

Gets the HealthRecordAuthorizationStatus for the record.

Id Id Id

Gets the record identifier.

(Inherited from HealthRecordAccessor)
IsCustodian IsCustodian IsCustodian

Gets a value indicating whether or not the person is a custodian of the record.

LatestOperationSequenceNumber LatestOperationSequenceNumber LatestOperationSequenceNumber

Gets the record's latest operation sequence number.

Location Location Location

Gets the location of the person that this record is for.

(Inherited from HealthRecordAccessor)
Name Name Name

Gets the name of the record.

QuotaInBytes QuotaInBytes QuotaInBytes

Gets the maximum total size in bytes that the HealthRecordItems in the HealthRecordInfo can occupy.

QuotaUsedInBytes QuotaUsedInBytes QuotaUsedInBytes

Gets the total size in bytes that the HealthRecordItems in the HealthRecordInfo currently occupy.

RecordAppAuthCreatedDate RecordAppAuthCreatedDate RecordAppAuthCreatedDate

Gets the date when the user authorized the application to the record, in UTC.

RelationshipName RelationshipName RelationshipName

Gets the localized string representing the relationship between the person authorized to view this record and the owner of the record.

RelationshipType RelationshipType RelationshipType

Gets the relationship the person authorized to view this record has with the "owner" of the record.

State State State

Gets the state of a HealthRecordInfo.

Methods

AssociateAlternateId(String) AssociateAlternateId(String) AssociateAlternateId(String)

Associates an alternate ID with this record.

(Inherited from HealthRecordAccessor)
CreateFromXml(ApplicationConnection, XPathNavigator) CreateFromXml(ApplicationConnection, XPathNavigator) CreateFromXml(ApplicationConnection, XPathNavigator)

Creates an instance of a HealthRecordInfo object using the specified XML.

CreateSearcher() CreateSearcher() CreateSearcher()

Creates a new HealthRecordSearcher for this record.

(Inherited from HealthRecordAccessor)
CreateSearcher(Guid[]) CreateSearcher(Guid[]) CreateSearcher(Guid[])

Creates a new HealthRecordSearcher for a list of specific types.

(Inherited from HealthRecordAccessor)
DisassociateAlternateId(String) DisassociateAlternateId(String) DisassociateAlternateId(String)

Disassociates an alternate ID with a record.

(Inherited from HealthRecordAccessor)
GetAlternateIds() GetAlternateIds() GetAlternateIds()

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

(Inherited from HealthRecordAccessor)
GetFromAlternateId(ApplicationConnection, String) GetFromAlternateId(ApplicationConnection, String) GetFromAlternateId(ApplicationConnection, String)

Look up the record that were previously associated with this alternate id.

GetItem(Guid) GetItem(Guid) GetItem(Guid)

Gets the health record item specified by its ID.

(Inherited from HealthRecordAccessor)
GetItem(Guid, HealthRecordItemSections) GetItem(Guid, HealthRecordItemSections) GetItem(Guid, HealthRecordItemSections)

Gets the health record item specified by its ID.

(Inherited from HealthRecordAccessor)
GetItemsByType(Guid) GetItemsByType(Guid) GetItemsByType(Guid)

Gets the health record items related to this record filtered on the specified type.

(Inherited from HealthRecordAccessor)
GetItemsByType(Guid, HealthRecordItemSections) GetItemsByType(Guid, HealthRecordItemSections) GetItemsByType(Guid, HealthRecordItemSections)

Gets the health record items related to this record filtered on the specified type.

(Inherited from HealthRecordAccessor)
GetItemsByType(Guid, HealthRecordView) GetItemsByType(Guid, HealthRecordView) GetItemsByType(Guid, HealthRecordView)

Gets the health record items related to this record filtered on the specified type.

(Inherited from HealthRecordAccessor)
GetValidGroupMembership(IList<Guid>) GetValidGroupMembership(IList<Guid>) GetValidGroupMembership(IList<Guid>)

Gets valid group memberships for a record.

(Inherited from HealthRecordAccessor)
GetXml() GetXml() GetXml()

Gets the XML representation of the HealthRecordInfo.

Marshal(XmlWriter) Marshal(XmlWriter) Marshal(XmlWriter)

Writes the record information into the specified writer as XML.

NewItem(HealthRecordItem) NewItem(HealthRecordItem) NewItem(HealthRecordItem)

Creates a new health record item associated with this record in the HealthVault service.

(Inherited from HealthRecordAccessor)
NewItems(IList<HealthRecordItem>) NewItems(IList<HealthRecordItem>) NewItems(IList<HealthRecordItem>)

Creates new health record items associated with the record.

(Inherited from HealthRecordAccessor)
QueryPermissions(IList<Guid>) QueryPermissions(IList<Guid>) QueryPermissions(IList<Guid>)

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

(Inherited from HealthRecordAccessor)
QueryPermissions(IList<HealthRecordItemTypeDefinition>) QueryPermissions(IList<HealthRecordItemTypeDefinition>) QueryPermissions(IList<HealthRecordItemTypeDefinition>)

Returns a list of HealthRecordItemTypePermission objects which represent the permissions that the current authenticated person has for the HealthRecordItemTypes specified in the current health record when using the current application.

(Inherited from HealthRecordAccessor)
QueryPermissionsByTypes(IList<Guid>) QueryPermissionsByTypes(IList<Guid>) QueryPermissionsByTypes(IList<Guid>)

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

(Inherited from HealthRecordAccessor)
QueryRecordPermissions(IList<Guid>) QueryRecordPermissions(IList<Guid>) QueryRecordPermissions(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 MeaningfulUseOptIn.

(Inherited from HealthRecordAccessor)
Refresh() Refresh() Refresh()

Updates the HealthRecordInfo instance with data from the server using the Id.

RemoveApplicationAuthorization() RemoveApplicationAuthorization() RemoveApplicationAuthorization()

Releases the authorization of the application on the health record.

(Inherited from HealthRecordAccessor)
RemoveItem(HealthRecordItem) RemoveItem(HealthRecordItem) RemoveItem(HealthRecordItem)

Marks the specified health record item as deleted.

(Inherited from HealthRecordAccessor)
RemoveItem(HealthRecordItemKey) RemoveItem(HealthRecordItemKey) RemoveItem(HealthRecordItemKey)

Marks the specified health record item as deleted.

(Inherited from HealthRecordAccessor)
RemoveItems(IList<HealthRecordItem>) RemoveItems(IList<HealthRecordItem>) RemoveItems(IList<HealthRecordItem>)

Marks the specified health record item as deleted.

(Inherited from HealthRecordAccessor)
RemoveItems(IList<HealthRecordItemKey>) RemoveItems(IList<HealthRecordItemKey>) RemoveItems(IList<HealthRecordItemKey>)

Marks the specified health record item as deleted.

(Inherited from HealthRecordAccessor)
SendMessageToCustodiansFromApplication(Boolean, String, String, String, String, String) SendMessageToCustodiansFromApplication(Boolean, String, String, String, String, String) SendMessageToCustodiansFromApplication(Boolean, String, String, String, String, String)

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

(Inherited from HealthRecordAccessor)
ToString() ToString() ToString()

Gets the name of the record.

Unmarshal(XmlReader) Unmarshal(XmlReader) Unmarshal(XmlReader)

Populates the data of the class from the XML in the specified reader.

UpdateItem(HealthRecordItem) UpdateItem(HealthRecordItem) UpdateItem(HealthRecordItem)

Updates the specified health record item.

(Inherited from HealthRecordAccessor)
UpdateItems(IList<HealthRecordItem>) UpdateItems(IList<HealthRecordItem>) UpdateItems(IList<HealthRecordItem>)

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

(Inherited from HealthRecordAccessor)

Applies to