FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

2.1.28.5.0 MetaDatatypes

FHIR Infrastructure icon Work GroupMaturity Level: 4Standards Status: Partially Normative

Types Framework Cross Reference: Base Types | Datatypes | Resources | Patterns

This page describes a set of types used for conveying metadata about knowledge resources (mainly for Terminology, Conformance and Clinical Definition resources).

Table of Contents

ContactDetail DataRequirement ParameterDefinition RelatedArtifact
TriggerDefinition Expression UsageContext ExtendedContactDetail
VirtualServiceDetail Availability MonetaryComponent

For an index of all datatypes, see the Datatypes page.

2.1.28.5.0.1 ContactDetail

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The ContactDetail structure defines general contact details.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactDetail ΣN Element Contact information

Elements defined in Ancestors: id, extension
... name Σ 0..1 string Name of an individual to contact
... telecom Σ 0..* ContactPoint Contact details for individual or organization


doco Documentation for this format icon

Definition: XML | JSON

Constraints

ContactDetail is used in the following places: Contributor, ActivityDefinition, ActorDefinition, CanonicalResource, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, DeviceDefinition, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, GraphDefinition, Group, ImplementationGuide, Library, Measure, MedicationKnowledge, MessageDefinition, MetadataResource, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript and ValueSet

2.1.28.5.0.2 DataRequirement

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The DataRequirement structure defines a general data requirement for a knowledge asset such as a decision support rule or quality measure.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataRequirement ΣTU Element Describes a required data item

Elements defined in Ancestors: id, extension
... type Σ 1..1 code The type of the required data
Binding: All FHIR Types (Required)
... profile Σ 0..* canonical(StructureDefinition) The profile of the required data

... subject[x] Σ 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Participant Resource Types (Extensible)
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... codeFilter ΣC 0..* Element What codes are expected
+ Rule: Either a path or a searchParam must be provided, but not both

.... path ΣC 0..1 string A code-valued attribute to filter on
.... searchParam ΣC 0..1 string A coded (token) parameter to search on
.... valueSet Σ 0..1 canonical(ValueSet) ValueSet for the filter
.... code Σ 0..* Coding What code is expected

... dateFilter ΣC 0..* Element What dates/date ranges are expected
+ Rule: Either a path or a searchParam must be provided, but not both

.... path ΣC 0..1 string A date-valued attribute to filter on
.... searchParam ΣC 0..1 string A date valued parameter to search on
.... value[x] Σ 0..1 The value of the filter, as a Period, DateTime, or Duration value
..... valueDateTime dateTime
..... valuePeriod Period
..... valueDuration Duration
... valueFilter Σ 0..* Element What values are expected

.... path Σ 0..1 string An attribute to filter on
.... searchParam Σ 0..1 string A parameter to search on
.... comparator Σ 0..1 code eq | gt | lt | ge | le | sa | eb
Binding: Value Filter Comparator (Required)
.... value[x] Σ 0..1 The value of the filter, as a Period, DateTime, or Duration value
..... valueDateTime dateTime
..... valuePeriod Period
..... valueDuration Duration
... limit Σ 0..1 positiveInt Number of results
... sort Σ 0..* Element Order of the results

.... path Σ 1..1 string The name of the attribute to perform the sort
.... direction Σ 1..1 code ascending | descending
Binding: SortDirection (Required)

doco Documentation for this format icon

Definition: XML | JSON

Constraints

idLevelLocationDescriptionExpression
img drq-1 Rule DataRequirement.codeFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
img drq-2 Rule DataRequirement.dateFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()

Terminology Bindings

Path ValueSet Type Documentation
DataRequirement.type FHIRTypes (a valid code from All FHIR Types) Required

All FHIR types
DataRequirement.subject[x] ParticipantResourceTypes Extensible

All Resource Types that represent participant resources
DataRequirement.valueFilter.comparator ValueFilterComparator Required

The type of comparator operator to use
DataRequirement.sort.direction SortDirection Required

The possible sort directions, ascending or descending.

A DataRequirement differs from a parameter in that it specifies the data to be provided in terms of the type of data, and specific filters on code-valued and/or date-valued attributes. Data requirements are not named because they are referenced by type within the evaluation context.

DataRequirements are used by knowledge modules to communicate the set of required data to a consumer in a way that is computable (as opposed to a set of named parameters which must be integrated by hand based on the meaning of the parameter as communicated through the documentation).

DataRequirements are typically used to communicate patient-dependent information such as MedicationStatements and Encounters, whereas Parameters are typically used to communicate patient-independent information such as configuration values.

For example, consider the following CQL expression:

define "Total Colectomy Procedures":
  [Procedure: "Total Colectomy Value Set"] P
    where P.performedPeriod during "Measurement Period"

The criteria is looking for procedures matching the "Total Colectomy Value Set" that were performed during the "Measurement Period". In this case, "Measurement Period" is a parameter, referenced by name, whereas the reference to Procedure uses the name of the resource type, and so constitutes a data requirement of the criteria:

<dataRequirement>
	<type value="Procedure"/>
	<codeFilter>
		<path value="code"/>
		<valueSetString value="Total Colectomy Value Set"/>
	</codeFilter>
	<dateFilter>
		<path value="performed"/>
		<valuePeriod>
			<start value="2016-01-01"/>
			<end value="2016-12-31"/>
		</valuePeriod>
	</dateFilter>
</dataRequirement>

If a resource type has multiple date attributes, then it may be necessary to include multiple date criteria. For instance, in the example above the Procedure resource is using the performedPeriod date attribute. However, the Procedure resource also provides a performedDateTime (specific date and/or time when procedure was performed) attribute. Therefore, if the date criteria for the Procedure in the example was recorded using the performedDateTime attribute, the date criteria would be incomplete. To account for this additional date attribute, the example could be expanded as follows:

define "Total Colectomy Procedures":
  [Procedure: "Total Colectomy Value Set"] P
    where exists (P.performedPeriod during "Measurement Period")
	  or exists (P.performedDateTime during "Measurement Period")

The data requirement for the expanded criteria:

<dataRequirement>
	<type value="Procedure"/>
	<codeFilter>
		<path value="code"/>
		<valueSetString value="Total Colectomy Value Set"/>
	</codeFilter>
	<dateFilter>
		<path value="performed"/>
	</dateFilter>
</dataRequirement>

DataRequirement is used in the following places: TriggerDefinition, GuidanceResponse, Library, PlanDefinition and RequestOrchestration

 

2.1.28.5.0.3 ParameterDefinition

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The ParameterDefinition structure defines a parameter to a knowledge asset such as a decision support rule or quality measure.

Parameters are typically used to communicate patient-independent information such as configuration values, whereas DataRequirements are typically used to communicate patient-dependent information such as MedicationStatements and Encounters.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParameterDefinition ΣTU Element Definition of a parameter to a module

Elements defined in Ancestors: id, extension
... name Σ 0..1 code Name used to access the parameter value
... use Σ 1..1 code in | out
Binding: Operation Parameter Use (Required)
... min Σ 0..1 integer Minimum cardinality
... documentation Σ 0..1 string A brief description of the parameter
... type Σ 1..1 code What type of value
Binding: All FHIR Types (Required)
... profile Σ 0..1 canonical(StructureDefinition) What profile the value is expected to be

doco Documentation for this format icon

Definition: XML | JSON

Constraints

Terminology Bindings

Path ValueSet Type Documentation
ParameterDefinition.use OperationParameterUse Required

Whether an operation parameter is an input or an output parameter.
ParameterDefinition.type FHIRTypes (a valid code from All FHIR Types) Required

All FHIR types

 

2.1.28.5.0.4 RelatedArtifact

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The RelatedArtifact structure defines resources related to an artifact such as previous and next versions of documents, documentation, citations, etc. Note that the name artifact here is being used in a general sense; The related artifact may be a FHIR resource, or it may be another type of resource, represented using the Attachment datatype.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedArtifact ΣTU Element Related artifacts for a knowledge resource

Elements defined in Ancestors: id, extension
... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (Required)
... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: Citation Artifact Classifier (Example)

... label Σ 0..1 string Short label
... citation Σ 0..1 markdown Bibliographic citation for the artifact
... document Σ 0..1 Attachment What document is being referenced
... resource Σ 0..1 canonical(Any) What artifact is being referenced
... resourceReference Σ 0..1 Reference(Any) What artifact, if not a conformance resource
... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... publicationDate Σ 0..1 date Date of publication of the artifact being referred to

doco Documentation for this format icon

Definition: XML | JSON

Constraints

Terminology Bindings

Path ValueSet Type Documentation
RelatedArtifact.type RelatedArtifactType Required

The type of relationship to the related artifact.
RelatedArtifact.classifier CitationArtifactClassifier Example

Citation artifact classifier
RelatedArtifact.publicationStatus PublicationStatus Required

The lifecycle status of an artifact.

The following examples illustrate the use of relatedArtifact elements to provide citations:

<relatedArtifact>
    <label value="1"/>
    <type value="citation"/>
    <citation value="Linder, J.A., D.W. Bates, G.M. Lee, J.A. Finkelstein. 2005. _Antibiotic treatment of children with sore throat_ JAMA 294(18):2315-2322. "/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="citation"/>
    <label value="2"/>
    <citation value="Infectious Diseases Society of America. 2012. _Clinical Practice Guideline for the Diagnosis and Management of Group A Streptococcal Pharyngitis: 2012 Update._ "/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="citation"/>
    <label value="3"/>
    <citation value="Roberts, R.R., B. Hota, I. Ahmad, et al. _Hospital and Societal Costs of Antimicrobial-Resistant Infections in a Chicago Teaching Hospital: Implications for Antibiotic Stewardship._ Clin Infect Dis. Oct 2009; 49(8):1175-84."/>
  </relatedArtifact>

RelatedArtifact is used in the following places: ActivityDefinition, ChargeItemDefinition, CodeSystem, ConceptMap, DeviceDefinition, DiagnosticReport, EventDefinition, Library, Measure, MetadataResource, NamingSystem, PlanDefinition, RequestOrchestration and ValueSet

2.1.28.5.0.4.0.1 Interpretation of RelatedArtifact in different contexts

The RelatedArtifact type is used in a variety of contexts, and supports flexible description of relationships between artifacts. For example, the type can be used to describe both successor and predecessor relationships. This flexibility is needed to support use cases where only one side or other of the relationship is represented in FHIR. In practice, this datatype SHALL NOT be used to create bi-directional linking between FHIR resources.

 

2.1.28.5.0.5 TriggerDefinition

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The TriggerDefinition structure defines when a knowledge artifact is expected to be evaluated. The structure can represent three main kinds of triggering events, depending on the value of type:

  • Named Event
  • Scheduled Event
  • Data Event

A named event is an event identified by the implementation environment. This allows any event generated within the implementation environment to be used as a trigger, but it requires pre-coordination of the names involved with the consuming environments. HL7 V2 events are assigned the URI http://terminology.hl7.org/CodeSystem/v2-0003#[code] e.g. http://terminology.hl7.org/CodeSystem/v2-0003/A01, and reference any data change that would trigger the sending of the matching HL7 V2 version, if the application providing the FHIR API supports v2 events internally.

A scheduled event occurs on a fixed or periodic schedule.

And finally, a data event occurs in response to some data-related event in the integrated environment such as a record being added or updated. The data-of-interest for a data event is described using a DataRequirement. This allows for systems to automatically invoke based on data activity occurring within the system. A condition may also be specified to further refine the trigger

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TriggerDefinition ΣTU Element Defines an expected trigger for a module
+ Rule: Either timing, or a data requirement, but not both
+ Rule: A condition only if there is a data requirement
+ Rule: A named event requires a name, a periodic event requires timing, and a data event requires data

Elements defined in Ancestors: id, extension
... type ΣC 1..1 code named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType (Required)
... name ΣC 0..1 string Name or URI that identifies the event
... code Σ 0..1 CodeableConcept Coded definition of the event
... timing[x] ΣC 0..1 Timing of the event
.... timingTiming Timing
.... timingReference Reference(Schedule)
.... timingDate date
.... timingDateTime dateTime
... data ΣC 0..* DataRequirement Triggering data of the event (multiple = 'and')

... condition ΣC 0..1 Expression Whether the event triggers (boolean expression)

doco Documentation for this format icon

Definition: XML | JSON

Constraints

idLevelLocationDescriptionExpression
img trd-1 Rule (base) Either timing, or a data requirement, but not both data.empty() or timing.empty()
img trd-2 Rule (base) A condition only if there is a data requirement condition.exists() implies data.exists()
img trd-3 Rule (base) A named event requires a name, a periodic event requires timing, and a data event requires data (type = 'named-event' implies name.exists()) and (type = 'periodic' implies timing.exists()) and (type.startsWith('data-') implies data.exists())

Terminology Bindings

Path ValueSet Type Documentation
TriggerDefinition.type TriggerType Required

The type of trigger.

TriggerDefinition is used in the following places: EventDefinition and PlanDefinition

 

2.1.28.5.0.6 Expression

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The Expression structure defines an expression that generates a value. The expression is provided in a specifed language (by mime type)

The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Expression ΣTU Element An expression that can be used to generate a value
+ Rule: An expression or a reference must be provided
+ Rule: The name must be a valid variable name in most computer languages

Elements defined in Ancestors: id, extension
... description Σ 0..1 string Natural language description of the condition
... name ΣC 0..1 code Short name assigned to expression for reuse
... language Σ 0..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: Expression Language (Extensible)
Additional BindingsPurpose
Mime Types Max Binding

... reference ΣC 0..1 uri Where the expression is found

doco Documentation for this format icon

Definition: XML | JSON

Constraints

idLevelLocationDescriptionExpression
img exp-1 Rule (base) An expression or a reference must be provided expression.exists() or reference.exists()
img exp-2 Rule (base) The name must be a valid variable name in most computer languages name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\_]{0,63}')

Terminology Bindings

Path ValueSet Type Documentation
Expression.language ExpressionLanguage Extensible

The media type of the expression language.
  http://hl7.org/fhir/ValueSet/mimetypes maximum

Language support

While the expression data type supports any language, a few specific languages defined by HL7 at particularly of interest for the purposes of this specification:

Expression is used in the following places: TriggerDefinition, ActivityDefinition, ChargeItemDefinition, ClinicalUseDefinition, Consent, EvidenceVariable, Group, Measure, Permission, PlanDefinition and RequestOrchestration

 

2.1.28.5.0.7 UsageContext

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The UsageContext structure defines the context of use for a module.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. UsageContext ΣTU Element Describes the context of use for a conformance or knowledge resource

Elements defined in Ancestors: id, extension
... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType icon (Extensible)
... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (Example)
.... valueCodeableConcept CodeableConcept
.... valueQuantity Quantity
.... valueRange Range
.... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)

doco Documentation for this format icon

Definition: XML | JSON

Constraints

Terminology Bindings

Path ValueSet Type Documentation
UsageContext.code UsageContextType icon Extensible

A code that specifies a type of context being specified by a usage context.
UsageContext.value[x] ContextOfUseValueSet Example

This value set defines a base set of codes that can be used to indicate that the content in a resource was developed with a focus and intent of supporting use within particular contexts.

UsageContext is used in the following places: ElementDefinition, ActivityDefinition, ActorDefinition, CanonicalResource, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, Composition, ConceptMap, ConditionDefinition, DeviceDefinition, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, GraphDefinition, Group, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript and ValueSet

2.1.28.5.0.8 ExtendedContactDetail

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The ExtendedContactDetail structure defines extended contact details for a named, or unnamed individual/purpose.

These are extensively used in provider directory resources where contact information is often very rich in nature, and requires additional metadata around their usage.
This datatype permits the context of the contact informations use to be provided, and groups them together with other important metadata.

Not all properties are expected to be present in all instances, and only the ones that apply.
e.g. A website contact will only have the telecom included, but might also include a purpose and possibly a period if required. Whereas an accounts contact detail could include their name, postal address and telephone number (and possibly Organization if it was an outsourced capability)

The period provides the general start and end of the contact's applicability for usage. This is not intended to store a history of usages over time, but a convenient way to record upcoming relevant changes to the content when it is being published.
This permits a contact to be marked as becoming available from X, or is expected to no longer be available from Y. An extension may be used to mark a contact's general availability times (9am - 5pm) and also exceptions where the contact is not available (e.g. Public holidays)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExtendedContactDetail ΣTU Element Contact information

Elements defined in Ancestors: id, extension
... purpose Σ 0..1 CodeableConcept The type of contact
Binding: Contact entity type icon (Preferred)
... name Σ 0..* HumanName Name of an individual to contact

... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)

... organization Σ 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization
... period Σ 0..1 Period Period that this contact was valid for usage

doco Documentation for this format icon

Definition: XML | JSON

Constraints

Terminology Bindings

Path ValueSet Type Documentation
ExtendedContactDetail.purpose ContactEntityType icon Preferred

This example value set defines a set of codes that can be used to indicate the purpose for which you would contact a contact party.

ExtendedContactDetail is used in the following places: VirtualServiceDetail, HealthcareService, InsuranceProduct, Location, Organization, OrganizationAffiliation and PractitionerRole

2.1.28.5.0.9 VirtualServiceDetail

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The VirtualServiceDetail structure defines details of a virtual communication capability, such as a web conference call.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VirtualServiceDetail ΣTU Element Virtual Service Contact Details

Elements defined in Ancestors: id, extension
... channelType Σ 0..1 Coding Channel Type
Binding: Virtual Service Type (Example)
... address[x] Σ 0..1 Contact address/number
.... addressUrl url
.... addressString string
.... addressContactPoint ContactPoint
.... addressExtendedContactDetail ExtendedContactDetail
... additionalInfo Σ 0..* url Web address to see alternative connection details

... sessionKey Σ 0..1 string Session Key required by the virtual service

doco Documentation for this format icon

Definition: XML | JSON

Constraints

Terminology Bindings

Path ValueSet Type Documentation
VirtualServiceDetail.channelType VirtualServiceType Example

Example codes for possible virtual service connection types.

VirtualServiceDetail is used in the following places: Appointment, Encounter and Location

2.1.28.5.0.10 Availability

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The Availability structure defines a pattern of availability data typically used in directory resources.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Availability ΣTU Element Availability data for an {item}

Elements defined in Ancestors: id, extension
... period Σ 0..1 Period When the availability applies
... availableTime ΣC 0..* Element Times the {item} is available
+ Rule: Cannot include start/end times when selecting all day availability.

.... daysOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: Days Of Week (Required)

.... allDay ΣC 0..1 boolean Always available? i.e. 24 hour service
.... availableStartTime ΣC 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime ΣC 0..1 time Closing time of day (ignored if allDay = true)
... notAvailableTime Σ 0..* Element Not available during this time due to provided reason

.... description Σ 0..1 string Reason presented to the user explaining why time not available
.... during Σ 0..1 Period Service not available during this period

doco Documentation for this format icon

Definition: XML | JSON

Constraints

idLevelLocationDescriptionExpression
img av-1 Rule Availability.availableTime Cannot include start/end times when selecting all day availability. allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())

Terminology Bindings

Path ValueSet Type Documentation
Availability.availableTime.daysOfWeek DaysOfWeek Required

The days of the week.

Availability is used in the following places: Endpoint, HealthcareService, Location and PractitionerRole

2.1.28.5.0.11 MonetaryComponent

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Trial Use

See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions

The MonetaryComponent structure defines a the set of properties across the financial resources.

This component is typically used in a list where each value provides a different type of value contributing to the final value used in line items on a financial transaction.
For example, a line item for a product might include the net price, the tax amount, and the surcharge amount as separate components.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MonetaryComponent ΣTU Element Types and value of financial information that apply to line item(s)

Elements defined in Ancestors: id, extension
... type Σ 1..1 code base | surcharge | discount | tax | informational
Binding: Price Component Type (Required)
... code Σ 0..1 CodeableConcept Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
... factor Σ 0..1 decimal Factor used for calculating this component

doco Documentation for this format icon

Definition: XML | JSON

Constraints

Terminology Bindings

Path ValueSet Type Documentation
MonetaryComponent.type PriceComponentType Required

Codes indicating the kind of the price component.
MonetaryComponent.code Unknown No details provided yet Example Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

MonetaryComponent is used in the following places: ChargeItem, ChargeItemDefinition and Invoice