COCT_MT440001UV09 - Hierarchical Message Description

COCT_MT440001UV09
A_ValuedItem identified

Derived from RMIM: COCT_RM440001UV09 and HMD: COCT_HD440001UV09

ValuedItem
[Constraint: "

invariant( x) {x.; If the act.mood = Def then, the unitPriceAmt MO is UNK and PQ is nonNull}

Design Comments: This CMET is used to convey information related to a ValuedItem in terms of its measurable or countable units. All Variants may include pricing information needed to calculate the net amount. In the minimal, basic, and universal variants, the ValuedItem may be composed of one or more ValuedUnitItems, which may or may not be priced. The universal variant includes coverage related information such as charges, financial participation, fee schedule, and coverage policies such as the health status of the subject of care.

The identified variant is used to convey the identity of the ValuedItem information in the definition mood. The identifier is required for the identified variant, but optional for the other variants.

classCode [1..1] (M)
InvoiceElement (CS) {CNE:V:ActClassInvoiceElement, root= "INVE"}

Design Comments: The focal class indicates the countable or measurable item (e.g., a product, device, or service) that may be or has been priced.

moodCode [1..1] (M)
InvoiceElement (CS) {CNE:V:x_ActMoodDefEvn}

id [1..*] (M)
InvoiceElement (DSET<II>)

Design Comments: Identifies the instance of ValuedItem information, e.g. as used on a particular product label. Must be sent.

code [0..1]
InvoiceElement (CD) {CWE:D:ActInvoiceDetailCode}

Design Comments: The ValuedItem code from the ActInvoiceDetailCode concept domain, to which value set may be bound to provide specific information about the type of items that that may be or has been priced. For example, if the ActInvoiceDetailDrugProduct sub-concept domain is used, then the value set could include NDC, UPC or GTIN. Constraint: When this code is the same as the code on a class in the base model to which this CMET is associated, do not valued this attribute or ensure that the codes are the same. For example, a Medication message may include the NDC code used in this CMET’s attribute in an Entity class describing the drug.

effectiveTime [0..1]
InvoiceElement (IVL<TS>)

Design Comments: The ValuedItem effectiveTime indicates the time during which ValuedItem information is effective.

unitQuantity [0..1]
InvoiceElement (RTO<PQ,PQ>)

Design Comments: Specifies the units by which the ValuedItem is measured or counted, and quantifies the countable or measurable ValuedItem instances. Required to be sent if known. The PQ units and values are aligned with the type of ValuedItem specified by the value set or coding system bound to the ValuedItem InvoiceDetailCode or its child concept domain. For example, if the ActInvoiceDetailDrugCode is bound to the NDC codes, then the PQ unit value set is the NCPDP Billing Unit Standard.

unitPriceAmt [1..1]
InvoiceElement (RTO<MO,PQ>)

Design Comments: Required to be sent to quantify the ratio of the price per countable or measurable instance of an item that may be or has been priced. If the act.mood of the ValuedItem is in definition mood, the price may be as yet unspecified. In this case, the MO numerator for unspecified price is constrained to "UNK" for "unknown"; the PQ denominator must be nonNull; and the netAmt is not valued. For example, in the case of product labeling, only the valued countable or measurable item is defined, but the price per unit or net amount is not yet determined.

netAmt [0..1]
InvoiceElement (MO)

Design Comments: May be sent to express the product of the ValuedItem unitQuantity and the unitPriceAmt. If the unitPriceAmt MO is UNK, then the netAmt is UNK or not sent. If any ValuedUnitItem act.mood is event, then the ValuedItem act.mood must be event. In this case, any ValuedUnitItem unitQuantity and unitPriceAmt attributes must be nonNull, and the ValuedUnitItem netAmt must be the product of these attributes. In addition, the ValuedItem netAmt must be the sum of any ValuedUnitItem netAmts. Since a ValuedItem unitPriceAmt is required to be sent, the MO numerator and PQ denominator must either be both be UNK; or MO numerator must be equal to the ValuedItem netAmt and the PQ denominator must have a fixed value of '1'.

COCT_MT440001UV09 A_ValuedItem identified	Derived from RMIM: COCT_RM440001UV09 and HMD: COCT_HD440001UV09

ValuedItem [Constraint: " invariant( x) {x.; If the act.mood = Def then, the unitPriceAmt MO is UNK and PQ is nonNull} "]	*Design Comments:* This CMET is used to convey information related to a ValuedItem in terms of its measurable or countable units. All Variants may include pricing information needed to calculate the net amount. In the minimal, basic, and universal variants, the ValuedItem may be composed of one or more ValuedUnitItems, which may or may not be priced. The universal variant includes coverage related information such as charges, financial participation, fee schedule, and coverage policies such as the health status of the subject of care. The identified variant is used to convey the identity of the ValuedItem information in the definition mood. The identifier is required for the identified variant, but optional for the other variants.
classCode [1..1] (M) InvoiceElement (CS) {CNE:V:ActClassInvoiceElement, root= "INVE"}	*Design Comments:* The focal class indicates the countable or measurable item (e.g., a product, device, or service) that may be or has been priced.
moodCode [1..1] (M) InvoiceElement (CS) {CNE:V:x_ActMoodDefEvn}
id [1..*] (M) InvoiceElement (DSET<II>)	*Design Comments:* Identifies the instance of ValuedItem information, e.g. as used on a particular product label. Must be sent.
code [0..1] InvoiceElement (CD) {CWE:D:ActInvoiceDetailCode}	*Design Comments:* The ValuedItem code from the ActInvoiceDetailCode concept domain, to which value set may be bound to provide specific information about the type of items that that may be or has been priced. For example, if the ActInvoiceDetailDrugProduct sub-concept domain is used, then the value set could include NDC, UPC or GTIN. Constraint: When this code is the same as the code on a class in the base model to which this CMET is associated, do not valued this attribute or ensure that the codes are the same. For example, a Medication message may include the NDC code used in this CMET’s attribute in an Entity class describing the drug.
effectiveTime [0..1] InvoiceElement (IVL<TS>)	*Design Comments:* The ValuedItem effectiveTime indicates the time during which ValuedItem information is effective.
unitQuantity [0..1] InvoiceElement (RTO<PQ,PQ>)	*Design Comments:* Specifies the units by which the ValuedItem is measured or counted, and quantifies the countable or measurable ValuedItem instances. Required to be sent if known. The PQ units and values are aligned with the type of ValuedItem specified by the value set or coding system bound to the ValuedItem InvoiceDetailCode or its child concept domain. For example, if the ActInvoiceDetailDrugCode is bound to the NDC codes, then the PQ unit value set is the NCPDP Billing Unit Standard.
unitPriceAmt [1..1] InvoiceElement (RTO<MO,PQ>)	*Design Comments:* Required to be sent to quantify the ratio of the price per countable or measurable instance of an item that may be or has been priced. If the act.mood of the ValuedItem is in definition mood, the price may be as yet unspecified. In this case, the MO numerator for unspecified price is constrained to "UNK" for "unknown"; the PQ denominator must be nonNull; and the netAmt is not valued. For example, in the case of product labeling, only the valued countable or measurable item is defined, but the price per unit or net amount is not yet determined.
netAmt [0..1] InvoiceElement (MO)	*Design Comments:* May be sent to express the product of the ValuedItem unitQuantity and the unitPriceAmt. If the unitPriceAmt MO is UNK, then the netAmt is UNK or not sent. If any ValuedUnitItem act.mood is event, then the ValuedItem act.mood must be event. In this case, any ValuedUnitItem unitQuantity and unitPriceAmt attributes must be nonNull, and the ValuedUnitItem netAmt must be the product of these attributes. In addition, the ValuedItem netAmt must be the sum of any ValuedUnitItem netAmts. Since a ValuedItem unitPriceAmt is required to be sent, the MO numerator and PQ denominator must either be both be UNK; or MO numerator must be equal to the ValuedItem netAmt and the PQ denominator must have a fixed value of '1'.