{ "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.", "_filename": "chargeitem.profile.json", "package_name": "hl7.fhir.r5.examples", "date": "2021-05-03T21:59:52+10:00", "derivation": "specialization", "meta": { "lastUpdated": "2021-05-03T21:59:52.634+10:00" }, "publisher": "Health Level Seven International (Patient Administration)", "fhirVersion": "4.6.0", "name": "ChargeItem", "mapping": [ { "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern", "identity": "workflow" }, { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping", "identity": "w5" } ], "abstract": false, "type": "ChargeItem", "experimental": null, "resourceType": "StructureDefinition", "title": null, "package_version": "4.6.0", "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" } ], "snapshot": { "element": [ { "constraint": [ { "key": "dom-2", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.contained.empty()" }, { "key": "dom-3", "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", "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", "severity": "error", "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()" }, { "key": "dom-4", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "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", "severity": "error", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" }, { "key": "dom-5", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.meta.security.empty()" }, { "key": "dom-6", "human": "A resource should have narrative for robust management", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "warning", "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." } ], "expression": "text.`div`.exists()" } ], "path": "ChargeItem", "min": 0, "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.", "isModifier": false, "short": "Item containing charge code(s) associated with the provision of healthcare provider products", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "Event", "identity": "workflow" }, { "map": "FT1", "identity": "v2" }, { "map": "Act[moodCode=EVN]", "identity": "rim" }, { "map": "financial.support", "identity": "w5" } ], "mustSupport": false, "max": "*", "id": "ChargeItem", "base": { "max": "*", "min": 0, "path": "ChargeItem" }, "isSummary": false }, { "path": "ChargeItem.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "isModifier": false, "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri": "id" } ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.id", "comment": "Typically, the resource has an id except for cases like the create operation, conditional updates.", "base": { "max": "1", "min": 0, "path": "Resource.id" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.meta", "min": 0, "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.", "isModifier": false, "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.implicitRules", "min": 0, "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.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.implicitRules", "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.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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 }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.language", "min": 0, "definition": "The base language in which the resource is written.", "isModifier": false, "short": "Language of the resource content", "type": [ { "code": "code" } ], "mustSupport": false, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/languages", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "A human language." }, { "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 } ], "description": "IETF language tag" }, "max": "1", "id": "ChargeItem.language", "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).", "base": { "max": "1", "min": 0, "path": "Resource.language" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.text", "min": 0, "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.", "isModifier": false, "short": "Text summary of the resource, for human interpretation", "mapping": [ { "map": "Act.text?", "identity": "rim" } ], "type": [ { "code": "Narrative" } ], "mustSupport": false, "alias": [ "narrative", "html", "xhtml", "display" ], "max": "1", "id": "ChargeItem.text", "comment": "Contained resources do not have a 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.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "isSummary": false }, { "path": "ChargeItem.contained", "min": 0, "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.", "isModifier": false, "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "mustSupport": false, "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "ChargeItem.contained", "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "ChargeItem.extension", "min": 0, "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.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "mustSupport": false, "alias": [ "extensions", "user content" ], "max": "*", "id": "ChargeItem.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.", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "ChargeItem.modifierExtension", "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).", "min": 0, "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).", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "mustSupport": false, "alias": [ "extensions", "user content" ], "max": "*", "id": "ChargeItem.modifierExtension", "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.identifier", "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, "definition": "Identifiers assigned to this event performer or other systems.", "isModifier": false, "short": "Business Identifier for item", "mapping": [ { "map": "Event.identifier", "identity": "workflow" }, { "map": "FiveWs.identifier", "identity": "w5" }, { "map": "FT1.2", "identity": "v2" }, { "map": ".identifier", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.identifier", "base": { "max": "*", "min": 0, "path": "ChargeItem.identifier" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.definitionUri", "min": 0, "definition": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.", "isModifier": false, "short": "Defining information about the code of this charge item", "mapping": [ { "map": "Event.instantiates", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "type": [ { "code": "uri" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.definitionUri", "base": { "max": "*", "min": 0, "path": "ChargeItem.definitionUri" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.definitionCanonical", "min": 0, "definition": "References the source of pricing information, rules of application for the code this ChargeItem uses.", "isModifier": false, "short": "Resource defining the code of this ChargeItem", "mapping": [ { "map": "Event.instantiates", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.definitionCanonical", "base": { "max": "*", "min": 0, "path": "ChargeItem.definitionCanonical" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.status", "min": 1, "definition": "The current state of the ChargeItem.", "isModifier": true, "short": "planned | billable | not-billable | aborted | billed | entered-in-error | unknown", "mapping": [ { "map": "Event.status", "identity": "workflow" }, { "map": "FiveWs.status", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".status", "identity": "rim" } ], "type": [ { "code": "code" } ], "mustSupport": false, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-status|4.6.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemStatus" } ], "description": "Codes identifying the lifecycle stage of a ChargeItem." }, "max": "1", "id": "ChargeItem.status", "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.", "base": { "max": "1", "min": 1, "path": "ChargeItem.status" }, "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 }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.partOf", "requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.", "min": 0, "definition": "ChargeItems can be grouped to larger ChargeItems covering the whole set.", "isModifier": false, "short": "Part of referenced ChargeItem", "mapping": [ { "map": "Event.partOf", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItem" ] } ], "mustSupport": false, "alias": [ "container" ], "max": "*", "id": "ChargeItem.partOf", "base": { "max": "*", "min": 0, "path": "ChargeItem.partOf" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.code", "min": 1, "definition": "A code that identifies the charge, like a billing code.", "isModifier": false, "short": "A code that identifies the charge, like a billing code", "mapping": [ { "map": "Event.code", "identity": "workflow" }, { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "FT1.7", "identity": "v2" }, { "map": ".code", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Example set of codes that can be used for billing purposes." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemCode" } ], "description": "Example codes for billing purposes" }, "alias": [ "type" ], "max": "1", "id": "ChargeItem.code", "base": { "max": "1", "min": 1, "path": "ChargeItem.code" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.subject", "requirements": "Links the event to the Patient context.", "min": 1, "definition": "The individual or set of individuals the action is being or was performed on.", "isModifier": false, "short": "Individual service was done for/to", "mapping": [ { "map": "Event.subject", "identity": "workflow" }, { "map": "FiveWs.subject[x]", "identity": "w5" }, { "map": "PAT in proximity to FT1 segment", "identity": "v2" }, { "map": ".participation[typeCode=SBJ].role", "identity": "rim" }, { "map": "FiveWs.subject", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "mustSupport": false, "alias": [ "patient" ], "max": "1", "id": "ChargeItem.subject", "base": { "max": "1", "min": 1, "path": "ChargeItem.subject" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.context", "requirements": "Links the request to the Encounter context.", "min": 0, "definition": "The encounter or episode of care that establishes the context for this event.", "isModifier": false, "short": "Encounter / Episode associated with event", "mapping": [ { "map": "Event.context", "identity": "workflow" }, { "map": "FiveWs.context", "identity": "w5" }, { "map": "PV1 in proximity to FT1 segment", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ], "mustSupport": false, "alias": [ "encounter" ], "max": "1", "id": "ChargeItem.context", "base": { "max": "1", "min": 0, "path": "ChargeItem.context" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.occurrence[x]", "min": 0, "definition": "Date/time(s) or duration when the charged service was applied.", "isModifier": false, "short": "When the charged service was applied", "mapping": [ { "map": "Event.occurrence[x]", "identity": "workflow" }, { "map": "FiveWs.done[x]", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "mustSupport": false, "alias": [ "timing" ], "max": "1", "id": "ChargeItem.occurrence[x]", "comment": "The list of types may be constrained as appropriate for the type of charge item.", "base": { "max": "1", "min": 0, "path": "ChargeItem.occurrence[x]" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.performer", "min": 0, "definition": "Indicates who or what performed or participated in the charged service.", "isModifier": false, "short": "Who performed charged service", "mapping": [ { "map": "Event.performer", "identity": "workflow" }, { "map": "EVN.5 or by domain", "identity": "v2" }, { "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.performer", "base": { "max": "*", "min": 0, "path": "ChargeItem.performer" }, "isSummary": false }, { "path": "ChargeItem.performer.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri": "id" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "ChargeItem.performer.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "ChargeItem.performer.extension", "min": 0, "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.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "ChargeItem.performer.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.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "ChargeItem.performer.modifierExtension", "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).", "min": 0, "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).", "isModifier": true, "short": "Extensions that cannot be ignored even if unrecognized", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "ChargeItem.performer.modifierExtension", "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.performer.function", "min": 0, "definition": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).", "isModifier": false, "short": "What type of performance was done", "mapping": [ { "map": "Event.performer.function", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".participation.functionCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/performer-role", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemPerformerFunction" } ], "description": "Codes describing the types of functional roles performers can take on when performing events." }, "max": "1", "id": "ChargeItem.performer.function", "base": { "max": "1", "min": 0, "path": "ChargeItem.performer.function" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.performer.actor", "min": 1, "definition": "The device, practitioner, etc. who performed or participated in the service.", "isModifier": false, "short": "Individual who was performing", "mapping": [ { "map": "Event.performer.actor", "identity": "workflow" }, { "map": "FiveWs.actor", "identity": "w5" }, { "map": "EVN.5 or by domain", "identity": "v2" }, { "map": ".player", "identity": "rim" } ], "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" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.performer.actor", "base": { "max": "1", "min": 1, "path": "ChargeItem.performer.actor" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.performingOrganization", "min": 0, "definition": "The organization requesting the service.", "isModifier": false, "short": "Organization providing the charged service", "mapping": [ { "map": "Event.performer.actor", "identity": "workflow" }, { "map": "N/A", "identity": "v2" }, { "map": ".scoper", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.performingOrganization", "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.", "base": { "max": "1", "min": 0, "path": "ChargeItem.performingOrganization" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.requestingOrganization", "min": 0, "definition": "The organization performing the service.", "isModifier": false, "short": "Organization requesting the charged service", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": ".scoper", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.requestingOrganization", "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).", "base": { "max": "1", "min": 0, "path": "ChargeItem.requestingOrganization" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.costCenter", "min": 0, "definition": "The financial cost center permits the tracking of charge attribution.", "isModifier": false, "short": "Organization that has ownership of the (potential, future) revenue", "mapping": [ { "map": "FT1.13", "identity": "v2" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.costCenter", "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.", "base": { "max": "1", "min": 0, "path": "ChargeItem.costCenter" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.quantity", "min": 0, "definition": "Quantity of which the charge item has been serviced.", "isModifier": false, "short": "Quantity of which the charge item has been serviced", "mapping": [ { "map": "FT1.10", "identity": "v2" } ], "type": [ { "code": "Quantity" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.quantity", "comment": "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.", "base": { "max": "1", "min": 0, "path": "ChargeItem.quantity" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.bodysite", "min": 0, "definition": "The anatomical location where the related service has been applied.", "isModifier": false, "short": "Anatomical location, if relevant", "mapping": [ { "map": ".targetBodySiteCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-site", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Codes describing anatomical locations. May include laterality." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "description": "SNOMED CT Body site concepts" }, "max": "*", "id": "ChargeItem.bodysite", "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.", "base": { "max": "*", "min": 0, "path": "ChargeItem.bodysite" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.factorOverride", "min": 0, "definition": "Factor overriding the factor determined by the rules associated with the code.", "isModifier": false, "short": "Factor overriding the associated rules", "mapping": [ { "map": "FT1.26", "identity": "v2" } ], "type": [ { "code": "decimal" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.factorOverride", "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.", "base": { "max": "1", "min": 0, "path": "ChargeItem.factorOverride" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.priceOverride", "min": 0, "definition": "Total price of the charge overriding the list price associated with the code.", "isModifier": false, "short": "Price overriding the associated rules", "mapping": [ { "map": "FT1.22", "identity": "v2" } ], "type": [ { "code": "Money" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.priceOverride", "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.", "base": { "max": "1", "min": 0, "path": "ChargeItem.priceOverride" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.overrideReason", "min": 0, "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.", "isModifier": false, "short": "Reason for overriding the list price/factor", "type": [ { "code": "string" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.overrideReason", "comment": "Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.", "base": { "max": "1", "min": 0, "path": "ChargeItem.overrideReason" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.enterer", "min": 0, "definition": "The device, practitioner, etc. who entered the charge item.", "isModifier": false, "short": "Individual who was entering", "mapping": [ { "map": "FiveWs.actor", "identity": "w5" }, { "map": "EVN.5 or by domain", "identity": "v2" }, { "map": ".player", "identity": "rim" } ], "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" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.enterer", "comment": "The enterer is also the person considered responsible for factor/price overrides if applicable.", "base": { "max": "1", "min": 0, "path": "ChargeItem.enterer" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.enteredDate", "min": 0, "definition": "Date the charge item was entered.", "isModifier": false, "short": "Date the charge item was entered", "type": [ { "code": "dateTime" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.enteredDate", "comment": "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].", "base": { "max": "1", "min": 0, "path": "ChargeItem.enteredDate" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.reason", "min": 0, "definition": "Describes why the event occurred in coded or textual form.", "isModifier": false, "short": "Why was the charged service rendered?", "mapping": [ { "map": "Event.reasonCode", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": "EVN.4 or by domain", "identity": "v2" }, { "map": ".reasonCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/icd-10", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Example binding for reason." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemReason" } ], "description": "ICD 10 diagnosis codes" }, "max": "*", "id": "ChargeItem.reason", "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.", "base": { "max": "*", "min": 0, "path": "ChargeItem.reason" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.service", "min": 0, "definition": "Indicated the rendered service that caused this charge.", "isModifier": false, "short": "Which rendered service is being charged?", "mapping": [ { "map": "Event.reasonReference", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": "EVN.4 or by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=RSON].target", "identity": "rim" } ], "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" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.service", "base": { "max": "*", "min": 0, "path": "ChargeItem.service" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.product[x]", "min": 0, "definition": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.", "isModifier": false, "short": "Product charged", "mapping": [ { "map": ".participation[typeCode=CSM].role", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Substance" ] }, { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/device-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemProduct" } ], "description": "Example binding for product type." }, "max": "1", "id": "ChargeItem.product[x]", "base": { "max": "1", "min": 0, "path": "ChargeItem.product[x]" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.account", "min": 0, "definition": "Account into which this ChargeItems belongs.", "isModifier": false, "short": "Account to place this charge", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Account" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.account", "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.", "base": { "max": "*", "min": 0, "path": "ChargeItem.account" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.note", "min": 0, "definition": "Comments made about the event by the performer, subject or other participants.", "isModifier": false, "short": "Comments made about the ChargeItem", "mapping": [ { "map": "Event.note", "identity": "workflow" }, { "map": "NTE", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]", "identity": "rim" } ], "type": [ { "code": "Annotation" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.note", "base": { "max": "*", "min": 0, "path": "ChargeItem.note" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ChargeItem.supportingInformation", "min": 0, "definition": "Further information supporting this charge.", "isModifier": false, "short": "Further information supporting this charge", "mapping": [ { "map": "Event.supportingInfo", "identity": "workflow" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.supportingInformation", "base": { "max": "*", "min": 0, "path": "ChargeItem.supportingInformation" }, "isSummary": false } ] }, "status": "draft", "id": "e381923b-b595-418f-987f-472836f1cc5d", "kind": "resource", "url": "http://hl7.org/fhir/StructureDefinition/ChargeItem", "version": "4.6.0", "differential": { "element": [ { "path": "ChargeItem", "min": 0, "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.", "isModifier": false, "short": "Item containing charge code(s) associated with the provision of healthcare provider products", "mapping": [ { "map": "Event", "identity": "workflow" }, { "map": "FT1", "identity": "v2" }, { "map": "Act[moodCode=EVN]", "identity": "rim" }, { "map": "financial.support", "identity": "w5" } ], "mustSupport": false, "max": "*", "id": "ChargeItem" }, { "path": "ChargeItem.identifier", "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, "definition": "Identifiers assigned to this event performer or other systems.", "isModifier": false, "short": "Business Identifier for item", "mapping": [ { "map": "Event.identifier", "identity": "workflow" }, { "map": "FiveWs.identifier", "identity": "w5" }, { "map": "FT1.2", "identity": "v2" }, { "map": ".identifier", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.identifier", "isSummary": true }, { "path": "ChargeItem.definitionUri", "min": 0, "definition": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.", "isModifier": false, "short": "Defining information about the code of this charge item", "mapping": [ { "map": "Event.instantiates", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "type": [ { "code": "uri" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.definitionUri", "isSummary": false }, { "path": "ChargeItem.definitionCanonical", "min": 0, "definition": "References the source of pricing information, rules of application for the code this ChargeItem uses.", "isModifier": false, "short": "Resource defining the code of this ChargeItem", "mapping": [ { "map": "Event.instantiates", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.definitionCanonical", "isSummary": false }, { "path": "ChargeItem.status", "min": 1, "definition": "The current state of the ChargeItem.", "isModifier": true, "short": "planned | billable | not-billable | aborted | billed | entered-in-error | unknown", "mapping": [ { "map": "Event.status", "identity": "workflow" }, { "map": "FiveWs.status", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".status", "identity": "rim" } ], "type": [ { "code": "code" } ], "mustSupport": false, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-status|4.6.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemStatus" } ], "description": "Codes identifying the lifecycle stage of a ChargeItem." }, "max": "1", "id": "ChargeItem.status", "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.", "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 }, { "path": "ChargeItem.partOf", "requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.", "min": 0, "definition": "ChargeItems can be grouped to larger ChargeItems covering the whole set.", "isModifier": false, "short": "Part of referenced ChargeItem", "mapping": [ { "map": "Event.partOf", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ChargeItem" ] } ], "mustSupport": false, "alias": [ "container" ], "max": "*", "id": "ChargeItem.partOf", "isSummary": false }, { "path": "ChargeItem.code", "min": 1, "definition": "A code that identifies the charge, like a billing code.", "isModifier": false, "short": "A code that identifies the charge, like a billing code", "mapping": [ { "map": "Event.code", "identity": "workflow" }, { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "FT1.7", "identity": "v2" }, { "map": ".code", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Example set of codes that can be used for billing purposes." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemCode" } ], "description": "Example codes for billing purposes" }, "alias": [ "type" ], "max": "1", "id": "ChargeItem.code", "isSummary": true }, { "path": "ChargeItem.subject", "requirements": "Links the event to the Patient context.", "min": 1, "definition": "The individual or set of individuals the action is being or was performed on.", "isModifier": false, "short": "Individual service was done for/to", "mapping": [ { "map": "Event.subject", "identity": "workflow" }, { "map": "FiveWs.subject[x]", "identity": "w5" }, { "map": "PAT in proximity to FT1 segment", "identity": "v2" }, { "map": ".participation[typeCode=SBJ].role", "identity": "rim" }, { "map": "FiveWs.subject", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "mustSupport": false, "alias": [ "patient" ], "max": "1", "id": "ChargeItem.subject", "isSummary": true }, { "path": "ChargeItem.context", "requirements": "Links the request to the Encounter context.", "min": 0, "definition": "The encounter or episode of care that establishes the context for this event.", "isModifier": false, "short": "Encounter / Episode associated with event", "mapping": [ { "map": "Event.context", "identity": "workflow" }, { "map": "FiveWs.context", "identity": "w5" }, { "map": "PV1 in proximity to FT1 segment", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ], "mustSupport": false, "alias": [ "encounter" ], "max": "1", "id": "ChargeItem.context", "isSummary": true }, { "path": "ChargeItem.occurrence[x]", "min": 0, "definition": "Date/time(s) or duration when the charged service was applied.", "isModifier": false, "short": "When the charged service was applied", "mapping": [ { "map": "Event.occurrence[x]", "identity": "workflow" }, { "map": "FiveWs.done[x]", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "mustSupport": false, "alias": [ "timing" ], "max": "1", "id": "ChargeItem.occurrence[x]", "comment": "The list of types may be constrained as appropriate for the type of charge item.", "isSummary": true }, { "path": "ChargeItem.performer", "min": 0, "definition": "Indicates who or what performed or participated in the charged service.", "isModifier": false, "short": "Who performed charged service", "mapping": [ { "map": "Event.performer", "identity": "workflow" }, { "map": "EVN.5 or by domain", "identity": "v2" }, { "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.performer", "isSummary": false }, { "path": "ChargeItem.performer.function", "min": 0, "definition": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).", "isModifier": false, "short": "What type of performance was done", "mapping": [ { "map": "Event.performer.function", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".participation.functionCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/performer-role", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemPerformerFunction" } ], "description": "Codes describing the types of functional roles performers can take on when performing events." }, "max": "1", "id": "ChargeItem.performer.function", "isSummary": false }, { "path": "ChargeItem.performer.actor", "min": 1, "definition": "The device, practitioner, etc. who performed or participated in the service.", "isModifier": false, "short": "Individual who was performing", "mapping": [ { "map": "Event.performer.actor", "identity": "workflow" }, { "map": "FiveWs.actor", "identity": "w5" }, { "map": "EVN.5 or by domain", "identity": "v2" }, { "map": ".player", "identity": "rim" } ], "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" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.performer.actor", "isSummary": false }, { "path": "ChargeItem.performingOrganization", "min": 0, "definition": "The organization requesting the service.", "isModifier": false, "short": "Organization providing the charged service", "mapping": [ { "map": "Event.performer.actor", "identity": "workflow" }, { "map": "N/A", "identity": "v2" }, { "map": ".scoper", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.performingOrganization", "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.", "isSummary": false }, { "path": "ChargeItem.requestingOrganization", "min": 0, "definition": "The organization performing the service.", "isModifier": false, "short": "Organization requesting the charged service", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": ".scoper", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.requestingOrganization", "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).", "isSummary": false }, { "path": "ChargeItem.costCenter", "min": 0, "definition": "The financial cost center permits the tracking of charge attribution.", "isModifier": false, "short": "Organization that has ownership of the (potential, future) revenue", "mapping": [ { "map": "FT1.13", "identity": "v2" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.costCenter", "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.", "isSummary": false }, { "path": "ChargeItem.quantity", "min": 0, "definition": "Quantity of which the charge item has been serviced.", "isModifier": false, "short": "Quantity of which the charge item has been serviced", "mapping": [ { "map": "FT1.10", "identity": "v2" } ], "type": [ { "code": "Quantity" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.quantity", "comment": "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.", "isSummary": true }, { "path": "ChargeItem.bodysite", "min": 0, "definition": "The anatomical location where the related service has been applied.", "isModifier": false, "short": "Anatomical location, if relevant", "mapping": [ { "map": ".targetBodySiteCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-site", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Codes describing anatomical locations. May include laterality." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "description": "SNOMED CT Body site concepts" }, "max": "*", "id": "ChargeItem.bodysite", "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.", "isSummary": true }, { "path": "ChargeItem.factorOverride", "min": 0, "definition": "Factor overriding the factor determined by the rules associated with the code.", "isModifier": false, "short": "Factor overriding the associated rules", "mapping": [ { "map": "FT1.26", "identity": "v2" } ], "type": [ { "code": "decimal" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.factorOverride", "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.", "isSummary": false }, { "path": "ChargeItem.priceOverride", "min": 0, "definition": "Total price of the charge overriding the list price associated with the code.", "isModifier": false, "short": "Price overriding the associated rules", "mapping": [ { "map": "FT1.22", "identity": "v2" } ], "type": [ { "code": "Money" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.priceOverride", "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.", "isSummary": false }, { "path": "ChargeItem.overrideReason", "min": 0, "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.", "isModifier": false, "short": "Reason for overriding the list price/factor", "type": [ { "code": "string" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.overrideReason", "comment": "Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.", "isSummary": false }, { "path": "ChargeItem.enterer", "min": 0, "definition": "The device, practitioner, etc. who entered the charge item.", "isModifier": false, "short": "Individual who was entering", "mapping": [ { "map": "FiveWs.actor", "identity": "w5" }, { "map": "EVN.5 or by domain", "identity": "v2" }, { "map": ".player", "identity": "rim" } ], "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" ] } ], "mustSupport": false, "max": "1", "id": "ChargeItem.enterer", "comment": "The enterer is also the person considered responsible for factor/price overrides if applicable.", "isSummary": true }, { "path": "ChargeItem.enteredDate", "min": 0, "definition": "Date the charge item was entered.", "isModifier": false, "short": "Date the charge item was entered", "type": [ { "code": "dateTime" } ], "mustSupport": false, "max": "1", "id": "ChargeItem.enteredDate", "comment": "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].", "isSummary": true }, { "path": "ChargeItem.reason", "min": 0, "definition": "Describes why the event occurred in coded or textual form.", "isModifier": false, "short": "Why was the charged service rendered?", "mapping": [ { "map": "Event.reasonCode", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": "EVN.4 or by domain", "identity": "v2" }, { "map": ".reasonCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/icd-10", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Example binding for reason." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemReason" } ], "description": "ICD 10 diagnosis codes" }, "max": "*", "id": "ChargeItem.reason", "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.", "isSummary": false }, { "path": "ChargeItem.service", "min": 0, "definition": "Indicated the rendered service that caused this charge.", "isModifier": false, "short": "Which rendered service is being charged?", "mapping": [ { "map": "Event.reasonReference", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": "EVN.4 or by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=RSON].target", "identity": "rim" } ], "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" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.service", "isSummary": false }, { "path": "ChargeItem.product[x]", "min": 0, "definition": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.", "isModifier": false, "short": "Product charged", "mapping": [ { "map": ".participation[typeCode=CSM].role", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Substance" ] }, { "code": "CodeableConcept" } ], "mustSupport": false, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/device-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ChargeItemProduct" } ], "description": "Example binding for product type." }, "max": "1", "id": "ChargeItem.product[x]", "isSummary": false }, { "path": "ChargeItem.account", "min": 0, "definition": "Account into which this ChargeItems belongs.", "isModifier": false, "short": "Account to place this charge", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Account" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.account", "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.", "isSummary": true }, { "path": "ChargeItem.note", "min": 0, "definition": "Comments made about the event by the performer, subject or other participants.", "isModifier": false, "short": "Comments made about the ChargeItem", "mapping": [ { "map": "Event.note", "identity": "workflow" }, { "map": "NTE", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]", "identity": "rim" } ], "type": [ { "code": "Annotation" } ], "mustSupport": false, "max": "*", "id": "ChargeItem.note", "isSummary": false }, { "path": "ChargeItem.supportingInformation", "min": 0, "definition": "Further information supporting this charge.", "isModifier": false, "short": "Further information supporting this charge", "mapping": [ { "map": "Event.supportingInfo", "identity": "workflow" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "mustSupport": false, "max": "*", "id": "ChargeItem.supportingInformation", "isSummary": false } ] }, "contact": [ { "telecom": [ { "value": "http://hl7.org/fhir", "system": "url" } ] }, { "telecom": [ { "value": "http://www.hl7.org/Special/committees/pafm/index.cfm", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource" }