{
"description": "MonetaryComponent Type: Financial line items use this datatype to commonly categorize the value, and other factors that may effect how the value should be interpreted.",
"_filename": "StructureDefinition-MonetaryComponent.json",
"package_name": "hl7.fhir.r6.examples",
"date": "2023-12-18T15:12:07+11:00",
"derivation": "specialization",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "MonetaryComponent",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "MonetaryComponent",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-range"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "is-continuous"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-units"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MonetaryComponent",
"min": 0,
"definition": "Financial line items use this datatype to commonly categorize the value, and other factors that may effect how the value should be interpreted.",
"isModifier": false,
"short": "Types and value of financial information that apply to line item(s)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "*",
"id": "MonetaryComponent",
"base": {
"max": "*",
"min": 0,
"path": "MonetaryComponent"
}
}, {
"path": "MonetaryComponent.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MonetaryComponent.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MonetaryComponent.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MonetaryComponent.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MonetaryComponent.type",
"min": 1,
"definition": "The type of monetary component, what the value is to be used for and how that should be applied in its context. e.g. A surchange would increase the cost, a deduction would reduce the cost.",
"isModifier": false,
"short": "base | surcharge | deduction | discount | tax | informational",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/price-component-type|6.0.0-ballot1",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The purpose for which an extended contact detail should be used."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentType"
} ],
"description": "The purpose for which an extended contact detail should be used."
},
"max": "1",
"id": "MonetaryComponent.type",
"base": {
"max": "1",
"min": 1,
"path": "MonetaryComponent.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MonetaryComponent.code",
"requirements": "Some monetary component types can be further classified and need to be differentiated.",
"min": 0,
"definition": "A codable breakdown of the type of monetary component. e.g. State Tax, Federal Tax, VIP-Discount.",
"isModifier": false,
"short": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentCode"
} ],
"description": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
},
"max": "1",
"id": "MonetaryComponent.code",
"base": {
"max": "1",
"min": 0,
"path": "MonetaryComponent.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MonetaryComponent.factor",
"min": 0,
"definition": "The factor that has been applied to the base price (in another monetary component value) when performing calculations.",
"isModifier": false,
"short": "Factor used for calculating this component",
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "MonetaryComponent.factor",
"base": {
"max": "1",
"min": 0,
"path": "MonetaryComponent.factor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MonetaryComponent.amount",
"min": 0,
"definition": "The explicit value amount of the component (based on type/code).",
"isModifier": false,
"short": "Explicit value amount to be used",
"type": [ {
"code": "Money"
} ],
"max": "1",
"id": "MonetaryComponent.amount",
"base": {
"max": "1",
"min": 0,
"path": "MonetaryComponent.amount"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "eaef6104-d08a-43ff-a087-4dfb5797c60d",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/MonetaryComponent",
"version": "6.0.0-ballot1",
"differential": {
"element": [ {
"id": "MonetaryComponent",
"max": "*",
"min": 0,
"path": "MonetaryComponent",
"short": "Types and value of financial information that apply to line item(s)",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"definition": "Financial line items use this datatype to commonly categorize the value, and other factors that may effect how the value should be interpreted."
}, {
"path": "MonetaryComponent.type",
"min": 1,
"definition": "The type of monetary component, what the value is to be used for and how that should be applied in its context. e.g. A surchange would increase the cost, a deduction would reduce the cost.",
"short": "base | surcharge | deduction | discount | tax | informational",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/price-component-type|6.0.0-ballot1",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The purpose for which an extended contact detail should be used."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentType"
} ],
"description": "The purpose for which an extended contact detail should be used."
},
"max": "1",
"id": "MonetaryComponent.type",
"isSummary": true
}, {
"path": "MonetaryComponent.code",
"requirements": "Some monetary component types can be further classified and need to be differentiated.",
"min": 0,
"definition": "A codable breakdown of the type of monetary component. e.g. State Tax, Federal Tax, VIP-Discount.",
"short": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PriceComponentCode"
} ],
"description": "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
},
"max": "1",
"id": "MonetaryComponent.code",
"isSummary": true
}, {
"id": "MonetaryComponent.factor",
"max": "1",
"min": 0,
"path": "MonetaryComponent.factor",
"type": [ {
"code": "decimal"
} ],
"short": "Factor used for calculating this component",
"isSummary": true,
"definition": "The factor that has been applied to the base price (in another monetary component value) when performing calculations."
}, {
"id": "MonetaryComponent.amount",
"max": "1",
"min": 0,
"path": "MonetaryComponent.amount",
"type": [ {
"code": "Money"
} ],
"short": "Explicit value amount to be used",
"isSummary": true,
"definition": "The explicit value amount of the component (based on type/code)."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType"
}