R4 Draft for Comment
AdministrationThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Financial Management Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Patient, Practitioner, RelatedPerson |
StructureDefinition for invoice
{
"resourceType": "StructureDefinition",
"id": "Invoice",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Invoice",
"name": "Invoice",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
}
],
"kind": "resource",
"abstract": false,
"type": "Invoice",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Invoice",
"path": "Invoice",
"short": "Invoice containing ChargeItems from an Account",
"definition": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "FT1"
},
{
"identity": "rim",
"map": "Act[moodCode=EVN]"
},
{
"identity": "w5",
"map": "financial.support"
}
]
},
{
"id": "Invoice.id",
"path": "Invoice.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Invoice.meta",
"path": "Invoice.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Invoice.implicitRules",
"path": "Invoice.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Invoice.language",
"path": "Invoice.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "Invoice.text",
"path": "Invoice.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Invoice.contained",
"path": "Invoice.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Invoice.extension",
"path": "Invoice.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to 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": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Invoice.modifierExtension",
"path": "Invoice.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Invoice.identifier",
"path": "Invoice.identifier",
"short": "Business Identifier for item",
"definition": "Identifier of this Invoice, often used for reference in corresponcence about this invoice or for tracking of payments.",
"requirements": "Allows Identification of this Invoice instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "FT1.2"
},
{
"identity": "rim",
"map": ".identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Invoice.status",
"path": "Invoice.status",
"short": "draft | issued | balanced | cancelled | entered-in-error",
"definition": "The current state of the Invoice.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InvoiceStatus"
}
],
"strength": "required",
"description": "Codes identifying the stage lifecycle stage of an Invoice",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/invoice-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Invoice.cancelledReason",
"path": "Invoice.cancelledReason",
"short": "Reason for cancellation of this Invoice",
"definition": "In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc).",
"comment": "Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": false
},
{
"id": "Invoice.type",
"path": "Invoice.type",
"short": "Type of Invoice",
"definition": "Type of Invoice depending on domain, realm an usage (eg. internal/external, dental, preliminary).",
"alias": [
"type"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "FT1.7"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Invoice.subject",
"path": "Invoice.subject",
"short": "Recipient(s) of goods and services",
"definition": "The individual or set of individuals receiving the goods and services billed in this invoice.",
"requirements": "Links the event to the Patient context.",
"alias": [
"patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PAT in proximity to FT1 segment"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Invoice.recipient",
"path": "Invoice.recipient",
"short": "Recipient of this invoice",
"definition": "The individual or Organization responsible for balancing of this invoice.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "v2",
"map": "PV1 in proximity to FT1 segment"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}
]
},
{
"id": "Invoice.date",
"path": "Invoice.date",
"short": "Invoice date / posting date",
"definition": "Date/time(s) of when this Invoice was posted.",
"comment": "The list of types may be constrained as appropriate for the type of charge item.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.done[x]"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "Invoice.participant",
"path": "Invoice.participant",
"short": "Participant in creation of this Invoice",
"definition": "Indicates who or what performed or participated in the charged service.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.participant.id",
"path": "Invoice.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Invoice.participant.extension",
"path": "Invoice.participant.extension",
"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. In order 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 is allowed to 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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Invoice.participant.modifierExtension",
"path": "Invoice.participant.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Invoice.participant.role",
"path": "Invoice.participant.role",
"short": "Type of involevent in creation of this Invoice",
"definition": "Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".participation.functionCode"
}
]
},
{
"id": "Invoice.participant.actor",
"path": "Invoice.participant.actor",
"short": "Individual who was involved",
"definition": "The device, practitioner, etc. who performed or participated in the service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".player"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "Invoice.issuer",
"path": "Invoice.issuer",
"short": "Issuing Organization of Invoice",
"definition": "The organizationissuing the Invoice.",
"comment": "Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": ".scoper"
}
]
},
{
"id": "Invoice.account",
"path": "Invoice.account",
"short": "Account that is being balanced",
"definition": "Account which is supposed to be balanced with this Invoice.",
"comment": "Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Account"
}
],
"isSummary": false
},
{
"id": "Invoice.lineItem",
"path": "Invoice.lineItem",
"short": "Line items of this Invoice",
"definition": "Each line item represents one charge for goods ond services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.lineItem.id",
"path": "Invoice.lineItem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Invoice.lineItem.extension",
"path": "Invoice.lineItem.extension",
"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. In order 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 is allowed to 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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Invoice.lineItem.modifierExtension",
"path": "Invoice.lineItem.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Invoice.lineItem.sequence",
"path": "Invoice.lineItem.sequence",
"short": "Sequence number of line item",
"definition": "Sequence in which the items appear on the invoice.",
"min": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"isSummary": false
},
{
"id": "Invoice.lineItem.chargeItem",
"path": "Invoice.lineItem.chargeItem",
"short": "Reference to ChargeItem containing details of this line item",
"definition": "The ChargeItem contains information such as the billing code, date, amount etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ChargeItem"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".player"
}
]
},
{
"id": "Invoice.lineItem.priceComponent",
"path": "Invoice.lineItem.priceComponent",
"short": "Components of total line item price",
"definition": "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.id",
"path": "Invoice.lineItem.priceComponent.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.extension",
"path": "Invoice.lineItem.priceComponent.extension",
"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. In order 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 is allowed to 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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.modifierExtension",
"path": "Invoice.lineItem.priceComponent.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.type",
"path": "Invoice.lineItem.priceComponent.type",
"short": "base | surcharge | deduction | discount | tax | informational",
"definition": "This code identifies the type of the component.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InvoicePriceComponentType"
}
],
"strength": "required",
"description": "Codes indicating the details of what is/was done. These will vary significantly based on the type of request resource and will often be example/preferred rather than extensible/required.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/invoice-priceComponentType"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "v2",
"map": "FT1.7"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.code",
"path": "Invoice.lineItem.priceComponent.code",
"short": "Code identifying the specific component",
"definition": "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "v2",
"map": "FT1.7"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.factor",
"path": "Invoice.lineItem.priceComponent.factor",
"short": "Monetary amount associated with this component",
"definition": "The amount calculated for this component.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.amount",
"path": "Invoice.lineItem.priceComponent.amount",
"short": "Factor used for calculating this component",
"definition": "The factor that has been applied on the base price for calculating this component.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.totalPriceComponent",
"path": "Invoice.totalPriceComponent",
"short": "Components of Invoice total",
"definition": "The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.",
"min": 0,
"max": "*",
"contentReference": "#Invoice.lineItem.priceComponent",
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.totalNet",
"path": "Invoice.totalNet",
"short": "Net total of this Invoice",
"definition": "Invoice total , taxes excluded.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.totalGross",
"path": "Invoice.totalGross",
"short": "Gross toal of this Invoice",
"definition": "Invoice total, tax included.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.paymentTerms",
"path": "Invoice.paymentTerms",
"short": "Payment details",
"definition": "Payment details such as banking details, period of payment, deductables, methods of payment.",
"comment": "Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": false
},
{
"id": "Invoice.note",
"path": "Invoice.note",
"short": "Comments made about the invoice",
"definition": "Comments made about the invoice by the issuer, subject or other participants.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "v2",
"map": "NTE"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Invoice",
"path": "Invoice",
"short": "Invoice containing ChargeItems from an Account",
"definition": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "FT1"
},
{
"identity": "rim",
"map": "Act[moodCode=EVN]"
},
{
"identity": "w5",
"map": "financial.support"
}
]
},
{
"id": "Invoice.identifier",
"path": "Invoice.identifier",
"short": "Business Identifier for item",
"definition": "Identifier of this Invoice, often used for reference in corresponcence about this invoice or for tracking of payments.",
"requirements": "Allows Identification of this Invoice instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "FT1.2"
},
{
"identity": "rim",
"map": ".identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Invoice.status",
"path": "Invoice.status",
"short": "draft | issued | balanced | cancelled | entered-in-error",
"definition": "The current state of the Invoice.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InvoiceStatus"
}
],
"strength": "required",
"description": "Codes identifying the stage lifecycle stage of an Invoice",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/invoice-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Invoice.cancelledReason",
"path": "Invoice.cancelledReason",
"short": "Reason for cancellation of this Invoice",
"definition": "In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc).",
"comment": "Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": false
},
{
"id": "Invoice.type",
"path": "Invoice.type",
"short": "Type of Invoice",
"definition": "Type of Invoice depending on domain, realm an usage (eg. internal/external, dental, preliminary).",
"alias": [
"type"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "FT1.7"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Invoice.subject",
"path": "Invoice.subject",
"short": "Recipient(s) of goods and services",
"definition": "The individual or set of individuals receiving the goods and services billed in this invoice.",
"requirements": "Links the event to the Patient context.",
"alias": [
"patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PAT in proximity to FT1 segment"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Invoice.recipient",
"path": "Invoice.recipient",
"short": "Recipient of this invoice",
"definition": "The individual or Organization responsible for balancing of this invoice.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "v2",
"map": "PV1 in proximity to FT1 segment"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}
]
},
{
"id": "Invoice.date",
"path": "Invoice.date",
"short": "Invoice date / posting date",
"definition": "Date/time(s) of when this Invoice was posted.",
"comment": "The list of types may be constrained as appropriate for the type of charge item.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.done[x]"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "Invoice.participant",
"path": "Invoice.participant",
"short": "Participant in creation of this Invoice",
"definition": "Indicates who or what performed or participated in the charged service.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.participant.role",
"path": "Invoice.participant.role",
"short": "Type of involevent in creation of this Invoice",
"definition": "Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".participation.functionCode"
}
]
},
{
"id": "Invoice.participant.actor",
"path": "Invoice.participant.actor",
"short": "Individual who was involved",
"definition": "The device, practitioner, etc. who performed or participated in the service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".player"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "Invoice.issuer",
"path": "Invoice.issuer",
"short": "Issuing Organization of Invoice",
"definition": "The organizationissuing the Invoice.",
"comment": "Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": ".scoper"
}
]
},
{
"id": "Invoice.account",
"path": "Invoice.account",
"short": "Account that is being balanced",
"definition": "Account which is supposed to be balanced with this Invoice.",
"comment": "Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Account"
}
],
"isSummary": false
},
{
"id": "Invoice.lineItem",
"path": "Invoice.lineItem",
"short": "Line items of this Invoice",
"definition": "Each line item represents one charge for goods ond services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.lineItem.sequence",
"path": "Invoice.lineItem.sequence",
"short": "Sequence number of line item",
"definition": "Sequence in which the items appear on the invoice.",
"min": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"isSummary": false
},
{
"id": "Invoice.lineItem.chargeItem",
"path": "Invoice.lineItem.chargeItem",
"short": "Reference to ChargeItem containing details of this line item",
"definition": "The ChargeItem contains information such as the billing code, date, amount etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ChargeItem"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".player"
}
]
},
{
"id": "Invoice.lineItem.priceComponent",
"path": "Invoice.lineItem.priceComponent",
"short": "Components of total line item price",
"definition": "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.type",
"path": "Invoice.lineItem.priceComponent.type",
"short": "base | surcharge | deduction | discount | tax | informational",
"definition": "This code identifies the type of the component.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InvoicePriceComponentType"
}
],
"strength": "required",
"description": "Codes indicating the details of what is/was done. These will vary significantly based on the type of request resource and will often be example/preferred rather than extensible/required.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/invoice-priceComponentType"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "v2",
"map": "FT1.7"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.code",
"path": "Invoice.lineItem.priceComponent.code",
"short": "Code identifying the specific component",
"definition": "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "v2",
"map": "FT1.7"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.factor",
"path": "Invoice.lineItem.priceComponent.factor",
"short": "Monetary amount associated with this component",
"definition": "The amount calculated for this component.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.lineItem.priceComponent.amount",
"path": "Invoice.lineItem.priceComponent.amount",
"short": "Factor used for calculating this component",
"definition": "The factor that has been applied on the base price for calculating this component.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.totalPriceComponent",
"path": "Invoice.totalPriceComponent",
"short": "Components of Invoice total",
"definition": "The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.",
"min": 0,
"max": "*",
"contentReference": "#Invoice.lineItem.priceComponent",
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Invoice.totalNet",
"path": "Invoice.totalNet",
"short": "Net total of this Invoice",
"definition": "Invoice total , taxes excluded.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.totalGross",
"path": "Invoice.totalGross",
"short": "Gross toal of this Invoice",
"definition": "Invoice total, tax included.",
"comment": "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "FT1.22"
}
]
},
{
"id": "Invoice.paymentTerms",
"path": "Invoice.paymentTerms",
"short": "Payment details",
"definition": "Payment details such as banking details, period of payment, deductables, methods of payment.",
"comment": "Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": false
},
{
"id": "Invoice.note",
"path": "Invoice.note",
"short": "Comments made about the invoice",
"definition": "Comments made about the invoice by the issuer, subject or other participants.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "v2",
"map": "NTE"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}
]
}
]
}
}
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.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:57+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change