Release 5 Ballot
FoundationThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for MonetaryComponent
{
"resourceType" : "StructureDefinition",
"id" : "MonetaryComponent",
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MonetaryComponent",
"version" : "5.0.0-ballot",
"name" : "MonetaryComponent",
"status" : "draft",
"experimental" : false,
"date" : "2022-09-07T10:58:29+10:00",
"publisher" : "HL7 FHIR Standard",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "MonetaryComponent Type: Availability data for an {item}.",
"fhirVersion" : "5.0.0-ballot",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "complex-type",
"abstract" : false,
"type" : "MonetaryComponent",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MonetaryComponent",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "MonetaryComponent",
"short" : "Availability data for an {item}",
"definition" : "Availability data for an {item}.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MonetaryComponent",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MonetaryComponent.id",
"path" : "MonetaryComponent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MonetaryComponent.extension",
"path" : "MonetaryComponent.extension",
"slicing" : {
"discriminator" : [{
"type" : "value",
"path" : "url"
}],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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 manageable, 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.",
"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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MonetaryComponent.type",
"path" : "MonetaryComponent.type",
"short" : "base | surcharge | deduction | discount | tax | informational",
"definition" : "base | surcharge | deduction | discount | tax | informational.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MonetaryComponent.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString" : "The purpose for which an extended contact detail should be used."
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PriceComponentType"
}],
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/price-component-type|5.0.0-ballot"
}
},
{
"id" : "MonetaryComponent.code",
"path" : "MonetaryComponent.code",
"short" : "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"definition" : "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MonetaryComponent.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString" : "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PriceComponentCode"
}],
"strength" : "example"
}
},
{
"id" : "MonetaryComponent.factor",
"path" : "MonetaryComponent.factor",
"short" : "Factor used for calculating this component",
"definition" : "Factor used for calculating this component.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MonetaryComponent.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MonetaryComponent.amount",
"path" : "MonetaryComponent.amount",
"short" : "Explicit value amount to be used",
"definition" : "Explicit value amount to be used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MonetaryComponent.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MonetaryComponent",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "MonetaryComponent",
"short" : "Availability data for an {item}",
"definition" : "Availability data for an {item}.",
"min" : 0,
"max" : "*"
},
{
"id" : "MonetaryComponent.type",
"path" : "MonetaryComponent.type",
"short" : "base | surcharge | deduction | discount | tax | informational",
"definition" : "base | surcharge | deduction | discount | tax | informational.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString" : "The purpose for which an extended contact detail should be used."
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PriceComponentType"
}],
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/price-component-type|5.0.0-ballot"
}
},
{
"id" : "MonetaryComponent.code",
"path" : "MonetaryComponent.code",
"short" : "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"definition" : "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString" : "Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc."
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PriceComponentCode"
}],
"strength" : "example"
}
},
{
"id" : "MonetaryComponent.factor",
"path" : "MonetaryComponent.factor",
"short" : "Factor used for calculating this component",
"definition" : "Factor used for calculating this component.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MonetaryComponent.amount",
"path" : "MonetaryComponent.amount",
"short" : "Explicit value amount to be used",
"definition" : "Explicit value amount to be used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"isSummary" : true
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:06+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change