Universal API Implementation Guide
1.1.0 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions

Resource Profile: UAPI Account

Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-account Version: 1.1.0
Active as of 2020-12-11 Responsible: Genentech USIX PE Realm: United States of America flag Computable Name: UapiAccount

This profile constrains the Account resource to be included in copay bundle

Usage:

Formal Views of Profile Content

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

This structure is derived from Account

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..*AccountTracks balance, charges, for patient or cost center
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... enrollby 1..1stringUAPI Account Enrolled By Id
URL: https://fhir.developer.gene.com/StructureDefinition/enroll-by-id

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..*AccountTracks balance, charges, for patient or cost center
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... enrollby 1..1stringUAPI Account Enrolled By Id
URL: https://fhir.developer.gene.com/StructureDefinition/enroll-by-id
... status ?!Σ1..1codeactive | inactive | entered-in-error | on-hold | unknown
Binding: AccountStatus (required): Indicates whether the account is available to be used.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Account.statusrequiredAccountStatus
NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..*AccountTracks balance, charges, for patient or cost center
... 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
... 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
... enrollby 1..1stringUAPI Account Enrolled By Id
URL: https://fhir.developer.gene.com/StructureDefinition/enroll-by-id
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAccount number
... status ?!Σ1..1codeactive | inactive | entered-in-error | on-hold | unknown
Binding: AccountStatus (required): Indicates whether the account is available to be used.

... type Σ0..1CodeableConceptE.g. patient, expense, depreciation
Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts.

... name Σ0..1stringHuman-readable label
... subject Σ0..*Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization)The entity that caused the expenses
... servicePeriod Σ0..1PeriodTransaction window
... coverage Σ0..*BackboneElementThe party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
.... 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
.... coverage Σ1..1Reference(Coverage)The party(s), such as insurances, that may contribute to the payment of this account
.... priority Σ0..1positiveIntThe priority of the coverage in the context of this account
... owner Σ0..1Reference(Organization)Entity managing the Account
... description Σ0..1stringExplanation of purpose/use
... guarantor 0..*BackboneElementThe parties ultimately responsible for balancing the Account
.... 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
.... party 1..1Reference(Patient | RelatedPerson | Organization)Responsible entity
.... onHold 0..1booleanCredit or other hold applied
.... period 0..1PeriodGuarantee account during
... partOf 0..1Reference(Account)Reference to a parent Account

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Account.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Account.statusrequiredAccountStatus
Account.typeexampleAccountTypes

This structure is derived from Account

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Account

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..*AccountTracks balance, charges, for patient or cost center
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... enrollby 1..1stringUAPI Account Enrolled By Id
URL: https://fhir.developer.gene.com/StructureDefinition/enroll-by-id

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..*AccountTracks balance, charges, for patient or cost center
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... enrollby 1..1stringUAPI Account Enrolled By Id
URL: https://fhir.developer.gene.com/StructureDefinition/enroll-by-id
... status ?!Σ1..1codeactive | inactive | entered-in-error | on-hold | unknown
Binding: AccountStatus (required): Indicates whether the account is available to be used.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Account.statusrequiredAccountStatus

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..*AccountTracks balance, charges, for patient or cost center
... 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
... 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
... enrollby 1..1stringUAPI Account Enrolled By Id
URL: https://fhir.developer.gene.com/StructureDefinition/enroll-by-id
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAccount number
... status ?!Σ1..1codeactive | inactive | entered-in-error | on-hold | unknown
Binding: AccountStatus (required): Indicates whether the account is available to be used.

... type Σ0..1CodeableConceptE.g. patient, expense, depreciation
Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts.

... name Σ0..1stringHuman-readable label
... subject Σ0..*Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization)The entity that caused the expenses
... servicePeriod Σ0..1PeriodTransaction window
... coverage Σ0..*BackboneElementThe party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
.... 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
.... coverage Σ1..1Reference(Coverage)The party(s), such as insurances, that may contribute to the payment of this account
.... priority Σ0..1positiveIntThe priority of the coverage in the context of this account
... owner Σ0..1Reference(Organization)Entity managing the Account
... description Σ0..1stringExplanation of purpose/use
... guarantor 0..*BackboneElementThe parties ultimately responsible for balancing the Account
.... 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
.... party 1..1Reference(Patient | RelatedPerson | Organization)Responsible entity
.... onHold 0..1booleanCredit or other hold applied
.... period 0..1PeriodGuarantee account during
... partOf 0..1Reference(Account)Reference to a parent Account

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Account.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Account.statusrequiredAccountStatus
Account.typeexampleAccountTypes

This structure is derived from Account

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron