Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-Account resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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 centers, etc. |
| Short | Tracks balance, charges, for patient or cost center |
| Control | 0..* |
| Alternate Names | Cost center, Record |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. Account.implicitRules | |
| 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. |
| Short | A set of rules under which this content was created |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Account.extension | |
| Definition | An Extension 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 | ExtensionAdditional Content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Account.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Account.extension:partOf | |
| Slice Name | partOf |
| Definition | R4B: |
| Short | R4B: Reference to a parent Account (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4B: Reference to a parent Account (new)) (Extension Type: Reference(Cross-version Profile for R4B.Account for use in FHIR STU3, Account)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. Account.modifierExtension | |
| 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. |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 10. Account.status | |
| Definition | Indicates whether the account is presently used/usable or not. |
| Short | active | inactive | entered-in-error |
| Comments | 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. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AccountStatushttp://hl7.org/fhir/ValueSet/account-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/account-status|3.0.2)Indicates whether the account is available to be used. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 12. Account.status.extension | |
| Definition | An Extension 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 | ExtensionAdditional Content defined by implementations |
| 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. |
| Control | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Account.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. Account.status.extension:status | |
| Slice Name | status |
| Definition | R4B: |
| Short | R4B: active | inactive | entered-in-error | on-hold | unknown |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4B: active | inactive | entered-in-error | on-hold | unknown) (Extension Type: code) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Account | |
| 2. Account.meta | |
| 4. Account.meta.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Account.meta.extension:meta | |
| Slice Name | meta |
| Definition | R4B: |
| Short | R4B: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) |
| 8. Account.text | |
| 10. Account.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Account.text.extension:text | |
| Slice Name | text |
| Definition | R4B: |
| Short | R4B: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: text additional types) (Complex Extension) |
| 14. Account.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Account.extension:partOf | |
| Slice Name | partOf |
| Definition | R4B: |
| Short | R4B: Reference to a parent Account (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: Reference to a parent Account (new)) (Extension Type: Reference(Cross-version Profile for R4B.Account for use in FHIR STU3, Account)) |
| 18. Account.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 20. Account.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Account.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | R4B: |
| Short | R4B: identifier additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) |
| 24. Account.status | |
| 26. Account.status.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Account.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Account.status.extension:status | |
| Slice Name | status |
| Definition | R4B: |
| Short | R4B: active | inactive | entered-in-error | on-hold | unknown |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4B: active | inactive | entered-in-error | on-hold | unknown) (Extension Type: code) |
| 30. Account.subject | |
| 32. Account.subject.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. Account.subject.extension:subject | |
| Slice Name | subject |
| Definition | R4B: |
| Short | R4B: The entity that caused the expenses |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 36. Account.period | |
| 38. Account.period.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. Account.period.extension:servicePeriod | |
| Slice Name | servicePeriod |
| Definition | R4B: |
| Short | R4B: servicePeriod additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: servicePeriod additional types) (Extension Type: Period) |
| 42. Account.coverage | |
| 44. Account.coverage.coverage | |
| 46. Account.coverage.coverage.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.coverage.coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. Account.coverage.coverage.extension:coverage | |
| Slice Name | coverage |
| Definition | R4B: |
| Short | R4B: The party(s), such as insurances, that may contribute to the payment of this account additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 50. Account.owner | |
| 52. Account.owner.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.owner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. Account.owner.extension:owner | |
| Slice Name | owner |
| Definition | R4B: |
| Short | R4B: Entity managing the Account additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 56. Account.guarantor | |
| 58. Account.guarantor.party | |
| 60. Account.guarantor.party.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.guarantor.party.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. Account.guarantor.party.extension:party | |
| Slice Name | party |
| Definition | R4B: |
| Short | R4B: party |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 64. Account.guarantor.period | |
| 66. Account.guarantor.period.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Account.guarantor.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Account.guarantor.period.extension:period | |
| Slice Name | period |
| Definition | R4B: |
| Short | R4B: Guarantee account during additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: Guarantee account during additional types) (Extension Type: Period) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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 centers, etc. | ||||
| Short | Tracks balance, charges, for patient or cost center | ||||
| Control | 0..* | ||||
| Alternate Names | Cost center, Record | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. Account.id | |||||
| 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 | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. Account.meta | |||||
| 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 | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. Account.meta.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. Account.meta.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Account.meta.extension:meta | |||||
| Slice Name | meta | ||||
| Definition | R4B: | ||||
| Short | R4B: meta additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) | ||||
| 12. Account.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 14. Account.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 16. Account.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 18. Account.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 20. Account.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Common Tags (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 22. Account.implicitRules | |||||
| 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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 24. Account.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 26. Account.text | |||||
| 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 | ||||
| Comments | 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. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 28. Account.text.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 30. Account.text.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. Account.text.extension:text | |||||
| Slice Name | text | ||||
| Definition | R4B: | ||||
| Short | R4B: text additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: text additional types) (Complex Extension) | ||||
| 34. Account.text.status | |||||
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
| Short | generated | extensions | additional | empty | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)The status of a resource narrative | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 36. Account.text.div | |||||
| Definition | The actual narrative content, a stripped down version of XHTML. | ||||
| Short | Limited xhtml content | ||||
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. | ||||
| Control | 1..1 | ||||
| Type | xhtml | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlchecks()) | ||||
| 38. Account.contained | |||||
| 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 | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 40. Account.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 42. Account.extension:partOf | |||||
| Slice Name | partOf | ||||
| Definition | R4B: | ||||
| Short | R4B: Reference to a parent Account (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Reference to a parent Account (new)) (Extension Type: Reference(Cross-version Profile for R4B.Account for use in FHIR STU3, Account)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 44. Account.modifierExtension | |||||
| 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 46. Account.identifier | |||||
| 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 | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 48. Account.identifier.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 50. Account.identifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 52. Account.identifier.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | R4B: | ||||
| Short | R4B: identifier additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) | ||||
| 54. Account.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary (If known) | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|3.0.2)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| 56. Account.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|3.0.2)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| 58. Account.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| 60. Account.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| 62. Account.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 64. Account.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 66. Account.status | |||||
| Definition | Indicates whether the account is presently used/usable or not. | ||||
| Short | active | inactive | entered-in-error | ||||
| Comments | 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. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AccountStatus (required to http://hl7.org/fhir/ValueSet/account-status|3.0.2)Indicates whether the account is available to be used. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 68. Account.status.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 70. Account.status.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 72. Account.status.extension:status | |||||
| Slice Name | status | ||||
| Definition | R4B: | ||||
| Short | R4B: active | inactive | entered-in-error | on-hold | unknown | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: active | inactive | entered-in-error | on-hold | unknown) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 74. Account.status.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 76. Account.type | |||||
| Definition | Categorizes the account for reporting and searching purposes. | ||||
| Short | E.g. patient, expense, depreciation | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Account Types (example to http://hl7.org/fhir/ValueSet/account-type|3.0.2)The usage type of this account, permits categorization of accounts. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 78. Account.name | |||||
| Definition | Name used for the account when displaying it to humans in reports, etc. | ||||
| Short | Human-readable label | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Title | ||||
| 80. Account.subject | |||||
| Definition | Identifies the patient, device, practitioner, location or other object the account is associated with. | ||||
| Short | What is account tied to? | ||||
| Comments | 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. | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, Device, Practitioner, Location, HealthcareService, Organization) | ||||
| Summary | true | ||||
| Alternate Names | target | ||||
| 82. Account.subject.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 84. Account.subject.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 86. Account.subject.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R4B: | ||||
| Short | R4B: The entity that caused the expenses | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 88. Account.subject.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 90. Account.subject.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 92. Account.subject.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 94. Account.period | |||||
| Definition | Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. | ||||
| Short | Transaction window | ||||
| Comments | 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. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 96. Account.period.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 98. Account.period.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 100. Account.period.extension:servicePeriod | |||||
| Slice Name | servicePeriod | ||||
| Definition | R4B: | ||||
| Short | R4B: servicePeriod additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: servicePeriod additional types) (Extension Type: Period) | ||||
| 102. Account.period.start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Short | Starting time with inclusive boundary | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 104. Account.period.end | |||||
| Definition | The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Short | End time with inclusive boundary, if not ongoing | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| 106. Account.active | |||||
| Definition | Indicates the period of time over which the account is allowed to have transactions posted to it. This 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 | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Accounts are able to be active only during a specific period, and the dates to which charges should be able to be applied. | ||||
| 108. Account.balance | |||||
| Definition | Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. | ||||
| Short | How much is in account? | ||||
| Control | 0..1 | ||||
| Type | Money | ||||
| 110. Account.coverage | |||||
| 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 | ||||
| Comments | Typically this may be some form of insurance, internal charges, or self-pay. Local or jurisdicational business rules may determine which coverage covers which types of billable items charged to the account, and in which order. Where the order is important, a local/jurisdicational extension may be defined to specify the order for the type of charge. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 112. Account.coverage.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 114. Account.coverage.extension | |||||
| 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 | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 116. Account.coverage.modifierExtension | |||||
| 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 118. Account.coverage.coverage | |||||
| Definition | The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A 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 | ||||
| Control | 1..1 | ||||
| Type | Reference(Coverage) | ||||
| Summary | true | ||||
| 120. Account.coverage.coverage.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 122. Account.coverage.coverage.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.coverage.coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 124. Account.coverage.coverage.extension:coverage | |||||
| Slice Name | coverage | ||||
| Definition | R4B: | ||||
| Short | R4B: The party(s), such as insurances, that may contribute to the payment of this account additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 126. Account.coverage.coverage.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 128. Account.coverage.coverage.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 130. Account.coverage.coverage.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 132. Account.coverage.priority | |||||
| Definition | The priority of the coverage in the context of this account. | ||||
| Short | The priority of the coverage in the context of this account | ||||
| Comments | 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). | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | coordination of benefit priority | ||||
| 134. Account.owner | |||||
| Definition | Indicates the organization, department, etc. with responsibility for the account. | ||||
| Short | Who is responsible? | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 136. Account.owner.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 138. Account.owner.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.owner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 140. Account.owner.extension:owner | |||||
| Slice Name | owner | ||||
| Definition | R4B: | ||||
| Short | R4B: Entity managing the Account additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 142. Account.owner.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 144. Account.owner.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 146. Account.owner.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 148. Account.description | |||||
| Definition | Provides additional information about what the account tracks and how it is used. | ||||
| Short | Explanation of purpose/use | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 150. Account.guarantor | |||||
| Definition | Parties financially responsible for the account. | ||||
| Short | Responsible for the account | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 152. Account.guarantor.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 154. Account.guarantor.extension | |||||
| 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 | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 156. Account.guarantor.modifierExtension | |||||
| 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 158. Account.guarantor.party | |||||
| Definition | The entity who is responsible. | ||||
| Short | Responsible entity | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient, RelatedPerson, Organization) | ||||
| 160. Account.guarantor.party.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 162. Account.guarantor.party.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.guarantor.party.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 164. Account.guarantor.party.extension:party | |||||
| Slice Name | party | ||||
| Definition | R4B: | ||||
| Short | R4B: party | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 166. Account.guarantor.party.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 168. Account.guarantor.party.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 170. Account.guarantor.party.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 172. Account.guarantor.onHold | |||||
| Definition | A guarantor may be placed on credit hold or otherwise have their role temporarily suspended. | ||||
| Short | Credit or other hold applied | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 174. Account.guarantor.period | |||||
| Definition | The timeframe during which the guarantor accepts responsibility for the account. | ||||
| Short | Guarrantee account during | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| 176. Account.guarantor.period.id | |||||
| 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) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 178. Account.guarantor.period.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Account.guarantor.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 180. Account.guarantor.period.extension:period | |||||
| Slice Name | period | ||||
| Definition | R4B: | ||||
| Short | R4B: Guarantee account during additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: Guarantee account during additional types) (Extension Type: Period) | ||||
| 182. Account.guarantor.period.start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Short | Starting time with inclusive boundary | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 184. Account.guarantor.period.end | |||||
| Definition | The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Short | End time with inclusive boundary, if not ongoing | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||