Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: Invoice
| Official URL: https://ancode.app/fhir/StructureDefinition/Invoice | Version: 0.2.0 | |||
| Draft as of 2021-12-02 | Computable Name: Invoice | |||
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 Invoice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Invoice | 0..* | Invoice | Invoice containing ChargeItems from an Account | |
  subject | 1..1 | Reference(Patient | Group) | Recipient(s) of goods and services | |
| recipient | 1..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | |
| issuer | 1..1 | Reference(Organization) | Issuing Organization of Invoice | |
| account | 1..1 | Reference(Account) | Account that is being balanced | |
| lineItem | 1..* | BackboneElement | Line items of this Invoice | |
| totalNet | 1..1 | Money | Net total of this Invoice | |
 totalGross | 1..1 | Money | Gross total of this Invoice | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Invoice | 0..* | Invoice | Invoice containing ChargeItems from an Account | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. |
 subject | Σ | 1..1 | Reference(Patient | Group) | Recipient(s) of goods and services |
| recipient | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice |
| issuer | 1..1 | Reference(Organization) | Issuing Organization of Invoice | |
| account | 1..1 | Reference(Account) | Account that is being balanced | |
  lineItem | 1..* | BackboneElement | Line items of this Invoice | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
  chargeItem[x] | 1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | ||
 chargeItemReference | Reference(ChargeItem) | |||
| chargeItemCodeableConcept | CodeableConcept | |||
| totalNet | Σ | 1..1 | Money | Net total of this Invoice |
| totalGross | Σ | 1..1 | Money | Gross total of this Invoice |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Invoice.status | required | InvoiceStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Invoice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Invoice | 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 | Invoice | 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 | Invoice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Invoice | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Invoice | 0..* | Invoice | Invoice containing ChargeItems from an Account | |||||
| 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 | ||||
| status | ?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. | ||||
| cancelledReason | 0..1 | string | Reason for cancellation of this Invoice | |||||
| type | Σ | 0..1 | CodeableConcept | Type of Invoice | ||||
| subject | Σ | 1..1 | Reference(Patient | Group) | Recipient(s) of goods and services | ||||
| recipient | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | ||||
| date | Σ | 0..1 | dateTime | Invoice date / posting date | ||||
| participant | 0..* | BackboneElement | Participant in creation of this Invoice | |||||
| 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 | ||||
| role | 0..1 | CodeableConcept | Type of involvement in creation of this Invoice | |||||
| actor | 1..1 | Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) | Individual who was involved | |||||
| issuer | 1..1 | Reference(Organization) | Issuing Organization of Invoice | |||||
| account | 1..1 | Reference(Account) | Account that is being balanced | |||||
| lineItem | 1..* | BackboneElement | Line items of this Invoice | |||||
| 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 | ||||
| sequence | 0..1 | positiveInt | Sequence number of line item | |||||
| chargeItem[x] | 1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | ||||||
| chargeItemReference | Reference(ChargeItem) | |||||||
| chargeItemCodeableConcept | CodeableConcept | |||||||
| priceComponent | 0..* | BackboneElement | Components of total line item price | |||||
| 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 | ||||
| type | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. | |||||
| code | 0..1 | CodeableConcept | Code identifying the specific component | |||||
| factor | 0..1 | decimal | Factor used for calculating this component | |||||
| amount | 0..1 | Money | Monetary amount associated with this component | |||||
| totalPriceComponent | 0..* | See priceComponent (Invoice) | Components of Invoice total | |||||
| totalNet | Σ | 1..1 | Money | Net total of this Invoice | ||||
| totalGross | Σ | 1..1 | Money | Gross total of this Invoice | ||||
| paymentTerms | 0..1 | markdown | Payment details | |||||
| note | 0..* | Annotation | Comments made about the invoice | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Invoice.language | preferred | CommonLanguages
| ||||
| Invoice.status | required | InvoiceStatus | ||||
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Invoice.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 Invoice
Differential View
This structure is derived from Invoice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Invoice | 0..* | Invoice | Invoice containing ChargeItems from an Account | |
| subject | 1..1 | Reference(Patient | Group) | Recipient(s) of goods and services | |
| recipient | 1..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | |
| issuer | 1..1 | Reference(Organization) | Issuing Organization of Invoice | |
| account | 1..1 | Reference(Account) | Account that is being balanced | |
| lineItem | 1..* | BackboneElement | Line items of this Invoice | |
| totalNet | 1..1 | Money | Net total of this Invoice | |
| totalGross | 1..1 | Money | Gross total of this Invoice | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Invoice | 0..* | Invoice | Invoice containing ChargeItems from an Account | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Recipient(s) of goods and services |
| recipient | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice |
| issuer | 1..1 | Reference(Organization) | Issuing Organization of Invoice | |
| account | 1..1 | Reference(Account) | Account that is being balanced | |
| lineItem | 1..* | BackboneElement | Line items of this Invoice | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| chargeItem[x] | 1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | ||
| chargeItemReference | Reference(ChargeItem) | |||
| chargeItemCodeableConcept | CodeableConcept | |||
| totalNet | Σ | 1..1 | Money | Net total of this Invoice |
| totalGross | Σ | 1..1 | Money | Gross total of this Invoice |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Invoice.status | required | InvoiceStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Invoice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Invoice | 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 | Invoice | 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 | Invoice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Invoice | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Invoice | 0..* | Invoice | Invoice containing ChargeItems from an Account | |||||
| 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 | ||||
| status | ?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. | ||||
| cancelledReason | 0..1 | string | Reason for cancellation of this Invoice | |||||
| type | Σ | 0..1 | CodeableConcept | Type of Invoice | ||||
| subject | Σ | 1..1 | Reference(Patient | Group) | Recipient(s) of goods and services | ||||
| recipient | Σ | 1..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | ||||
| date | Σ | 0..1 | dateTime | Invoice date / posting date | ||||
| participant | 0..* | BackboneElement | Participant in creation of this Invoice | |||||
| 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 | ||||
| role | 0..1 | CodeableConcept | Type of involvement in creation of this Invoice | |||||
| actor | 1..1 | Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) | Individual who was involved | |||||
| issuer | 1..1 | Reference(Organization) | Issuing Organization of Invoice | |||||
| account | 1..1 | Reference(Account) | Account that is being balanced | |||||
| lineItem | 1..* | BackboneElement | Line items of this Invoice | |||||
| 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 | ||||
| sequence | 0..1 | positiveInt | Sequence number of line item | |||||
| chargeItem[x] | 1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | ||||||
| chargeItemReference | Reference(ChargeItem) | |||||||
| chargeItemCodeableConcept | CodeableConcept | |||||||
| priceComponent | 0..* | BackboneElement | Components of total line item price | |||||
| 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 | ||||
| type | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. | |||||
| code | 0..1 | CodeableConcept | Code identifying the specific component | |||||
| factor | 0..1 | decimal | Factor used for calculating this component | |||||
| amount | 0..1 | Money | Monetary amount associated with this component | |||||
| totalPriceComponent | 0..* | See priceComponent (Invoice) | Components of Invoice total | |||||
| totalNet | Σ | 1..1 | Money | Net total of this Invoice | ||||
| totalGross | Σ | 1..1 | Money | Gross total of this Invoice | ||||
| paymentTerms | 0..1 | markdown | Payment details | |||||
| note | 0..* | Annotation | Comments made about the invoice | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Invoice.language | preferred | CommonLanguages
| ||||
| Invoice.status | required | InvoiceStatus | ||||
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Invoice.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 Invoice
Other representations of profile: CSV, Excel, Schematron