Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: Account
| Official URL: https://ancode.app/fhir/StructureDefinition/Account | Version: 0.2.0 | |||
| Draft as of 2021-12-02 | Computable Name: Account | |||
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 Account
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Account | 0..* | Account | Tracks balance, charges, for patient or cost center | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |
 encounterType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterType Binding: EncounterType (required) | |
| valueTotal | 0..1 | decimal | Extension URL: https://ancode.app/fhir/StructureDefinition/Value | |
| procedureType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ProcedureType Binding: ProcedureType (required) | |
| accountSplit | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/AccountSplit Binding: BRTipoFaturamento (required) | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. |
| name | Σ | 1..1 | string | Human-readable label |
 subject | Σ | 1..1 | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses |
  servicePeriod | Σ | 1..1 | Period | Transaction window |
  start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary |
| coverage | Σ | 1..1 | BackboneElement | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| coverage | Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account |
| owner | Σ | 1..1 | Reference(Organization) | Entity managing the Account |
 guarantor | 1..1 | BackboneElement | The parties ultimately responsible for balancing the Account | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| party | 1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Account.status | required | AccountStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Account | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Account | 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 | Account | 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 | Account | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Account | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Account | 0..* | Account | Tracks balance, charges, for patient or cost center | |||||
| 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 | |||||
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| encounterType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterType Binding: EncounterType (required) | |||||
| valueTotal | 0..1 | decimal | Extension URL: https://ancode.app/fhir/StructureDefinition/Value | |||||
| procedureType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ProcedureType Binding: ProcedureType (required) | |||||
| accountSplit | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/AccountSplit Binding: BRTipoFaturamento (required) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Account number | ||||
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. | ||||
| type | Σ | 0..1 | CodeableConcept | E.g. patient, expense, depreciation Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts. | ||||
| name | Σ | 1..1 | string | Human-readable label | ||||
| subject | Σ | 1..1 | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses | ||||
| servicePeriod | Σ | 1..1 | Period | Transaction window | ||||
| 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 | ||||
| coverage | Σ | 1..1 | BackboneElement | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account | ||||
| 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 | ||||
| coverage | Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account | ||||
| priority | Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account | ||||
| owner | Σ | 1..1 | Reference(Organization) | Entity managing the Account | ||||
| description | Σ | 0..1 | string | Explanation of purpose/use | ||||
| guarantor | 1..1 | BackboneElement | The parties ultimately responsible for balancing the Account | |||||
| 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 | ||||
| party | 1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | |||||
| onHold | 0..1 | boolean | Credit or other hold applied | |||||
| period | 0..1 | Period | Guarantee account during | |||||
| partOf | 0..1 | Reference(Account) | Reference to a parent Account | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Account.language | preferred | CommonLanguages
| ||||
| Account.status | required | AccountStatus | ||||
| Account.type | example | AccountTypes |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Account.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 Account
Differential View
This structure is derived from Account
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Account | 0..* | Account | Tracks balance, charges, for patient or cost center | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| encounterType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterType Binding: EncounterType (required) | |
| valueTotal | 0..1 | decimal | Extension URL: https://ancode.app/fhir/StructureDefinition/Value | |
| procedureType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ProcedureType Binding: ProcedureType (required) | |
| accountSplit | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/AccountSplit Binding: BRTipoFaturamento (required) | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. |
| name | Σ | 1..1 | string | Human-readable label |
| subject | Σ | 1..1 | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses |
| servicePeriod | Σ | 1..1 | Period | Transaction window |
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary |
| coverage | Σ | 1..1 | BackboneElement | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| coverage | Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account |
| owner | Σ | 1..1 | Reference(Organization) | Entity managing the Account |
| guarantor | 1..1 | BackboneElement | The parties ultimately responsible for balancing the Account | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| party | 1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Account.status | required | AccountStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Account | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Account | 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 | Account | 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 | Account | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Account | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Account | 0..* | Account | Tracks balance, charges, for patient or cost center | |||||
| 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 | |||||
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| encounterType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterType Binding: EncounterType (required) | |||||
| valueTotal | 0..1 | decimal | Extension URL: https://ancode.app/fhir/StructureDefinition/Value | |||||
| procedureType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ProcedureType Binding: ProcedureType (required) | |||||
| accountSplit | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/AccountSplit Binding: BRTipoFaturamento (required) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Account number | ||||
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. | ||||
| type | Σ | 0..1 | CodeableConcept | E.g. patient, expense, depreciation Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts. | ||||
| name | Σ | 1..1 | string | Human-readable label | ||||
| subject | Σ | 1..1 | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses | ||||
| servicePeriod | Σ | 1..1 | Period | Transaction window | ||||
| 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 | ||||
| coverage | Σ | 1..1 | BackboneElement | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account | ||||
| 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 | ||||
| coverage | Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account | ||||
| priority | Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account | ||||
| owner | Σ | 1..1 | Reference(Organization) | Entity managing the Account | ||||
| description | Σ | 0..1 | string | Explanation of purpose/use | ||||
| guarantor | 1..1 | BackboneElement | The parties ultimately responsible for balancing the Account | |||||
| 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 | ||||
| party | 1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | |||||
| onHold | 0..1 | boolean | Credit or other hold applied | |||||
| period | 0..1 | Period | Guarantee account during | |||||
| partOf | 0..1 | Reference(Account) | Reference to a parent Account | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Account.language | preferred | CommonLanguages
| ||||
| Account.status | required | AccountStatus | ||||
| Account.type | example | AccountTypes |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Account.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 Account
Other representations of profile: CSV, Excel, Schematron