AsthmaInhaler AsthmaInhaler AsthmaInhaler Class

Definition

Represents a health record item that encapsulates an asthma inhaler.

public class AsthmaInhaler : Microsoft.Health.HealthRecordItem
type AsthmaInhaler = class
    inherit HealthRecordItem
Public Class AsthmaInhaler
Inherits HealthRecordItem
Inheritance

Remarks

This class can represent any inhaler unit used to treat asthma. The inhaler may or may not have a device component to it. Each new canister should be represented by a new AsthmaInhaler instance, even if there is a containing device that is reusable. Changes in regimen (minimum/maximum doses per day) should also cause a new health record item to be created.

Constructors

AsthmaInhaler() AsthmaInhaler() AsthmaInhaler()

Creates a new instance of the AsthmaInhaler class with default values.

AsthmaInhaler(ApproximateDateTime, CodableValue) AsthmaInhaler(ApproximateDateTime, CodableValue) AsthmaInhaler(ApproximateDateTime, CodableValue)

Creates a new instance of the AsthmaInhaler class specifying the mandatory values.

Fields

TypeId TypeId TypeId

Retrieves the unique identifier for the item type.

Properties

Alerts Alerts Alerts

Gets a collection of alerts for the inhaler.

CanAlert CanAlert CanAlert

Gets or sets a value indicating whether the inhaler can show alerts.

CommonData CommonData CommonData

Gets the common data for the HealthRecordItem.

(Inherited from HealthRecordItem)
Created Created Created

Gets the audit information associated with the creation of this health record item.

(Inherited from HealthRecordItem)
DeviceId DeviceId DeviceId

Gets or sets the identifier for the device.

Drug Drug Drug

Gets or sets the drug being used in the inhaler.

EffectiveDate EffectiveDate EffectiveDate

Gets or sets the date and time that the health record item data was taken.

(Inherited from HealthRecordItem)
EffectivePermissions EffectivePermissions EffectivePermissions

Gets the effective permissions on the item granted to the person retrieving the HealthRecordItem.

(Inherited from HealthRecordItem)
ExpirationDate ExpirationDate ExpirationDate

Gets or sets the date and time when the canister has clinically expired.

Flags Flags Flags

Gets the HealthRecordItem flags.

(Inherited from HealthRecordItem)
HealthRecordItemSignatures HealthRecordItemSignatures HealthRecordItemSignatures

Gets the signatures for the HealthRecordItem.

(Inherited from HealthRecordItem)
InitialDoses InitialDoses InitialDoses

Gets or sets the number of doses in the unit at the time of item creation.

IsDownVersioned IsDownVersioned IsDownVersioned

Gets the value indicating if the HealthRecordItem is down-versioned.

(Inherited from HealthRecordItem)
IsImmutable IsImmutable IsImmutable

Gets a value indicating whether the HealthRecordItem is immutable.

(Inherited from HealthRecordItem)
IsPersonal IsPersonal IsPersonal

Gets or sets the value indicating if the HealthRecordItem is private.

(Inherited from HealthRecordItem)
IsReadOnly IsReadOnly IsReadOnly

Gets a value indicating whether HealthRecordItem is read-only.

(Inherited from HealthRecordItem)
IsUpVersioned IsUpVersioned IsUpVersioned

Gets the value indicating if the HealthRecordItem is up-versioned.

(Inherited from HealthRecordItem)
Key Key Key

Gets the key of the health record item.

(Inherited from HealthRecordItem)
LastUpdated LastUpdated LastUpdated

Gets the audit information associated with the last update of this health record item.

(Inherited from HealthRecordItem)
MaximumDailyDoses MaximumDailyDoses MaximumDailyDoses

Gets or sets the maximum number of doses that should be taken each day.

MinimumDailyDoses MinimumDailyDoses MinimumDailyDoses

Gets or sets the minimum number of doses that should be taken each day.

Purpose Purpose Purpose

Gets or sets the count of doses for each inhaler use.

Sections Sections Sections

Gets the data sections that this HealthRecordItem represents.

(Inherited from HealthRecordItem)
StartDate StartDate StartDate

Gets or sets the date and time when the inhaler use began.

State State State

Gets the state of the HealthRecordItem.

(Inherited from HealthRecordItem)
StopDate StopDate StopDate

Gets or sets the date and time when the inhaler was retired.

Strength Strength Strength

Gets or sets the textual description of the drug strength (e.g., '44 mcg / puff').

Tags Tags Tags

Gets the list of tags on the HealthRecordItem.

(Inherited from HealthRecordItem)
TransformedXmlData TransformedXmlData TransformedXmlData

Gets the transformed XML data of the HealthRecordItem.

(Inherited from HealthRecordItem)
TypeName TypeName TypeName

Gets the health record item type name.

(Inherited from HealthRecordItem)
TypeSpecificData TypeSpecificData TypeSpecificData

Gets or sets the XML representation of the type-specific data for the HealthRecordItem.

(Inherited from HealthRecordItem)
UpdatedEndDate UpdatedEndDate UpdatedEndDate

Gets or sets the date when HealthRecordItem is not relevant.

(Inherited from HealthRecordItem)

Methods

GetBlobStore(ConnectPackageCreationParameters) GetBlobStore(ConnectPackageCreationParameters) GetBlobStore(ConnectPackageCreationParameters)

Gets the BLOB store for this health record item.

(Inherited from HealthRecordItem)
GetBlobStore(HealthRecordAccessor) GetBlobStore(HealthRecordAccessor) GetBlobStore(HealthRecordAccessor)

Gets the BLOB store for this health record item.

(Inherited from HealthRecordItem)
GetItemXml() GetItemXml() GetItemXml()

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetItemXml(HealthRecordItemSections) GetItemXml(HealthRecordItemSections) GetItemXml(HealthRecordItemSections)

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetItemXml(HealthRecordItemSections, String) GetItemXml(HealthRecordItemSections, String) GetItemXml(HealthRecordItemSections, String)

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetItemXml(String) GetItemXml(String) GetItemXml(String)

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetSizeInBytes() GetSizeInBytes() GetSizeInBytes()

Gets the size of the health record item which will be added to the quota used in the person's health record.

(Inherited from HealthRecordItem)
IsSignatureValid() IsSignatureValid() IsSignatureValid()

Checks if the health record item's signature is valid.

(Inherited from HealthRecordItem)
ParseXml(IXPathNavigable) ParseXml(IXPathNavigable) ParseXml(IXPathNavigable)

Populates this AsthmaInhaler instance from the data in the XML.

Serialize() Serialize() Serialize()

Gets the XML representation of the item for serialization.

(Inherited from HealthRecordItem)
Sign(X509Certificate2) Sign(X509Certificate2) Sign(X509Certificate2)

Signs the HealthRecordItem with a digital signature.

(Inherited from HealthRecordItem)
ToString() ToString() ToString()

Gets a string representation of the asthma inhaler item.

ValidateCertificate() ValidateCertificate() ValidateCertificate()

Checks if the certificates are valid.

(Inherited from HealthRecordItem)
WriteXml(XmlWriter) WriteXml(XmlWriter) WriteXml(XmlWriter)

Writes the asthma inhaler data to the specified XmlWriter.

Applies to