Structure Definition: ChargeItem Profile
Canonical URL: http://hl7.org/fhir/StructureDefinition/ChargeItem
Simplifier project page: Not Applicable
Derived from: FHIR R4 ChargeItem
Module: Finance Module
Formal profile content
{ "resourceType": "StructureDefinition", "id": "ChargeItem", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Financial.General" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode": "patient" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" } ], "url": "http://hl7.org/fhir/StructureDefinition/ChargeItem", "version": "4.0.1", "name": "ChargeItem", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "Health Level Seven International (Patient Administration)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/pafm/index.cfm" } ] } ], "description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "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/fivews", "name": "FiveWs Pattern Mapping" } ], "kind": "resource", "abstract": false, "type": "ChargeItem", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "snapshot": { "element": [ { "id": "ChargeItem", "path": "ChargeItem", "short": "Item containing charge code(s) associated with the provision of healthcare provider products", "definition": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.", "min": 0, "max": "*", "base": { "path": "ChargeItem", "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": "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "FT1" }, { "identity": "rim", "map": "Act[moodCode=EVN]" } ] }, { "id": "ChargeItem.id", "path": "ChargeItem.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": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": true }, { "id": "ChargeItem.meta", "path": "ChargeItem.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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "ChargeItem.implicitRules", "path": "ChargeItem.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true }, { "id": "ChargeItem.language", "path": "ChargeItem.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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "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": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "ChargeItem.text", "path": "ChargeItem.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can 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 information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "ChargeItem.contained", "path": "ChargeItem.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "ChargeItem.extension", "path": "ChargeItem.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "ChargeItem.modifierExtension", "path": "ChargeItem.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "ChargeItem.identifier", "path": "ChargeItem.identifier", "short": "Business Identifier for item", "definition": "Identifiers assigned to this event performer or other systems.", "requirements": "Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "base": { "path": "ChargeItem.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "FT1.2" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "ChargeItem.definitionUri", "path": "ChargeItem.definitionUri", "short": "Defining information about the code of this charge item", "definition": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.", "min": 0, "max": "*", "base": { "path": "ChargeItem.definitionUri", "min": 0, "max": "*" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.instantiates" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "ChargeItem.definitionCanonical", "path": "ChargeItem.definitionCanonical", "short": "Resource defining the code of this ChargeItem", "definition": "References the source of pricing information, rules of application for the code this ChargeItem uses.", "min": 0, "max": "*", "base": { "path": "ChargeItem.definitionCanonical", "min": 0, "max": "*" }, "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.instantiates" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "ChargeItem.status", "path": "ChargeItem.status", "short": "planned | billable | not-billable | aborted | billed | entered-in-error | unknown", "definition": "The current state of the ChargeItem.", "comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.", "min": 1, "max": "1", "base": { "path": "ChargeItem.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemStatus" } ], "strength": "required", "description": "Codes identifying the lifecycle stage of a ChargeItem.", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".status" } ] }, { "id": "ChargeItem.partOf", "path": "ChargeItem.partOf", "short": "Part of referenced ChargeItem", "definition": "ChargeItems can be grouped to larger ChargeItems covering the whole set.", "requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.", "alias": [ "container" ], "min": 0, "max": "*", "base": { "path": "ChargeItem.partOf", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItem" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ] }, { "id": "ChargeItem.code", "path": "ChargeItem.code", "short": "A code that identifies the charge, like a billing code", "definition": "A code that identifies the charge, like a billing code.", "alias": [ "type" ], "min": 1, "max": "1", "base": { "path": "ChargeItem.code", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemCode" } ], "strength": "example", "description": "Example set of codes that can be used for billing purposes.", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes" }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "FT1.7" }, { "identity": "rim", "map": ".code" } ] }, { "id": "ChargeItem.subject", "path": "ChargeItem.subject", "short": "Individual service was done for/to", "definition": "The individual or set of individuals the action is being or was performed on.", "requirements": "Links the event to the Patient context.", "alias": [ "patient" ], "min": 1, "max": "1", "base": { "path": "ChargeItem.subject", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "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": "FiveWs.subject" } ] }, { "id": "ChargeItem.context", "path": "ChargeItem.context", "short": "Encounter / Episode associated with event", "definition": "The encounter or episode of care that establishes the context for this event.", "requirements": "Links the request to the Encounter context.", "alias": [ "encounter" ], "min": 0, "max": "1", "base": { "path": "ChargeItem.context", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1 in proximity to FT1 segment" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]" } ] }, { "id": "ChargeItem.occurrence[x]", "path": "ChargeItem.occurrence[x]", "short": "When the charged service was applied", "definition": "Date/time(s) or duration when the charged service was applied.", "comment": "The list of types may be constrained as appropriate for the type of charge item.", "alias": [ "timing" ], "min": 0, "max": "1", "base": { "path": "ChargeItem.occurrence[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "id": "ChargeItem.performer", "path": "ChargeItem.performer", "short": "Who performed charged service", "definition": "Indicates who or what performed or participated in the charged service.", "min": 0, "max": "*", "base": { "path": "ChargeItem.performer", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" } ] }, { "id": "ChargeItem.performer.id", "path": "ChargeItem.performer.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ChargeItem.performer.extension", "path": "ChargeItem.performer.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ChargeItem.performer.modifierExtension", "path": "ChargeItem.performer.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "ChargeItem.performer.function", "path": "ChargeItem.performer.function", "short": "What type of performance was done", "definition": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).", "min": 0, "max": "1", "base": { "path": "ChargeItem.performer.function", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemPerformerFunction" } ], "strength": "example", "description": "Codes describing the types of functional roles performers can take on when performing events.", "valueSet": "http://hl7.org/fhir/ValueSet/performer-role" }, "mapping": [ { "identity": "workflow", "map": "Event.performer.function" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".participation.functionCode" } ] }, { "id": "ChargeItem.performer.actor", "path": "ChargeItem.performer.actor", "short": "Individual who was performing", "definition": "The device, practitioner, etc. who performed or participated in the service.", "min": 1, "max": "1", "base": { "path": "ChargeItem.performer.actor", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".player" } ] }, { "id": "ChargeItem.performingOrganization", "path": "ChargeItem.performingOrganization", "short": "Organization providing the charged service", "definition": "The organization requesting the service.", "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", "base": { "path": "ChargeItem.performingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] }, { "id": "ChargeItem.requestingOrganization", "path": "ChargeItem.requestingOrganization", "short": "Organization requesting the charged service", "definition": "The organization performing the service.", "comment": "The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).", "min": 0, "max": "1", "base": { "path": "ChargeItem.requestingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] }, { "id": "ChargeItem.costCenter", "path": "ChargeItem.costCenter", "short": "Organization that has ownership of the (potential, future) revenue", "definition": "The financial cost center permits the tracking of charge attribution.", "comment": "The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.", "min": 0, "max": "1", "base": { "path": "ChargeItem.costCenter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.13" } ] }, { "id": "ChargeItem.quantity", "path": "ChargeItem.quantity", "short": "Quantity of which the charge item has been serviced", "definition": "Quantity of which the charge item has been serviced.", "comment": "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.", "min": 0, "max": "1", "base": { "path": "ChargeItem.quantity", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "FT1.10" } ] }, { "id": "ChargeItem.bodysite", "path": "ChargeItem.bodysite", "short": "Anatomical location, if relevant", "definition": "The anatomical location where the related service has been applied.", "comment": "Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.", "min": 0, "max": "*", "base": { "path": "ChargeItem.bodysite", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSet": "http://hl7.org/fhir/ValueSet/body-site" }, "mapping": [ { "identity": "rim", "map": ".targetBodySiteCode" } ] }, { "id": "ChargeItem.factorOverride", "path": "ChargeItem.factorOverride", "short": "Factor overriding the associated rules", "definition": "Factor overriding the factor determined by the rules associated with the code.", "comment": "There is no reason to carry the factor in the instance of a ChargeItem unless special circumstances require a manual override. The factors are usually defined by a set of rules 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 overridden.", "min": 0, "max": "1", "base": { "path": "ChargeItem.factorOverride", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.26" } ] }, { "id": "ChargeItem.priceOverride", "path": "ChargeItem.priceOverride", "short": "Price overriding the associated rules", "definition": "Total price of the charge overriding the list price associated with the code.", "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 overridden.", "min": 0, "max": "1", "base": { "path": "ChargeItem.priceOverride", "min": 0, "max": "1" }, "type": [ { "code": "Money" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.22" } ] }, { "id": "ChargeItem.overrideReason", "path": "ChargeItem.overrideReason", "short": "Reason for overriding the list price/factor", "definition": "If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.", "comment": "Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.", "min": 0, "max": "1", "base": { "path": "ChargeItem.overrideReason", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false }, { "id": "ChargeItem.enterer", "path": "ChargeItem.enterer", "short": "Individual who was entering", "definition": "The device, practitioner, etc. who entered the charge item.", "comment": "The enterer is also the person considered responsible for factor/price overrides if applicable.", "min": 0, "max": "1", "base": { "path": "ChargeItem.enterer", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".player" } ] }, { "id": "ChargeItem.enteredDate", "path": "ChargeItem.enteredDate", "short": "Date the charge item was entered", "definition": "Date the charge item was entered.", "comment": "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].", "min": 0, "max": "1", "base": { "path": "ChargeItem.enteredDate", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "ChargeItem.reason", "path": "ChargeItem.reason", "short": "Why was the charged service rendered?", "definition": "Describes why the event occurred in coded or textual form.", "comment": "If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.", "min": 0, "max": "*", "base": { "path": "ChargeItem.reason", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemReason" } ], "strength": "example", "description": "Example binding for reason.", "valueSet": "http://hl7.org/fhir/ValueSet/icd-10" }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "EVN.4 or by domain" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "ChargeItem.service", "path": "ChargeItem.service", "short": "Which rendered service is being charged?", "definition": "Indicated the rendered service that caused this charge.", "min": 0, "max": "*", "base": { "path": "ChargeItem.service", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/ImagingStudy", "http://hl7.org/fhir/StructureDefinition/Immunization", "http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/SupplyDelivery" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "EVN.4 or by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" } ] }, { "id": "ChargeItem.product[x]", "path": "ChargeItem.product[x]", "short": "Product charged", "definition": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.", "min": 0, "max": "1", "base": { "path": "ChargeItem.product[x]", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Substance" ] }, { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemProduct" } ], "strength": "example", "description": "Example binding for product type.", "valueSet": "http://hl7.org/fhir/ValueSet/device-kind" }, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=CSM].role" } ] }, { "id": "ChargeItem.account", "path": "ChargeItem.account", "short": "Account to place this charge", "definition": "Account into which this ChargeItems belongs.", "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 postprocessing 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": "*", "base": { "path": "ChargeItem.account", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Account" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "ChargeItem.note", "path": "ChargeItem.note", "short": "Comments made about the ChargeItem", "definition": "Comments made about the event by the performer, subject or other participants.", "min": 0, "max": "*", "base": { "path": "ChargeItem.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": 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]" } ] }, { "id": "ChargeItem.supportingInformation", "path": "ChargeItem.supportingInformation", "short": "Further information supporting this charge", "definition": "Further information supporting this charge.", "min": 0, "max": "*", "base": { "path": "ChargeItem.supportingInformation", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.supportingInfo" } ] } ] }, "differential": { "element": [ { "id": "ChargeItem", "path": "ChargeItem", "short": "Item containing charge code(s) associated with the provision of healthcare provider products", "definition": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.", "min": 0, "max": "*", "mapping": [ { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "FT1" }, { "identity": "rim", "map": "Act[moodCode=EVN]" } ] }, { "id": "ChargeItem.identifier", "path": "ChargeItem.identifier", "short": "Business Identifier for item", "definition": "Identifiers assigned to this event performer or other systems.", "requirements": "Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "FT1.2" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "ChargeItem.definitionUri", "path": "ChargeItem.definitionUri", "short": "Defining information about the code of this charge item", "definition": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.instantiates" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "ChargeItem.definitionCanonical", "path": "ChargeItem.definitionCanonical", "short": "Resource defining the code of this ChargeItem", "definition": "References the source of pricing information, rules of application for the code this ChargeItem uses.", "min": 0, "max": "*", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition" ] } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.instantiates" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "ChargeItem.status", "path": "ChargeItem.status", "short": "planned | billable | not-billable | aborted | billed | entered-in-error | unknown", "definition": "The current state of the ChargeItem.", "comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemStatus" } ], "strength": "required", "description": "Codes identifying the lifecycle stage of a ChargeItem.", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".status" } ] }, { "id": "ChargeItem.partOf", "path": "ChargeItem.partOf", "short": "Part of referenced ChargeItem", "definition": "ChargeItems can be grouped to larger ChargeItems covering the whole set.", "requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.", "alias": [ "container" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItem" ] } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ] }, { "id": "ChargeItem.code", "path": "ChargeItem.code", "short": "A code that identifies the charge, like a billing code", "definition": "A code that identifies the charge, like a billing code.", "alias": [ "type" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemCode" } ], "strength": "example", "description": "Example set of codes that can be used for billing purposes.", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes" }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "FT1.7" }, { "identity": "rim", "map": ".code" } ] }, { "id": "ChargeItem.subject", "path": "ChargeItem.subject", "short": "Individual service was done for/to", "definition": "The individual or set of individuals the action is being or was performed on.", "requirements": "Links the event to the Patient context.", "alias": [ "patient" ], "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "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": "FiveWs.subject" } ] }, { "id": "ChargeItem.context", "path": "ChargeItem.context", "short": "Encounter / Episode associated with event", "definition": "The encounter or episode of care that establishes the context for this event.", "requirements": "Links the request to the Encounter context.", "alias": [ "encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1 in proximity to FT1 segment" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]" } ] }, { "id": "ChargeItem.occurrence[x]", "path": "ChargeItem.occurrence[x]", "short": "When the charged service was applied", "definition": "Date/time(s) or duration when the charged service was applied.", "comment": "The list of types may be constrained as appropriate for the type of charge item.", "alias": [ "timing" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "id": "ChargeItem.performer", "path": "ChargeItem.performer", "short": "Who performed charged service", "definition": "Indicates who or what performed or participated in the charged service.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" } ] }, { "id": "ChargeItem.performer.function", "path": "ChargeItem.performer.function", "short": "What type of performance was done", "definition": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemPerformerFunction" } ], "strength": "example", "description": "Codes describing the types of functional roles performers can take on when performing events.", "valueSet": "http://hl7.org/fhir/ValueSet/performer-role" }, "mapping": [ { "identity": "workflow", "map": "Event.performer.function" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".participation.functionCode" } ] }, { "id": "ChargeItem.performer.actor", "path": "ChargeItem.performer.actor", "short": "Individual who was performing", "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", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".player" } ] }, { "id": "ChargeItem.performingOrganization", "path": "ChargeItem.performingOrganization", "short": "Organization providing the charged service", "definition": "The organization requesting the service.", "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": "workflow", "map": "Event.performer.actor" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".scoper" } ] }, { "id": "ChargeItem.requestingOrganization", "path": "ChargeItem.requestingOrganization", "short": "Organization requesting the charged service", "definition": "The organization performing the service.", "comment": "The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).", "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": "ChargeItem.costCenter", "path": "ChargeItem.costCenter", "short": "Organization that has ownership of the (potential, future) revenue", "definition": "The financial cost center permits the tracking of charge attribution.", "comment": "The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.13" } ] }, { "id": "ChargeItem.quantity", "path": "ChargeItem.quantity", "short": "Quantity of which the charge item has been serviced", "definition": "Quantity of which the charge item has been serviced.", "comment": "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "FT1.10" } ] }, { "id": "ChargeItem.bodysite", "path": "ChargeItem.bodysite", "short": "Anatomical location, if relevant", "definition": "The anatomical location where the related service has been applied.", "comment": "Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSet": "http://hl7.org/fhir/ValueSet/body-site" }, "mapping": [ { "identity": "rim", "map": ".targetBodySiteCode" } ] }, { "id": "ChargeItem.factorOverride", "path": "ChargeItem.factorOverride", "short": "Factor overriding the associated rules", "definition": "Factor overriding the factor determined by the rules associated with the code.", "comment": "There is no reason to carry the factor in the instance of a ChargeItem unless special circumstances require a manual override. The factors are usually defined by a set of rules 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 overridden.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.26" } ] }, { "id": "ChargeItem.priceOverride", "path": "ChargeItem.priceOverride", "short": "Price overriding the associated rules", "definition": "Total price of the charge overriding the list price associated with the code.", "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 overridden.", "min": 0, "max": "1", "type": [ { "code": "Money" } ], "isSummary": false, "mapping": [ { "identity": "v2", "map": "FT1.22" } ] }, { "id": "ChargeItem.overrideReason", "path": "ChargeItem.overrideReason", "short": "Reason for overriding the list price/factor", "definition": "If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.", "comment": "Derived Profiles may choose 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": "ChargeItem.enterer", "path": "ChargeItem.enterer", "short": "Individual who was entering", "definition": "The device, practitioner, etc. who entered the charge item.", "comment": "The enterer is also the person considered responsible for factor/price overrides if applicable.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "EVN.5 or by domain" }, { "identity": "rim", "map": ".player" } ] }, { "id": "ChargeItem.enteredDate", "path": "ChargeItem.enteredDate", "short": "Date the charge item was entered", "definition": "Date the charge item was entered.", "comment": "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true }, { "id": "ChargeItem.reason", "path": "ChargeItem.reason", "short": "Why was the charged service rendered?", "definition": "Describes why the event occurred in coded or textual form.", "comment": "If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemReason" } ], "strength": "example", "description": "Example binding for reason.", "valueSet": "http://hl7.org/fhir/ValueSet/icd-10" }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "EVN.4 or by domain" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "ChargeItem.service", "path": "ChargeItem.service", "short": "Which rendered service is being charged?", "definition": "Indicated the rendered service that caused this charge.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/ImagingStudy", "http://hl7.org/fhir/StructureDefinition/Immunization", "http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/SupplyDelivery" ] } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "EVN.4 or by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" } ] }, { "id": "ChargeItem.product[x]", "path": "ChargeItem.product[x]", "short": "Product charged", "definition": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Substance" ] }, { "code": "CodeableConcept" } ], "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemProduct" } ], "strength": "example", "description": "Example binding for product type.", "valueSet": "http://hl7.org/fhir/ValueSet/device-kind" }, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=CSM].role" } ] }, { "id": "ChargeItem.account", "path": "ChargeItem.account", "short": "Account to place this charge", "definition": "Account into which this ChargeItems belongs.", "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 postprocessing 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": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Account" ] } ], "isSummary": true }, { "id": "ChargeItem.note", "path": "ChargeItem.note", "short": "Comments made about the ChargeItem", "definition": "Comments made about the event by the performer, 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]" } ] }, { "id": "ChargeItem.supportingInformation", "path": "ChargeItem.supportingInformation", "short": "Further information supporting this charge", "definition": "Further information supporting this charge.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.supportingInfo" } ] } ] } }
Profile usage
The asdf.
Profile element notes
.type
- FUTURE - asdf