Class HsPrescriptionType
A data type for the details of written instructions from a physician or dentist to a druggist concerning the form and dosage of a drug to be issued to a given patient
Inherited Members
Namespace: NiemTypes
Assembly: EidoLib.dll
Syntax
[DataContract]
public class HsPrescriptionType : NcActivityType, IEquatable<NcActivityType>, IEquatable<HsPrescriptionType>
Properties
Context
hsPrescriptionType JSON-LD context
Declaration
[DataMember(Name = "@context")]
public HsPrescriptionType.ContextEnum? Context { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<HsPrescriptionType.ContextEnum> | hsPrescriptionType JSON-LD context |
Dispenser
A pharmacy or pharmacist who filled the prescription. NIEM reference is hs:Dispenser
Declaration
[DataMember(Name = "dispenser")]
public List<NcEntityType> Dispenser { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | A pharmacy or pharmacist who filled the prescription. NIEM reference is hs:Dispenser |
Drug
A legal or illegal substance that can be used as a medicine or a narcotic. NIEM reference is nc:Drug
Declaration
[DataMember(Name = "drug")]
public List<NcDrugType> Drug { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDrugType> | A legal or illegal substance that can be used as a medicine or a narcotic. NIEM reference is nc:Drug |
DrugDispensedQuantity
A total count of a drug dispensed to a patient NIEM reference is hs:DrugDispensedQuantity
Declaration
[DataMember(Name = "drugDispensedQuantity")]
public List<NcQuantityType> DrugDispensedQuantity { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcQuantityType> | A total count of a drug dispensed to a patient NIEM reference is hs:DrugDispensedQuantity |
DrugDosageUnits
A unit of measure for the quantity dispensed of a drug. NIEM reference is hs:DrugDosageUnitsText
Declaration
[DataMember(Name = "drugDosageUnits")]
public List<NcTextType> DrugDosageUnits { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A unit of measure for the quantity dispensed of a drug. NIEM reference is hs:DrugDosageUnitsText |
DrugDosageUnitsCode
A unit of measure for the quantity dispensed of a drug. NIEM reference is hs:DrugDosageUnitsCode
Declaration
[DataMember(Name = "drugDosageUnitsCode")]
public List<HsDrugDosageUnitsCodeType> DrugDosageUnitsCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<HsDrugDosageUnitsCodeType> | A unit of measure for the quantity dispensed of a drug. NIEM reference is hs:DrugDosageUnitsCode |
DrugRefillNumberCountQuantity
A sequential number representing the sequential filling of a prescription. 0 indicates an original dispensing instead of a refill. NIEM reference is hs:DrugRefillNumberCountQuantity
Declaration
[DataMember(Name = "drugRefillNumberCountQuantity")]
public List<NcQuantityType> DrugRefillNumberCountQuantity { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcQuantityType> | A sequential number representing the sequential filling of a prescription. 0 indicates an original dispensing instead of a refill. NIEM reference is hs:DrugRefillNumberCountQuantity |
DrugRefillsAuthorizedQuantity
A number of times a prescriber has authorized a prescription to be refilled. NIEM reference is hs:DrugRefillsAuthorizedQuantity
Declaration
[DataMember(Name = "drugRefillsAuthorizedQuantity")]
public List<NcQuantityType> DrugRefillsAuthorizedQuantity { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcQuantityType> | A number of times a prescriber has authorized a prescription to be refilled. NIEM reference is hs:DrugRefillsAuthorizedQuantity |
FilledDate
A date on which a prescription was filled. NIEM reference is hs:PrescriptionFilledDate
Declaration
[DataMember(Name = "filledDate")]
public List<NcDateType> FilledDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date on which a prescription was filled. NIEM reference is hs:PrescriptionFilledDate |
IsDrugPartialFill
True if a prescription is partially filled; false otherwise. NIEM reference is hs:DrugPartialFillIndicator
Declaration
[DataMember(Name = "isDrugPartialFill")]
public List<NiemXsboolean> IsDrugPartialFill { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a prescription is partially filled; false otherwise. NIEM reference is hs:DrugPartialFillIndicator |
LastTakenDate
A date or date range when the medication was last taken. NIEM reference is hs:PrescriptionLastTakenDate
Declaration
[DataMember(Name = "lastTakenDate")]
public List<NcDateType> LastTakenDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date or date range when the medication was last taken. NIEM reference is hs:PrescriptionLastTakenDate |
MethodOfPayment
A method of payment. NIEM reference is hs:MethodOfPaymentText
Declaration
[DataMember(Name = "methodOfPayment")]
public List<NcTextType> MethodOfPayment { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A method of payment. NIEM reference is hs:MethodOfPaymentText |
MethodOfPaymentCode
A method of payment. NIEM reference is hs:MethodOfPaymentCode
Declaration
[DataMember(Name = "methodOfPaymentCode")]
public List<HsMethodOfPaymentCodeType> MethodOfPaymentCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<HsMethodOfPaymentCodeType> | A method of payment. NIEM reference is hs:MethodOfPaymentCode |
NormCode
A standardized and normalized cross-platform RxCode for electronic prescriptions to capture the prescribed drug product identification information. Part of the Unified Medical Language System (UMLS) NIEM reference is hs:PrescriptionNormCodeText
Declaration
[DataMember(Name = "normCode")]
public List<NcTextType> NormCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A standardized and normalized cross-platform RxCode for electronic prescriptions to capture the prescribed drug product identification information. Part of the Unified Medical Language System (UMLS) NIEM reference is hs:PrescriptionNormCodeText |
Pharmacist
A person who is professionally qualified to prepare and dispense medicinal drugs. NIEM reference is hs:Pharmacist
Declaration
[DataMember(Name = "pharmacist")]
public List<HsPharmacistType> Pharmacist { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<HsPharmacistType> | A person who is professionally qualified to prepare and dispense medicinal drugs. NIEM reference is hs:Pharmacist |
Prescriber
A medical professional or organization that authorizes a prescription drug. NIEM reference is hs:Prescriber
Declaration
[DataMember(Name = "prescriber")]
public List<NcEntityType> Prescriber { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | A medical professional or organization that authorizes a prescription drug. NIEM reference is hs:Prescriber |
SoldDate
A date on which a prescription received by a patient or a patient's agent. NIEM reference is hs:PrescriptionSoldDate
Declaration
[DataMember(Name = "soldDate")]
public List<NcDateType> SoldDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date on which a prescription received by a patient or a patient's agent. NIEM reference is hs:PrescriptionSoldDate |
StateIssuedRxSerialNumberIdentification
An identification assigned to a state issued serialized prescription blank as well as the state which issued it. NIEM reference is hs:StateIssuedRxSerialNumberIdentification
Declaration
[DataMember(Name = "stateIssuedRxSerialNumberIdentification")]
public List<NcIdentificationType> StateIssuedRxSerialNumberIdentification { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcIdentificationType> | An identification assigned to a state issued serialized prescription blank as well as the state which issued it. NIEM reference is hs:StateIssuedRxSerialNumberIdentification |
TransmissionFormOfRxOrigin
A transmission method by which a pharmacy receives a prescription. NIEM reference is hs:TransmissionFormOfRxOriginText
Declaration
[DataMember(Name = "transmissionFormOfRxOrigin")]
public List<NcTextType> TransmissionFormOfRxOrigin { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A transmission method by which a pharmacy receives a prescription. NIEM reference is hs:TransmissionFormOfRxOriginText |
TransmissionFormOfRxOriginCode
A transmission method by which a pharmacy receives a prescription. NIEM reference is hs:TransmissionFormOfRxOriginCode
Declaration
[DataMember(Name = "transmissionFormOfRxOriginCode")]
public List<HsTransmissionFormOfRxOriginCodeType> TransmissionFormOfRxOriginCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<HsTransmissionFormOfRxOriginCodeType> | A transmission method by which a pharmacy receives a prescription. NIEM reference is hs:TransmissionFormOfRxOriginCode |
TreatmentReason
A description of the treatment reason or condition being treated with the medication. This should include any 'off label' use. NIEM reference is hs:PrescriptionTreatmentReasonText
Declaration
[DataMember(Name = "treatmentReason")]
public List<NcTextType> TreatmentReason { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A description of the treatment reason or condition being treated with the medication. This should include any 'off label' use. NIEM reference is hs:PrescriptionTreatmentReasonText |
UseInstructions
A set of instructions for use of medication e.g. daily with food for 7 days, as needed for discomfort, not more than every 8 hours, etc. NIEM reference is hs:PrescriptionUseInstructionsText
Declaration
[DataMember(Name = "useInstructions")]
public List<NcTextType> UseInstructions { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A set of instructions for use of medication e.g. daily with food for 7 days, as needed for discomfort, not more than every 8 hours, etc. NIEM reference is hs:PrescriptionUseInstructionsText |
WrittenDate
A date on which a prescription was written by a prescriber. NIEM reference is hs:PrescriptionWrittenDate
Declaration
[DataMember(Name = "writtenDate")]
public List<NcDateType> WrittenDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date on which a prescription was written by a prescriber. NIEM reference is hs:PrescriptionWrittenDate |
Methods
Equals(HsPrescriptionType)
Returns true if HsPrescriptionType instances are equal
Declaration
public bool Equals(HsPrescriptionType other)
Parameters
Type | Name | Description |
---|---|---|
HsPrescriptionType | other | Instance of HsPrescriptionType to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | Object to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Hash code |
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String presentation of the object |
Overrides
Operators
Equality(HsPrescriptionType, HsPrescriptionType)
Declaration
public static bool operator ==(HsPrescriptionType left, HsPrescriptionType right)
Parameters
Type | Name | Description |
---|---|---|
HsPrescriptionType | left | |
HsPrescriptionType | right |
Returns
Type | Description |
---|---|
System.Boolean |
Inequality(HsPrescriptionType, HsPrescriptionType)
Declaration
public static bool operator !=(HsPrescriptionType left, HsPrescriptionType right)
Parameters
Type | Name | Description |
---|---|---|
HsPrescriptionType | left | |
HsPrescriptionType | right |
Returns
Type | Description |
---|---|
System.Boolean |