| COCT_MT440000UV09 A_ValuedItem universal |
Derived from RMIM: COCT_RM440000UV09 and HMD: COCT_HD440000UV09 |
||||||||
| ValuedItem [Constraint: " invariant( x) { x.; }If the act.mood = Def then, the unitPriceAmt MO is UNK and PQ is nonNull "][Constraint: " invariant( x) { x.;A ValuedItem may be composed of one or more ValuedUnitItems, which may or may not be priced. If any are priced, then the ValuedItem netAmt is the sum of any component ValuedUnitItem netAmts, and the ValuedItem unitPriceAmt MO numerator is UNK and the denominator 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. |
||||||||
| 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} |
Design Comments: The ValuedItem is something that may be or has been priced. |
||||||||
| id [0..*] InvoiceElement (DSET<II>) |
Design Comments: Optionally identifies an instance of ValuedItem information, e.g. as used on a particular product label. |
||||||||
| code [0..1] InvoiceElement (CD) {CWE:D:ActInvoiceDetailCode} |
Design Comments: This is the 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. UsageNotes: If act.code bound to NDC then unit PQ = code from NCPDP Billing Units: each, gram, or ml |
||||||||
| effectiveTime [0..1] InvoiceElement (IVL<TS>) |
Design Comments: 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. Constraint: 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 http://www.ncpdp.org/PDF/Basic_guide_to_standards.pdf. For more information see Foundation Section 3.1.12.2 InvoiceElement.unitQuantity: RTO<PQ,PQ> (0..1). |
||||||||
| unitPriceAmt [1..1] InvoiceElement (RTO<MO,PQ>) |
Design Comments: Quantifies the price of a measurable or countable instance of a ValuedItem. One and only one ValuedItem unitPriceAmt RTO<MO, PQ> is 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. Note: 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: The ValuedItem netAmt MO 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. Note: 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’. |
||||||||
| factorNumber [0..1] InvoiceElement (REAL) |
Design Comments: May be sent to represent a multiplier used in determining the overall cost of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. For example, the formula, with a factor would be: unitQuantity * unitPrice (Cost/Point) * factorNumber = netAmt. |
||||||||
| pointsNumber [0..1] InvoiceElement (REAL) |
Design Comments: May be sent to express the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point. For example, the formula, with points would be: unitQuantity * pointsNumber * unitPriceAmt (Cost/Point) = netAmt. |
||||||||
| pertinentInformation [0..*] (PertinentInformation) | |||||||||
| component [0..*] (Component) | |||||||||
| PertinentInformation | |||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipPertains, root= "PERT"} |
Design Comments: The ActRelationship typeCode SUBJ: The ValuedItem may be linked to zero or more Benefit(s). The coverage association indicates that the ValuedItem may be a benefit or a component of a Billable health service under a Program or Policy (P/P) if the provision of the benefit meets the coverage rules. |
||||||||
| benefit [1..1] (A_BenefitUniversal) | |||||||||
| Component | |||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"} |
Design Comments: The ValuedItem may be linked to zero or more ValuedUnitItems. The component association indicates that the ValuedItem may be comprised of one or more ValuedUnitItems, which may or may not be priced. |
||||||||
| valuedUnitItem [1..1] (ValuedUnitItem) |
Design Comments: A ValuedItem may be composed on one or more ValuedUnitItems, which may or may not be priced. If any are priced, then the ValuedItem netAmount is the sum of these component prices, and the ValuedItem unitPriceAmt must not be valued. |
||||||||
| ValuedUnitItem [Constraint: " invariant( x) { x.; }If the act.mood = Def then, the unitPriceAmt MO is UNK and PQ is nonNull "] |
Design Comments: A ValuedItem may be composed on one or more ValuedUnitItems, which may or may not be priced. If any are priced, then the ValuedItem netAmount is the sum of these component prices, and the ValuedItem unitPriceAmt must not be valued. |
||||||||
| classCode [1..1] (M) InvoiceElement (CS) {CNE:V:ActClassInvoiceElement, root= "INVE"} |
Design Comments: The ValuedItem may be linked to zero or more ValuedUnitItems. The component association indicates that the ValuedItem may be comprised of one or more ValuedUnitItems, which may or may not be priced. |
||||||||
| moodCode [1..1] (M) InvoiceElement (CS) {CNE:V:x_ActMoodDefEvn} |
Design Comments: An actual or definitional specification of billable information about a ValuedUnitItem. |
||||||||
| id [0..*] InvoiceElement (DSET<II>) |
Design Comments: Identifier is optional because it is likely not required when the act.mood is set to definition. |
||||||||
| code [0..1] InvoiceElement (CD) {CWE:D:ActInvoiceDetailCode} |
Design Comments: This is the 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. 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. UsageNotes: If act.code bound to NDC then unit PQ = code from NCPDP Billing Units: each, gram, or ml |
||||||||
| effectiveTime [0..1] InvoiceElement (IVL<TS>) |
Design Comments: Optionally, the time or period during which information about a ValuedUnitItem is in effect. |
||||||||
| unitQuantity [1..1] InvoiceElement (RTO<PQ,PQ>) |
Design Comments: Quantifies the number of measurable or countable instance of a ValuedUnitItem. The ValuedUnitItem unitQuantity RTO<PQ,PQ> specifies the units by which the ValuedUnitItem is measured or counted, and quantifies the countable or measurable ValuedItem instances. Required to be sent if known. Constraint: The PQ units and values are aligned with the type of ValuedUnitItem 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 http://www.ncpdp.org/PDF/Basic_guide_to_standards.pdf. For more information see Foundation Section 3.1.12.2 InvoiceElement.unitQuantity: RTO<PQ,PQ> (0..1). |
||||||||
| unitPriceAmt [0..1] InvoiceElement (RTO<MO,PQ>) |
Design Comments: Quantifies the price of a measurable or countable instance of a ValuedUnitItem. One and only one ValuedUnitItem unitPriceAmt RTO<MO, PQ> is 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. Note: If the act.mood of the ValuedUnitItem 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: The ValuedUnitItem netAmt MO may be sent to express the product of the ValuedUnitItem unitQuantity and the unitPriceAmt. Note: If the unitPriceAmt MO numerator is UNK, then the netAmt is UNK or not sent. |
||||||||
| factorNumber [0..1] InvoiceElement (REAL) |
Design Comments: The ValuedUnitItem factorNumber REAL may be sent to represent a multiplier used in determining the overall cost of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. For example, the formula, with a factor would be: unitQuantity * unitPrice (Cost/Point) * factorNumber = netAmt. |
||||||||
| pointsNumber [0..1] InvoiceElement (REAL) |
Design Comments: The ValuedUnitItem pointNumber MO may be sent to express the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point. For example, the formula, with points would be: unitQuantity * pointsNumber * unitPriceAmt (Cost/Point) = netAmt. |
||||||||