FHIR CI-Build
FoundationThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
StructureDefinition for Money
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Money"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"> <tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a> </th> <th class="hierarchy" style="width: 100px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Element"/> <a href="datatypes-definitions.html#Money" title="Money : An amount of economic utility in some recognized currency.">Money</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold; color: black; background-color: #e6ffe6" title="Standards Status = Normative">N</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="types.html#Element">Element</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">An amount of economic utility in some recognized currency <br/> <br/> Elements defined in Ancestors: <a href="types.html#Element" title="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.">id</a> , <a href="types.html#Element" title="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.">extension</a> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Money.value" title="Money.value : Numerical value (with implicit precision).">value</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#decimal">decimal</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Numerical value (with implicit precision) <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Money.currency" title="Money.currency : ISO 4217 Currency Code.">currency</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">ISO 4217 Currency Code <br/> Binding: <a href="valueset-currencies.html" title="A code indicating the currency, taken from ISO 4217.">Currencies</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">Required</a> ) <br/> </td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="has-range"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="is-continuous"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="has-units"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Money"/> <version value="6.0.0-ballot2"/> <name value="Money"/> <status value="active"/> <experimental value="false"/> <date value="2024-12-12T18:56:29+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="Money Type: An amount of economic utility in some recognized currency."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="6.0.0-ballot2"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 V2 Mapping"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <type value="Money"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType"/> <derivation value="specialization"/> <snapshot> <element id="Money"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <path value="Money"/> <short value="An amount of economic utility in some recognized currency"/> <definition value="An amount of economic utility in some recognized currency."/> <min value="0"/> <max value="*"/> <base> <path value="Money"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a,MO"/> </mapping> </element> <element id="Money.id"> <path value="Money.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <!-- Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic (j) --> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Money.extension"> <path value="Money.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional content defined by implementations"/> <definition value="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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Money.value"> <path value="Money.value"/> <short value="Numerical value (with implicit precision)"/> <definition value="Numerical value (with implicit precision)."/> <comment value="Monetary values have their own rules for handling precision (refer to standard accounting text books)."/> <requirements value="The amount of the currency. The value includes an implicit precision in the presentation of the value."/> <min value="0"/> <max value="1"/> <base> <path value="Money.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="decimal"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="MO.Value"/> </mapping> </element> <element id="Money.currency"> <path value="Money.currency"/> <short value="ISO 4217 Currency Code"/> <definition value="ISO 4217 Currency Code."/> <requirements value="A code indicating the currency, taken from ISO 4217."/> <min value="0"/> <max value="1"/> <base> <path value="Money.currency"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="A code indicating the currency, taken from ISO 4217."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="CurrencyCode"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="A code indicating the currency, taken from ISO 4217."/> <valueSet value="http://hl7.org/fhir/ValueSet/currencies|6.0.0-ballot2"/> </binding> <mapping> <identity value="v2"/> <map value="MO.Currency"/> </mapping> </element> </snapshot> <differential> <element id="Money"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <path value="Money"/> <short value="An amount of economic utility in some recognized currency"/> <definition value="An amount of economic utility in some recognized currency."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="MO"/> </mapping> </element> <element id="Money.value"> <path value="Money.value"/> <short value="Numerical value (with implicit precision)"/> <definition value="Numerical value (with implicit precision)."/> <comment value="Monetary values have their own rules for handling precision (refer to standard accounting text books)."/> <requirements value="The amount of the currency. The value includes an implicit precision in the presentation of the value."/> <min value="0"/> <max value="1"/> <type> <code value="decimal"/> </type> <mapping> <identity value="v2"/> <map value="MO.Value"/> </mapping> </element> <element id="Money.currency"> <path value="Money.currency"/> <short value="ISO 4217 Currency Code"/> <definition value="ISO 4217 Currency Code."/> <requirements value="A code indicating the currency, taken from ISO 4217."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="A code indicating the currency, taken from ISO 4217."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="CurrencyCode"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="A code indicating the currency, taken from ISO 4217."/> <valueSet value="http://hl7.org/fhir/ValueSet/currencies|6.0.0-ballot2"/> </binding> <mapping> <identity value="v2"/> <map value="MO.Currency"/> </mapping> </element> </differential> </StructureDefinition>
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 R6 hl7.fhir.core#6.0.0-ballot2 generated on Thu, Dec 12, 2024 19:28+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change