Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: ChargeItem
| Official URL: https://ancode.app/fhir/StructureDefinition/ChargeItem | Version: 0.2.0 | |||
| Draft as of 2021-12-02 | Computable Name: ChargeItem | |||
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChargeItem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
  definitionCanonical | 0..1 | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |
 subject | 1..1 | Reference(Patient) | Individual service was done for/to | |
| context | 1..1 | Reference(Encounter) | Encounter / Episode associated with event | |
  occurrence[x] | 1..1 | Period | When the charged service was applied | |
  start | 1..1 | dateTime | Starting time with inclusive boundary | |
| quantity | 1..1 | Quantity | Quantity of which the charge item has been serviced | |
| priceOverride | 1..1 | Money | Price overriding the associated rules | |
| enterer | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering | |
| enteredDate | 1..1 | dateTime | Date the charge item was entered | |
| service | 1..1 | Reference(Procedure) | Which rendered service is being charged? | |
| product[x] | 0..1 | Reference(Device | Medication | DeviceDefinition | HealthcareService) | Product charged Binding: (unbound) (example) | |
| account | 1..1 | Reference(Account) | Account to place this charge | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| ChargeItem.product[x] | example | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| definitionCanonical | 0..1 | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. |
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example codes for billing purposes |
| subject | Σ | 1..1 | Reference(Patient) | Individual service was done for/to |
| context | Σ | 1..1 | Reference(Encounter) | Encounter / Episode associated with event |
| occurrence[x] | Σ | 1..1 | Period | When the charged service was applied |
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary |
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced |
| priceOverride | 1..1 | Money | Price overriding the associated rules | |
| enterer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering |
| enteredDate | Σ | 1..1 | dateTime | Date the charge item was entered |
| service | 1..1 | Reference(Procedure) | Which rendered service is being charged? | |
| product[x] | 0..1 | Reference(Device | Medication | DeviceDefinition | HealthcareService) | Product charged | |
| account | Σ | 1..1 | Reference(Account) | Account to place this charge |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| ChargeItem.status | required | ChargeItemStatus |
| ChargeItem.code | example | ChargeItemCode |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ChargeItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ChargeItem | 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 | error | ChargeItem | 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 | error | ChargeItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ChargeItem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for item | ||||
| definitionUri | 0..* | uri | Defining information about the code of this charge item | |||||
| definitionCanonical | 0..1 | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |||||
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. | ||||
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |||||
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example codes for billing purposes | ||||
| subject | Σ | 1..1 | Reference(Patient) | Individual service was done for/to | ||||
| context | Σ | 1..1 | Reference(Encounter) | Encounter / Episode associated with event | ||||
| occurrence[x] | Σ | 1..1 | Period | When the charged service was applied | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| performer | 0..* | BackboneElement | Who performed charged service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events. | |||||
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Individual who was performing | |||||
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |||||
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |||||
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |||||
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced | ||||
| bodysite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| factorOverride | 0..1 | decimal | Factor overriding the associated rules | |||||
| priceOverride | 1..1 | Money | Price overriding the associated rules | |||||
| overrideReason | 0..1 | string | Reason for overriding the list price/factor | |||||
| enterer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering | ||||
| enteredDate | Σ | 1..1 | dateTime | Date the charge item was entered | ||||
| reason | 0..* | CodeableConcept | Why was the charged service rendered? Binding: ICD-10Codes (example): ICD 10 diagnosis codes | |||||
| service | 1..1 | Reference(Procedure) | Which rendered service is being charged? | |||||
| product[x] | 0..1 | Reference(Device | Medication | DeviceDefinition | HealthcareService) | Product charged | |||||
| account | Σ | 1..1 | Reference(Account) | Account to place this charge | ||||
| note | 0..* | Annotation | Comments made about the ChargeItem | |||||
| supportingInformation | 0..* | Reference(Resource) | Further information supporting this charge | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| ChargeItem.language | preferred | CommonLanguages
| ||||
| ChargeItem.status | required | ChargeItemStatus | ||||
| ChargeItem.code | example | ChargeItemCode | ||||
| ChargeItem.performer.function | example | ProcedurePerformerRoleCodes | ||||
| ChargeItem.bodysite | example | SNOMEDCTBodyStructures | ||||
| ChargeItem.reason | example | ICD-10Codes |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | ChargeItem.contained | 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) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ChargeItem
Differential View
This structure is derived from ChargeItem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
| definitionCanonical | 0..1 | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |
| subject | 1..1 | Reference(Patient) | Individual service was done for/to | |
| context | 1..1 | Reference(Encounter) | Encounter / Episode associated with event | |
| occurrence[x] | 1..1 | Period | When the charged service was applied | |
| start | 1..1 | dateTime | Starting time with inclusive boundary | |
| quantity | 1..1 | Quantity | Quantity of which the charge item has been serviced | |
| priceOverride | 1..1 | Money | Price overriding the associated rules | |
| enterer | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering | |
| enteredDate | 1..1 | dateTime | Date the charge item was entered | |
| service | 1..1 | Reference(Procedure) | Which rendered service is being charged? | |
| product[x] | 0..1 | Reference(Device | Medication | DeviceDefinition | HealthcareService) | Product charged Binding: (unbound) (example) | |
| account | 1..1 | Reference(Account) | Account to place this charge | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| ChargeItem.product[x] | example | |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| definitionCanonical | 0..1 | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. |
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example codes for billing purposes |
| subject | Σ | 1..1 | Reference(Patient) | Individual service was done for/to |
| context | Σ | 1..1 | Reference(Encounter) | Encounter / Episode associated with event |
| occurrence[x] | Σ | 1..1 | Period | When the charged service was applied |
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary |
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced |
| priceOverride | 1..1 | Money | Price overriding the associated rules | |
| enterer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering |
| enteredDate | Σ | 1..1 | dateTime | Date the charge item was entered |
| service | 1..1 | Reference(Procedure) | Which rendered service is being charged? | |
| product[x] | 0..1 | Reference(Device | Medication | DeviceDefinition | HealthcareService) | Product charged | |
| account | Σ | 1..1 | Reference(Account) | Account to place this charge |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| ChargeItem.status | required | ChargeItemStatus |
| ChargeItem.code | example | ChargeItemCode |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ChargeItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ChargeItem | 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 | error | ChargeItem | 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 | error | ChargeItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ChargeItem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for item | ||||
| definitionUri | 0..* | uri | Defining information about the code of this charge item | |||||
| definitionCanonical | 0..1 | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |||||
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. | ||||
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |||||
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example codes for billing purposes | ||||
| subject | Σ | 1..1 | Reference(Patient) | Individual service was done for/to | ||||
| context | Σ | 1..1 | Reference(Encounter) | Encounter / Episode associated with event | ||||
| occurrence[x] | Σ | 1..1 | Period | When the charged service was applied | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| performer | 0..* | BackboneElement | Who performed charged service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events. | |||||
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Individual who was performing | |||||
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |||||
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |||||
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |||||
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced | ||||
| bodysite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| factorOverride | 0..1 | decimal | Factor overriding the associated rules | |||||
| priceOverride | 1..1 | Money | Price overriding the associated rules | |||||
| overrideReason | 0..1 | string | Reason for overriding the list price/factor | |||||
| enterer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering | ||||
| enteredDate | Σ | 1..1 | dateTime | Date the charge item was entered | ||||
| reason | 0..* | CodeableConcept | Why was the charged service rendered? Binding: ICD-10Codes (example): ICD 10 diagnosis codes | |||||
| service | 1..1 | Reference(Procedure) | Which rendered service is being charged? | |||||
| product[x] | 0..1 | Reference(Device | Medication | DeviceDefinition | HealthcareService) | Product charged | |||||
| account | Σ | 1..1 | Reference(Account) | Account to place this charge | ||||
| note | 0..* | Annotation | Comments made about the ChargeItem | |||||
| supportingInformation | 0..* | Reference(Resource) | Further information supporting this charge | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| ChargeItem.language | preferred | CommonLanguages
| ||||
| ChargeItem.status | required | ChargeItemStatus | ||||
| ChargeItem.code | example | ChargeItemCode | ||||
| ChargeItem.performer.function | example | ProcedurePerformerRoleCodes | ||||
| ChargeItem.bodysite | example | SNOMEDCTBodyStructures | ||||
| ChargeItem.reason | example | ICD-10Codes |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | ChargeItem.contained | 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) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ChargeItem
Other representations of profile: CSV, Excel, Schematron