Guia de Implementação do AnHealth
0.2.0 - CI Build
Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
| Draft as of 2021-12-02 |
Definitions for the ChargeItem resource profile.
| 1. ChargeItem | |
| 2. ChargeItem.definitionCanonical | |
| Control | 0..1* |
| 3. ChargeItem.subject | |
| Type | Reference(Patient|Group)) |
| 4. ChargeItem.context | |
| Control | 10..1 |
| Type | Reference(Encounter|EpisodeOfCare)) |
| 5. ChargeItem.occurrence[x] | |
| Control | 10..1 |
| Type | Choice of: , dateTime, Timing |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 6. ChargeItem.occurrence[x].start | |
| Control | 1..? |
| 7. ChargeItem.quantity | |
| Control | 10..1 |
| 8. ChargeItem.priceOverride | |
| Control | 10..1 |
| 9. ChargeItem.enterer | |
| Control | 10..1 |
| 10. ChargeItem.enteredDate | |
| Control | 10..1 |
| 11. ChargeItem.service | |
| Control | 10..1* |
| Type | Reference(Procedure|DiagnosticReport|ImagingStudy|Immunization|MedicationAdministration|MedicationDispense|Observation|SupplyDelivery)) |
| 12. ChargeItem.product[x] | |
| Type | Choice of: (Device|Medication|DeviceDefinition|HealthcareService|Substance)), CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 13. ChargeItem.account | |
| Control | 10..1* |
| 1. ChargeItem | |
| 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. |
| Control | 0..* |
| Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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 (: contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
| 2. ChargeItem.implicitRules | |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 3. ChargeItem.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true |
| 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. |
| Alternate Names | extensions, user content |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 4. ChargeItem.definitionCanonical | |
| Definition | References the source of pricing information, rules of application for the code this ChargeItem uses. |
| Control | 0..1* |
| Type | canonical(ChargeItemDefinition)) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 5. ChargeItem.status | |
| Definition | The current state of the ChargeItem. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ChargeItemStatus Codes identifying the lifecycle stage of a ChargeItem. |
| Type | code |
| Is Modifier | true |
| Comments | 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. This element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. ChargeItem.code | |
| Definition | A code that identifies the charge, like a billing code. |
| Control | 1..1 |
| Binding | For example codes, see ChargeItemCode Example codes for billing purposes |
| Type | CodeableConcept |
| Alternate Names | type |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. ChargeItem.subject | |
| Definition | The individual or set of individuals the action is being or was performed on. |
| Control | 1..1 |
| Type | Reference(Patient|Group)) |
| Requirements | Links the event to the Patient context. |
| Alternate Names | patient |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. ChargeItem.context | |
| Definition | The encounter or episode of care that establishes the context for this event. |
| Control | 10..1 |
| Type | Reference(Encounter|EpisodeOfCare)) |
| Requirements | Links the request to the Encounter context. |
| Alternate Names | encounter |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. ChargeItem.occurrence[x] | |
| Definition | Date/time(s) or duration when the charged service was applied. |
| Control | 10..1 |
| Type | Choice of: Period, dateTime, Timing |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | timing |
| Comments | The list of types may be constrained as appropriate for the type of charge item. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. ChargeItem.occurrence[x].start | |
| Definition | The start of the period. The boundary is inclusive. |
| Control | 10..1 This element is affected by the following invariants: per-1 |
| Type | dateTime |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. ChargeItem.quantity | |
| Definition | Quantity of which the charge item has been serviced. |
| Control | 10..1 |
| Type | Quantity |
| Comments | In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. ChargeItem.priceOverride | |
| Definition | Total price of the charge overriding the list price associated with the code. |
| Control | 10..1 |
| Type | Money |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 13. ChargeItem.enterer | |
| Definition | The device, practitioner, etc. who entered the charge item. |
| Control | 10..1 |
| Type | Reference(Practitioner|PractitionerRole|Organization|Patient|Device|RelatedPerson)) |
| Comments | The enterer is also the person considered responsible for factor/price overrides if applicable. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. ChargeItem.enteredDate | |
| Definition | Date the charge item was entered. |
| Control | 10..1 |
| Type | dateTime |
| Comments | The actual date when the service associated with the charge has been rendered is captured in occurrence[x]. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 15. ChargeItem.service | |
| Definition | Indicated the rendered service that caused this charge. |
| Control | 10..1* |
| Type | Reference(Procedure|DiagnosticReport|ImagingStudy|Immunization|MedicationAdministration|MedicationDispense|Observation|SupplyDelivery)) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 16. ChargeItem.product[x] | |
| Definition | Identifies the device, food, drug or other product being charged either by type code or reference to an instance. |
| Control | 0..1 |
| Type | Choice of: Reference(Device|Medication|DeviceDefinition|HealthcareService|Substance)), CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 17. ChargeItem.account | |
| Definition | Account into which this ChargeItems belongs. |
| Control | 10..1* |
| Type | Reference(Account)) |
| Comments | 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 1. ChargeItem | |||||
| 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. | ||||
| Control | 0..* | ||||
| 2. ChargeItem.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| 3. ChargeItem.meta | |||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 4. ChargeItem.implicitRules | |||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 5. ChargeItem.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages
IETF language ta
| ||||
| Type | code | ||||
| Comments | 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). | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 6. ChargeItem.text | |||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrativehtmlxhtmldisplay | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 7. ChargeItem.contained | |||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resourcesanonymous resourcescontained resources | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)) | ||||
| 8. ChargeItem.extension | |||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 9. ChargeItem.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true | ||||
| 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. | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 10. ChargeItem.identifier | |||||
| Definition | Identifiers assigned to this event performer or other systems. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 11. ChargeItem.definitionUri | |||||
| Definition | References the (external) source of pricing information, rules of application for the code this ChargeItem uses. | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 12. ChargeItem.definitionCanonical | |||||
| Definition | References the source of pricing information, rules of application for the code this ChargeItem uses. | ||||
| Control | 0..1 | ||||
| Type | canonical(ChargeItemDefinition)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 13. ChargeItem.status | |||||
| Definition | The current state of the ChargeItem. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ChargeItemStatus Codes identifying the lifecycle stage of a ChargeItem | ||||
| Type | code | ||||
| Is Modifier | true | ||||
| Comments | 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. This element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 14. ChargeItem.partOf | |||||
| Definition | ChargeItems can be grouped to larger ChargeItems covering the whole set. | ||||
| Control | 0..* | ||||
| Type | Reference(ChargeItem)) | ||||
| Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. | ||||
| Alternate Names | container | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 15. ChargeItem.code | |||||
| Definition | A code that identifies the charge, like a billing code. | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see ChargeItemCode Example codes for billing purpose | ||||
| Type | CodeableConcept | ||||
| Alternate Names | type | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 16. ChargeItem.subject | |||||
| Definition | The individual or set of individuals the action is being or was performed on. | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient)) | ||||
| Requirements | Links the event to the Patient context. | ||||
| Alternate Names | patient | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 17. ChargeItem.context | |||||
| Definition | The encounter or episode of care that establishes the context for this event. | ||||
| Control | 1..1 | ||||
| Type | Reference(Encounter)) | ||||
| Requirements | Links the request to the Encounter context. | ||||
| Alternate Names | encounter | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 18. ChargeItem.occurrence[x] | |||||
| Definition | Date/time(s) or duration when the charged service was applied. | ||||
| Control | 1..1 | ||||
| Type | Period | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Alternate Names | timing | ||||
| Comments | The list of types may be constrained as appropriate for the type of charge item. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 19. ChargeItem.occurrence[x].id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 20. ChargeItem.occurrence[x].extension | |||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ChargeItem.occurrence[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
| 21. ChargeItem.occurrence[x].start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Control | 1..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 22. ChargeItem.occurrence[x].end | |||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 23. ChargeItem.performer | |||||
| Definition | Indicates who or what performed or participated in the charged service. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 24. ChargeItem.performer.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 25. ChargeItem.performer.extension | |||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 26. ChargeItem.performer.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true | ||||
| 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. | ||||
| Alternate Names | extensionsuser contentmodifiers | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 27. ChargeItem.performer.function | |||||
| Definition | Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.). | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ProcedurePerformerRoleCodes Codes describing the types of functional roles performers can take on when performing events | ||||
| Type | CodeableConcept | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 28. ChargeItem.performer.actor | |||||
| Definition | The device, practitioner, etc. who performed or participated in the service. | ||||
| Control | 1..1 | ||||
| Type | Reference(PractitionerPractitionerRoleOrganizationCareTeamPatientDeviceRelatedPerson)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 29. ChargeItem.performingOrganization | |||||
| Definition | The organization requesting the service. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization)) | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 30. ChargeItem.requestingOrganization | |||||
| Definition | The organization performing the service. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization)) | ||||
| Comments | 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). | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 31. ChargeItem.costCenter | |||||
| Definition | The financial cost center permits the tracking of charge attribution. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization)) | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 32. ChargeItem.quantity | |||||
| Definition | Quantity of which the charge item has been serviced. | ||||
| Control | 1..1 | ||||
| Type | Quantity | ||||
| Comments | In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 33. ChargeItem.bodysite | |||||
| Definition | The anatomical location where the related service has been applied. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see SNOMEDCTBodyStructures SNOMED CT Body site concept | ||||
| Type | CodeableConcept | ||||
| Comments | 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. May be a summary code, or a reference to a very precise definition of the location, or both. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 34. ChargeItem.factorOverride | |||||
| Definition | Factor overriding the factor determined by the rules associated with the code. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 35. ChargeItem.priceOverride | |||||
| Definition | Total price of the charge overriding the list price associated with the code. | ||||
| Control | 1..1 | ||||
| Type | Money | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 36. ChargeItem.overrideReason | |||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Comments | Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 37. ChargeItem.enterer | |||||
| Definition | The device, practitioner, etc. who entered the charge item. | ||||
| Control | 1..1 | ||||
| Type | Reference(PractitionerPractitionerRoleOrganizationPatientDeviceRelatedPerson)) | ||||
| Comments | The enterer is also the person considered responsible for factor/price overrides if applicable. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 38. ChargeItem.enteredDate | |||||
| Definition | Date the charge item was entered. | ||||
| Control | 1..1 | ||||
| Type | dateTime | ||||
| Comments | The actual date when the service associated with the charge has been rendered is captured in occurrence[x]. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 39. ChargeItem.reason | |||||
| Definition | Describes why the event occurred in coded or textual form. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ICD-10Codes ICD 10 diagnosis code | ||||
| Type | CodeableConcept | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 40. ChargeItem.service | |||||
| Definition | Indicated the rendered service that caused this charge. | ||||
| Control | 1..1 | ||||
| Type | Reference(Procedure)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 41. ChargeItem.product[x] | |||||
| Definition | Identifies the device, food, drug or other product being charged either by type code or reference to an instance. | ||||
| Control | 0..1 | ||||
| Type | Reference(DeviceMedicationDeviceDefinitionHealthcareService)) | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 42. ChargeItem.account | |||||
| Definition | Account into which this ChargeItems belongs. | ||||
| Control | 1..1 | ||||
| Type | Reference(Account)) | ||||
| Comments | 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 43. ChargeItem.note | |||||
| Definition | Comments made about the event by the performer, subject or other participants. | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 44. ChargeItem.supportingInformation | |||||
| Definition | Further information supporting this charge. | ||||
| Control | 0..* | ||||
| Type | Reference(Resource)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||