{ "resourceType": "StructureDefinition", "base": "http://hl7.org/fhir/StructureDefinition/DomainResource", "id": "spark5", "meta": { "versionId": "spark500", "lastUpdated": "2015-10-02T13:01:10.117+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"AccountΣDomainResource
\".\"\".\"\".\"identifierΣ0..*IdentifierAccount number
\".\"\".\"\".\"nameΣ0..1stringHuman-readable label
\".\"\".\"\".\"typeΣ0..1CodeableConceptE.g. patient, expense, depreciation
\".\"\".\"\".\"status?! Σ0..1codeactive | inactive
AccountStatus ( Preferred)
\".\"\".\"\".\"activePeriodΣ0..1PeriodValid from..to
\".\"\".\"\".\"currencyΣ0..1CodingBase currency in which balance is tracked
AccountCurrency ( Example)
\".\"\".\"\".\"balanceΣ0..1MoneyHow much is in account?
\".\"\".\"\".\"coveragePeriodΣ0..1PeriodTransaction window
\".\"\".\"\".\"subjectΣ0..1Reference( Patient | Device | Practitioner | Location | HealthcareService | Organization) What is account tied to?
\".\"\".\"\".\"ownerΣ0..1Reference( Organization) Who is responsible?
\".\"\".\"\".\"descriptionΣ0..1stringExplanation of purpose/use

\"doco\" Documentation for\n this format
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 } ], "url": "http://hl7.org/fhir/StructureDefinition/Account", "name": "Account", "status": "draft", "date": "2015-09-22T03:47:23+00:00", "publisher": "Health Level Seven International (Patient Administration)", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "other", "value": "http://www.hl7.org/Special/committees/pafm/index.cfm" } ] } ], "description": "Base StructureDefinition for Account Resource", "fhirVersion": "1.0.1", "mapping": [ { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" } ], "kind": "resource", "abstract": false, "snapshot": { "element": [ { "path": "Account", "short": "Somebody forget this element, fix by Furore", "definition": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centres, etc.", "alias": [ "Cost center", "Record" ], "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "financial.support" } ] }, { "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "path": "Account.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true }, { "path": "Account.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "type": [ { "code": "Meta" } ], "isSummary": true }, { "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.", "path": "Account.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "path": "Account.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "path": "Account.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "path": "Account.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "path": "Account.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "path": "Account.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Account.identifier", "short": "Account number", "definition": "Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "path": "Account.name", "short": "Human-readable label", "definition": "Name used for the account when displaying it to humans in reports, etc.", "alias": [ "Title" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "path": "Account.type", "short": "E.g. patient, expense, depreciation", "definition": "Categorizes the account for reporting and searching purposes.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "The usage type of this account, permits categorization of accounts." } }, { "path": "Account.status", "short": "active | inactive", "definition": "Indicates whether the account is presently used/useable or not.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "preferred", "description": "Indicates whether the account is available to be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/account-status" } } }, { "comments": "Transactions cannot typically be posted to account outside of its \"active\" period.", "path": "Account.activePeriod", "short": "Valid from..to", "definition": "Indicates the period of time over which the account is allowed.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true }, { "comments": "Tracked separately from balance because currency might be known when balance is not. In some cases, balance might be expressed in a currency other than the base currency for the account.", "path": "Account.currency", "short": "Base currency in which balance is tracked", "definition": "Identifies the currency to which transactions must be converted when crediting or debiting the account.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "strength": "example", "description": "The monetary currency in which this account records values.", "valueSetUri": "http://www.iso.org/iso/home/standards/currency_codes" } }, { "path": "Account.balance", "short": "How much is in account?", "definition": "Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/Money" } ], "isSummary": true }, { "comments": "It is possible for transactions relevant to a coverage period to be posted to the account before or after the coverage period.", "path": "Account.coveragePeriod", "short": "Transaction window", "definition": "Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true }, { "path": "Account.subject", "short": "What is account tied to?", "definition": "Identifies the patient, device, practitioner, location or other object the account is associated with.", "alias": [ "target" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true }, { "path": "Account.owner", "short": "Who is responsible?", "definition": "Indicates the organization, department, etc. with responsibility for the account.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true }, { "path": "Account.description", "short": "Explanation of purpose/use", "definition": "Provides additional information about what the account tracks and how it is used.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] }, "differential": { "element": [ { "path": "Account", "definition": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centres, etc.", "alias": [ "Cost center", "Record" ], "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "financial.support" } ] }, { "path": "Account.identifier", "short": "Account number", "definition": "Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "path": "Account.name", "short": "Human-readable label", "definition": "Name used for the account when displaying it to humans in reports, etc.", "alias": [ "Title" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "path": "Account.type", "short": "E.g. patient, expense, depreciation", "definition": "Categorizes the account for reporting and searching purposes.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "The usage type of this account, permits categorization of accounts." } }, { "path": "Account.status", "short": "active | inactive", "definition": "Indicates whether the account is presently used/useable or not.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "preferred", "description": "Indicates whether the account is available to be used.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/account-status" } } }, { "comments": "Transactions cannot typically be posted to account outside of its \"active\" period.", "path": "Account.activePeriod", "short": "Valid from..to", "definition": "Indicates the period of time over which the account is allowed.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true }, { "comments": "Tracked separately from balance because currency might be known when balance is not. In some cases, balance might be expressed in a currency other than the base currency for the account.", "path": "Account.currency", "short": "Base currency in which balance is tracked", "definition": "Identifies the currency to which transactions must be converted when crediting or debiting the account.", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "strength": "example", "description": "The monetary currency in which this account records values.", "valueSetUri": "http://www.iso.org/iso/home/standards/currency_codes" } }, { "path": "Account.balance", "short": "How much is in account?", "definition": "Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/Money" } ], "isSummary": true }, { "comments": "It is possible for transactions relevant to a coverage period to be posted to the account before or after the coverage period.", "path": "Account.coveragePeriod", "short": "Transaction window", "definition": "Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true }, { "path": "Account.subject", "short": "What is account tied to?", "definition": "Identifies the patient, device, practitioner, location or other object the account is associated with.", "alias": [ "target" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true }, { "path": "Account.owner", "short": "Who is responsible?", "definition": "Indicates the organization, department, etc. with responsibility for the account.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true }, { "path": "Account.description", "short": "Explanation of purpose/use", "definition": "Provides additional information about what the account tracks and how it is used.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }