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

Resource Profile: ChargeItemDefinition

Official URL: https://ancode.app/fhir/StructureDefinition/ChargeItemDefinition Version: 0.2.0
Draft as of 2021-12-02 Computable Name: ChargeItemDefinition

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition 0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... billingTableProvider 1..1Reference(Organization)Extension
URL: https://ancode.app/fhir/StructureDefinition/BillingTableProvider
... effectivePeriod 1..1PeriodWhen the charge item definition is expected to be used
.... start 1..1dateTimeStarting time with inclusive boundary
... instance 1..1Reference(Medication | Substance | Device | HealthcareService)Instances this definition applies to
... propertyGroup 1..1BackboneElementGroup of properties which are applicable under the same conditions
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 1..*BackboneElementComponents of total line item price
..... amount 1..1MoneyMonetary amount associated with this component
...... value 1..1decimalNumerical value (with implicit precision)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... billingTableProvider 1..1Reference(Organization)Extension
URL: https://ancode.app/fhir/StructureDefinition/BillingTableProvider
... url Σ1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... effectivePeriod Σ1..1PeriodWhen the charge item definition is expected to be used
.... start ΣC1..1dateTimeStarting time with inclusive boundary
... code Σ1..1CodeableConceptBilling codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.

... instance 1..1Reference(Medication | Substance | Device | HealthcareService)Instances this definition applies to
... propertyGroup 1..1BackboneElementGroup of properties which are applicable under the same conditions
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 1..*BackboneElementComponents of total line item price
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codebase | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

..... amount 1..1MoneyMonetary amount associated with this component
...... value Σ1..1decimalNumerical value (with implicit precision)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.codeexampleChargeItemCode
ChargeItemDefinition.propertyGroup.priceComponent.typerequiredInvoicePriceComponentType

Constraints

IdGradePath(s)DetailsRequirements
cid-0warningChargeItemDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorChargeItemDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemDefinitionIf 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-4errorChargeItemDefinitionIf 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-5errorChargeItemDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... billingTableProvider 1..1Reference(Organization)Extension
URL: https://ancode.app/fhir/StructureDefinition/BillingTableProvider
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the charge item definition
... version Σ0..1stringBusiness version of the charge item definition
... title Σ0..1stringName for this charge item definition (human friendly)
... derivedFromUri Σ0..*uriUnderlying externally-defined charge item definition
... partOf Σ0..*canonical(ChargeItemDefinition)A larger definition of which this particular definition is a component or step
... replaces Σ0..*canonical(ChargeItemDefinition)Completed or terminated request(s) whose function is taken by this new request
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the charge item definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for charge item definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the charge item definition was approved by publisher
... lastReviewDate 0..1dateWhen the charge item definition was last reviewed
... effectivePeriod Σ1..1PeriodWhen the charge item definition is expected to be used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC1..1dateTimeStarting time with inclusive boundary
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... code Σ1..1CodeableConceptBilling codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.

... instance 1..1Reference(Medication | Substance | Device | HealthcareService)Instances this definition applies to
... applicability 0..*BackboneElementWhether or not the billing code is applicable
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringNatural language description of the condition
.... language 0..1stringLanguage of the expression
.... expression 0..1stringBoolean-valued expression
... propertyGroup 1..1BackboneElementGroup of properties which are applicable under the same conditions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 1..*BackboneElementComponents of total line item price
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codebase | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

..... code 0..1CodeableConceptCode identifying the specific component
..... factor 0..1decimalFactor used for calculating this component
..... amount 1..1MoneyMonetary amount associated with this component
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... currency Σ0..1codeISO 4217 Currency Code
Binding: Currencies (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.jurisdictionextensibleJurisdiction ValueSet
ChargeItemDefinition.codeexampleChargeItemCode
ChargeItemDefinition.propertyGroup.priceComponent.typerequiredInvoicePriceComponentType
ChargeItemDefinition.propertyGroup.priceComponent.amount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningChargeItemDefinition.containedContaining 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItemDefinition

Summary

Mandatory: 10 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition 0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... billingTableProvider 1..1Reference(Organization)Extension
URL: https://ancode.app/fhir/StructureDefinition/BillingTableProvider
... effectivePeriod 1..1PeriodWhen the charge item definition is expected to be used
.... start 1..1dateTimeStarting time with inclusive boundary
... instance 1..1Reference(Medication | Substance | Device | HealthcareService)Instances this definition applies to
... propertyGroup 1..1BackboneElementGroup of properties which are applicable under the same conditions
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 1..*BackboneElementComponents of total line item price
..... amount 1..1MoneyMonetary amount associated with this component
...... value 1..1decimalNumerical value (with implicit precision)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... billingTableProvider 1..1Reference(Organization)Extension
URL: https://ancode.app/fhir/StructureDefinition/BillingTableProvider
... url Σ1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... effectivePeriod Σ1..1PeriodWhen the charge item definition is expected to be used
.... start ΣC1..1dateTimeStarting time with inclusive boundary
... code Σ1..1CodeableConceptBilling codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.

... instance 1..1Reference(Medication | Substance | Device | HealthcareService)Instances this definition applies to
... propertyGroup 1..1BackboneElementGroup of properties which are applicable under the same conditions
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 1..*BackboneElementComponents of total line item price
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codebase | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

..... amount 1..1MoneyMonetary amount associated with this component
...... value Σ1..1decimalNumerical value (with implicit precision)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.codeexampleChargeItemCode
ChargeItemDefinition.propertyGroup.priceComponent.typerequiredInvoicePriceComponentType

Constraints

IdGradePath(s)DetailsRequirements
cid-0warningChargeItemDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorChargeItemDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemDefinitionIf 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-4errorChargeItemDefinitionIf 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-5errorChargeItemDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... billingTableProvider 1..1Reference(Organization)Extension
URL: https://ancode.app/fhir/StructureDefinition/BillingTableProvider
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the charge item definition
... version Σ0..1stringBusiness version of the charge item definition
... title Σ0..1stringName for this charge item definition (human friendly)
... derivedFromUri Σ0..*uriUnderlying externally-defined charge item definition
... partOf Σ0..*canonical(ChargeItemDefinition)A larger definition of which this particular definition is a component or step
... replaces Σ0..*canonical(ChargeItemDefinition)Completed or terminated request(s) whose function is taken by this new request
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the charge item definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for charge item definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the charge item definition was approved by publisher
... lastReviewDate 0..1dateWhen the charge item definition was last reviewed
... effectivePeriod Σ1..1PeriodWhen the charge item definition is expected to be used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC1..1dateTimeStarting time with inclusive boundary
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... code Σ1..1CodeableConceptBilling codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.

... instance 1..1Reference(Medication | Substance | Device | HealthcareService)Instances this definition applies to
... applicability 0..*BackboneElementWhether or not the billing code is applicable
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringNatural language description of the condition
.... language 0..1stringLanguage of the expression
.... expression 0..1stringBoolean-valued expression
... propertyGroup 1..1BackboneElementGroup of properties which are applicable under the same conditions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 1..*BackboneElementComponents of total line item price
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codebase | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

..... code 0..1CodeableConceptCode identifying the specific component
..... factor 0..1decimalFactor used for calculating this component
..... amount 1..1MoneyMonetary amount associated with this component
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... currency Σ0..1codeISO 4217 Currency Code
Binding: Currencies (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.jurisdictionextensibleJurisdiction ValueSet
ChargeItemDefinition.codeexampleChargeItemCode
ChargeItemDefinition.propertyGroup.priceComponent.typerequiredInvoicePriceComponentType
ChargeItemDefinition.propertyGroup.priceComponent.amount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningChargeItemDefinition.containedContaining 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItemDefinition

Summary

Mandatory: 10 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron