{
"description": "Base StructureDefinition for Account Resource",
"_filename": "StructureDefinition-Account.json",
"package_name": "hl7.fhir.r3.examples",
"date": "2019-10-24T11:53:00+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"publisher": "Health Level Seven International (Patient Administration)",
"fhirVersion": "3.0.2",
"name": "Account",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "Account",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "3.0.2",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pa"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Account",
"min": 0,
"definition": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"short": "Tracks balance, charges, for patient or cost center",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Account",
"identity": "rim"
}, {
"map": "financial.support",
"identity": "w5"
} ],
"alias": [ "Cost center", "Record" ],
"max": "*",
"id": "Account"
}, {
"path": "Account.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Account.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Account.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Account.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Account.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Account.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Account.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Account.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Account.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Account.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Account.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Account.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Account.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Account.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Account.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Account.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Account.identifier",
"min": 0,
"definition": "Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).",
"short": "Account number",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Account.identifier",
"isSummary": true
}, {
"path": "Account.status",
"min": 0,
"definition": "Indicates whether the account is presently used/usable or not.",
"isModifier": true,
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AccountStatus"
} ],
"description": "Indicates whether the account is available to be used.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/account-status"
}
},
"max": "1",
"id": "Account.status",
"comment": "This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.",
"isSummary": true
}, {
"path": "Account.type",
"min": 0,
"definition": "Categorizes the account for reporting and searching purposes.",
"short": "E.g. patient, expense, depreciation",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AccountType"
} ],
"description": "The usage type of this account, permits categorization of accounts.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/account-type"
}
},
"max": "1",
"id": "Account.type",
"isSummary": true
}, {
"path": "Account.name",
"min": 0,
"definition": "Name used for the account when displaying it to humans in reports, etc.",
"short": "Human-readable label",
"mapping": [ {
"map": ".title",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Title" ],
"max": "1",
"id": "Account.name",
"isSummary": true
}, {
"path": "Account.subject",
"min": 0,
"definition": "Identifies the patient, device, practitioner, location or other object the account is associated with.",
"short": "What is account tied to?",
"mapping": [ {
"map": ".subject",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"alias": [ "target" ],
"max": "1",
"id": "Account.subject",
"comment": "Accounts can be applied to non patients for tracking other non patient related activities, such as group services (patients not tracked, and costs charged to another body), or may not be allocated.",
"isSummary": true
}, {
"path": "Account.period",
"min": 0,
"definition": "Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.",
"short": "Transaction window",
"mapping": [ {
"map": ".coverage.insurancePolicy.effectiveTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Account.period",
"comment": "It is possible for transactions relevant to a coverage period to be posted to the account before or after the coverage period, however the services that are being charged for must be within this period.",
"isSummary": true
}, {
"path": "Account.active",
"requirements": "Accounts are able to be active only during a specific period, and the dates to which charges should be able to be applied.",
"min": 0,
"definition": "Indicates the period of time over which the account is allowed to have transactions posted to it.\nThis period may be different to the coveragePeriod which is the duration of time that services may occur.",
"short": "Time window that transactions may be posted to this account",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Account.active",
"isSummary": true
}, {
"id": "Account.balance",
"max": "1",
"min": 0,
"path": "Account.balance",
"type": [ {
"code": "Money"
} ],
"short": "How much is in account?",
"mapping": [ {
"map": ".balanceAmt",
"identity": "rim"
} ],
"definition": "Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Account.coverage",
"min": 0,
"definition": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.",
"short": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account",
"mapping": [ {
"map": ".coverage",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Coverage"
} ],
"max": "*",
"id": "Account.coverage",
"comment": "Typically this may be some form of insurance, internal charges, or self-pay.\n\nLocal or jurisdicational business rules may determine which coverage covers which types of billable items charged to the account, and in which order.\nWhere the order is important, a local/jurisdicational extension may be defined to specify the order for the type of charge.",
"isSummary": true
}, {
"path": "Account.coverage.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Account.coverage.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Account.coverage.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Account.coverage.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Account.coverage.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Account.coverage.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Account.coverage.coverage",
"min": 1,
"definition": "The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).\n\nA coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.",
"short": "The party(s) that are responsible for covering the payment of this account",
"mapping": [ {
"map": ".coverage.insurancePolicy.author",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage"
} ],
"max": "1",
"id": "Account.coverage.coverage",
"isSummary": true
}, {
"path": "Account.coverage.priority",
"min": 0,
"definition": "The priority of the coverage in the context of this account.",
"short": "The priority of the coverage in the context of this account",
"mapping": [ {
"map": ".coverage.sequenceNumber",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"alias": [ "coordination of benefit priority" ],
"max": "1",
"id": "Account.coverage.priority",
"comment": "It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).",
"isSummary": true
}, {
"path": "Account.owner",
"min": 0,
"definition": "Indicates the organization, department, etc. with responsibility for the account.",
"short": "Who is responsible?",
"mapping": [ {
"map": ".holder",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Account.owner",
"isSummary": true
}, {
"path": "Account.description",
"min": 0,
"definition": "Provides additional information about what the account tracks and how it is used.",
"short": "Explanation of purpose/use",
"mapping": [ {
"map": ".subjectOf.observationEvent[code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Account.description",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Account.guarantor",
"min": 0,
"definition": "Parties financially responsible for the account.",
"short": "Responsible for the account",
"mapping": [ {
"map": ".holder.guarantorRole",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Guarantor"
} ],
"max": "*",
"id": "Account.guarantor"
}, {
"path": "Account.guarantor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Account.guarantor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Account.guarantor.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Account.guarantor.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Account.guarantor.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Account.guarantor.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"id": "Account.guarantor.party",
"max": "1",
"min": 1,
"path": "Account.guarantor.party",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"short": "Responsible entity",
"mapping": [ {
"map": ".holder.guarantorRole[guarantorPerson|guarantorOrganization]",
"identity": "rim"
} ],
"definition": "The entity who is responsible."
}, {
"id": "Account.guarantor.onHold",
"max": "1",
"min": 0,
"path": "Account.guarantor.onHold",
"type": [ {
"code": "boolean"
} ],
"short": "Credit or other hold applied",
"mapping": [ {
"map": ".holder.guarantorRole.statusCode",
"identity": "rim"
} ],
"definition": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended."
}, {
"id": "Account.guarantor.period",
"max": "1",
"min": 0,
"path": "Account.guarantor.period",
"type": [ {
"code": "Period"
} ],
"short": "Guarrantee account during",
"mapping": [ {
"map": ".holder.guarantorRole.effectiveTime",
"identity": "rim"
} ],
"definition": "The timeframe during which the guarantor accepts responsibility for the account."
} ]
},
"status": "draft",
"id": "6d5d7a6e-c712-40ec-abf7-72c9f792a536",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/Account",
"version": null,
"differential": {
"element": [ {
"id": "Account",
"max": "*",
"min": 0,
"path": "Account",
"alias": [ "Cost center", "Record" ],
"short": "Tracks balance, charges, for patient or cost center",
"mapping": [ {
"map": "Account",
"identity": "rim"
}, {
"map": "financial.support",
"identity": "w5"
} ],
"definition": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc."
}, {
"path": "Account.identifier",
"min": 0,
"definition": "Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).",
"short": "Account number",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Account.identifier",
"isSummary": true
}, {
"path": "Account.status",
"min": 0,
"definition": "Indicates whether the account is presently used/usable or not.",
"isModifier": true,
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AccountStatus"
} ],
"description": "Indicates whether the account is available to be used.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/account-status"
}
},
"max": "1",
"id": "Account.status",
"comment": "This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.",
"isSummary": true
}, {
"path": "Account.type",
"min": 0,
"definition": "Categorizes the account for reporting and searching purposes.",
"short": "E.g. patient, expense, depreciation",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AccountType"
} ],
"description": "The usage type of this account, permits categorization of accounts.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/account-type"
}
},
"max": "1",
"id": "Account.type",
"isSummary": true
}, {
"path": "Account.name",
"min": 0,
"definition": "Name used for the account when displaying it to humans in reports, etc.",
"short": "Human-readable label",
"mapping": [ {
"map": ".title",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Title" ],
"max": "1",
"id": "Account.name",
"isSummary": true
}, {
"path": "Account.subject",
"min": 0,
"definition": "Identifies the patient, device, practitioner, location or other object the account is associated with.",
"short": "What is account tied to?",
"mapping": [ {
"map": ".subject",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"alias": [ "target" ],
"max": "1",
"id": "Account.subject",
"comment": "Accounts can be applied to non patients for tracking other non patient related activities, such as group services (patients not tracked, and costs charged to another body), or may not be allocated.",
"isSummary": true
}, {
"path": "Account.period",
"min": 0,
"definition": "Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.",
"short": "Transaction window",
"mapping": [ {
"map": ".coverage.insurancePolicy.effectiveTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Account.period",
"comment": "It is possible for transactions relevant to a coverage period to be posted to the account before or after the coverage period, however the services that are being charged for must be within this period.",
"isSummary": true
}, {
"path": "Account.active",
"requirements": "Accounts are able to be active only during a specific period, and the dates to which charges should be able to be applied.",
"min": 0,
"definition": "Indicates the period of time over which the account is allowed to have transactions posted to it.\nThis period may be different to the coveragePeriod which is the duration of time that services may occur.",
"short": "Time window that transactions may be posted to this account",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Account.active",
"isSummary": true
}, {
"id": "Account.balance",
"max": "1",
"min": 0,
"path": "Account.balance",
"type": [ {
"code": "Money"
} ],
"short": "How much is in account?",
"mapping": [ {
"map": ".balanceAmt",
"identity": "rim"
} ],
"definition": "Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative."
}, {
"path": "Account.coverage",
"min": 0,
"definition": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.",
"short": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account",
"mapping": [ {
"map": ".coverage",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Coverage"
} ],
"max": "*",
"id": "Account.coverage",
"comment": "Typically this may be some form of insurance, internal charges, or self-pay.\n\nLocal or jurisdicational business rules may determine which coverage covers which types of billable items charged to the account, and in which order.\nWhere the order is important, a local/jurisdicational extension may be defined to specify the order for the type of charge.",
"isSummary": true
}, {
"path": "Account.coverage.coverage",
"min": 1,
"definition": "The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).\n\nA coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.",
"short": "The party(s) that are responsible for covering the payment of this account",
"mapping": [ {
"map": ".coverage.insurancePolicy.author",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage"
} ],
"max": "1",
"id": "Account.coverage.coverage",
"isSummary": true
}, {
"path": "Account.coverage.priority",
"min": 0,
"definition": "The priority of the coverage in the context of this account.",
"short": "The priority of the coverage in the context of this account",
"mapping": [ {
"map": ".coverage.sequenceNumber",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"alias": [ "coordination of benefit priority" ],
"max": "1",
"id": "Account.coverage.priority",
"comment": "It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).",
"isSummary": true
}, {
"path": "Account.owner",
"min": 0,
"definition": "Indicates the organization, department, etc. with responsibility for the account.",
"short": "Who is responsible?",
"mapping": [ {
"map": ".holder",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Account.owner",
"isSummary": true
}, {
"path": "Account.description",
"min": 0,
"definition": "Provides additional information about what the account tracks and how it is used.",
"short": "Explanation of purpose/use",
"mapping": [ {
"map": ".subjectOf.observationEvent[code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Account.description",
"isSummary": true
}, {
"path": "Account.guarantor",
"min": 0,
"definition": "Parties financially responsible for the account.",
"short": "Responsible for the account",
"mapping": [ {
"map": ".holder.guarantorRole",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Guarantor"
} ],
"max": "*",
"id": "Account.guarantor"
}, {
"id": "Account.guarantor.party",
"max": "1",
"min": 1,
"path": "Account.guarantor.party",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"short": "Responsible entity",
"mapping": [ {
"map": ".holder.guarantorRole[guarantorPerson|guarantorOrganization]",
"identity": "rim"
} ],
"definition": "The entity who is responsible."
}, {
"id": "Account.guarantor.onHold",
"max": "1",
"min": 0,
"path": "Account.guarantor.onHold",
"type": [ {
"code": "boolean"
} ],
"short": "Credit or other hold applied",
"mapping": [ {
"map": ".holder.guarantorRole.statusCode",
"identity": "rim"
} ],
"definition": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended."
}, {
"id": "Account.guarantor.period",
"max": "1",
"min": 0,
"path": "Account.guarantor.period",
"type": [ {
"code": "Period"
} ],
"short": "Guarrantee account during",
"mapping": [ {
"map": ".holder.guarantorRole.effectiveTime",
"identity": "rim"
} ],
"definition": "The timeframe during which the guarantor accepts responsibility for the account."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}