Definitions for the StructureDefinition-bluebutton-dme-claim Profile.
ExplanationOfBenefit | |
Definition | This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided. |
Control | 0..* |
Alternate Names | EOB |
ExplanationOfBenefit.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 1..1 |
Type | id |
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. |
ExplanationOfBenefit.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-prpayamt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Money) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-carr-num-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Identifier) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-asgmntcd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-carr-clm-cash-ddctbl-apld-amt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Money) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-carr-clm-pmt-dnl-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-nch-carr-clm-alowd-amt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Money) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-nch-carr-clm-sbmtd-chrg-amt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Money) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-nch-clm-bene-pmt-amt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Money) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-nch-clm-prvdr-pmt-amt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Money) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-clm-clncl-tril-num-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Identifier) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.identifier | |
Definition | The EOB Business Identifier. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
ExplanationOfBenefit.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. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.identifier.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..0 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
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. |
ExplanationOfBenefit.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..0 |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
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. |
ExplanationOfBenefit.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 1..1 |
Type | uri |
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. |
Comments | see http://en.wikipedia.org/wiki/Uniformresourceidentifier |
Example | General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
ExplanationOfBenefit.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | string |
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. |
Example | General:123456 |
ExplanationOfBenefit.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..0 |
Type | Period |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
ExplanationOfBenefit.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..0 |
Type | Reference(Organization) |
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. |
ExplanationOfBenefit.status | |
Definition | The status of the resource instance. |
Control | 1..1 |
Binding | A code specifying the state of the resource instance. The codes SHALL be taken from ExplanationOfBenefitStatus |
Type | code |
Is Modifier | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
ExplanationOfBenefit.type | |
Definition | The category of claim, eg, oral, pharmacy, vision, institutional, professional. |
Control | 1..1 |
Binding | The type or discipline-style of the claim The codes SHALL be taken from Example Claim Type Codes |
Type | CodeableConcept |
Comments | Affects which fields and value sets are used. |
ExplanationOfBenefit.type.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.type.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.type.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.subType | |
Definition | A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType. |
Control | 0..0 |
Binding | A more granulat claim typecode For example codes, see Example Claim SubType Codes |
Type | CodeableConcept |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
ExplanationOfBenefit.patient | |
Definition | Patient Resource. |
Control | 1..1 |
Type | Reference(Patient) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.patient.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.patient.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.patient.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. |
Control | 1..1 |
Type | string |
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. |
ExplanationOfBenefit.patient.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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
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. |
ExplanationOfBenefit.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..0 |
Type | string |
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. |
ExplanationOfBenefit.billablePeriod | |
Definition | The billable period for which charges are being submitted. |
Control | 1..1 |
Type | Period |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
ExplanationOfBenefit.billablePeriod.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.billablePeriod.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.billablePeriod.start | |
Definition | The start of the period. The boundary is inclusive. |
Control | 1..1 |
Type | dateTime |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
ExplanationOfBenefit.billablePeriod.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. |
Control | 1..1 |
Type | dateTime |
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. |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
ExplanationOfBenefit.created | |
Definition | The date when the EOB was created. |
Control | 0..0 |
Type | dateTime |
ExplanationOfBenefit.enterer | |
Definition | The person who created the explanation of benefit. |
Control | 0..0 |
Type | Reference(Practitioner) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.insurer | |
Definition | The insurer which is responsible for the explanation of benefit. |
Control | 0..0 |
Type | Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.provider | |
Definition | The provider which is responsible for the claim. |
Control | 0..0 |
Type | Reference(Practitioner) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.organization | |
Definition | The provider which is responsible for the claim. |
Control | 0..0 |
Type | Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.referral | |
Definition | The referral resource which lists the date, practitioner, reason and other supporting information. |
Control | 0..1 |
Type | Reference(ReferralRequest) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.referral.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.referral.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.referral.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. |
Control | 1..1 |
Type | string |
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. |
ExplanationOfBenefit.referral.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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
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. |
ExplanationOfBenefit.referral.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..0 |
Type | string |
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. |
ExplanationOfBenefit.facility | |
Definition | Facility where the services were provided. |
Control | 0..0 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.claim | |
Definition | The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number. |
Control | 0..0 |
Type | Reference(Claim) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.claimResponse | |
Definition | The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number. |
Control | 0..0 |
Type | Reference(ClaimResponse) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.outcome | |
Definition | Processing outcome errror, partial or complete processing. |
Control | 0..0 |
Binding | The result of the claim processing For example codes, see Claim Processing Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.disposition | |
Definition | A description of the status of the adjudication. |
Control | 0..0 |
Type | string |
Comments | Do we need a disposition code? |
ExplanationOfBenefit.related | |
Definition | Other claims which are related to this claim such as prior claim versions or for related services. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.related.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.related.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.related.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.related.claim | |
Definition | Other claims which are related to this claim such as prior claim versions or for related services. |
Control | 0..1 |
Type | Reference(Claim) |
Comments | Do we need a relationship code? |
ExplanationOfBenefit.related.relationship | |
Definition | For example prior or umbrella. |
Control | 0..1 |
Binding | Relationship of this claim to a related Claim For example codes, see Example Related Claim Relationship Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.related.reference | |
Definition | An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # . |
Control | 0..1 |
Type | Identifier |
ExplanationOfBenefit.prescription | |
Definition | Prescription to support the dispensing of Pharmacy or Vision products. |
Control | 0..0 |
Type | Choice of: Reference(MedicationRequest), Reference(VisionPrescription) |
Requirements | For type=Pharmacy and Vision only. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.originalPrescription | |
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therpeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. |
Control | 0..0 |
Type | Reference(MedicationRequest) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.payee | |
Definition | The party to be reimbursed for the services. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.payee.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.payee.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.payee.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.payee.type | |
Definition | Type of Party to be reimbursed: Subscriber, provider, other. |
Control | 0..1 |
Binding | A code for the party to be reimbursed. For example codes, see Claim Payee Type Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.payee.resourceType | |
Definition | organization | patient | practitioner | relatedperson. |
Control | 0..1 |
Binding | The type of payee Resource The codes SHALL be taken from PayeeResourceType |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.payee.party | |
Definition | Party to be reimbursed: Subscriber, provider, other. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.information | |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are multiple jurisdiction specific valuesets which are required. |
Control | 0..0 |
Type | BackboneElement |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
ExplanationOfBenefit.information.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.information.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.information.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.information.sequence | |
Definition | Sequence of the information element which serves to provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | To provide a reference link. |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.information.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | The valuset used for additional information category codes. For example codes, see Claim Information Category Codes |
Type | CodeableConcept |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
ExplanationOfBenefit.information.code | |
Definition | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication. |
Control | 0..1 |
Binding | The valuset used for additional information codes. For example codes, see Exception Codes |
Type | CodeableConcept |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
ExplanationOfBenefit.information.timing[x] | |
Definition | The date when or period to which this information refers. |
Control | 0..1 |
Type | Choice of: date, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ExplanationOfBenefit.information.value[x] | |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Control | 0..1 |
Type | Choice of: string, Quantity, Attachment, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.information.reason | |
Definition | For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content. |
Control | 0..1 |
Binding | Reason codes for the missing teeth For example codes, see Missing Tooth Reason Codes |
Type | Coding |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
ExplanationOfBenefit.careTeam | |
Definition | The members of the team who provided the overall service as well as their role and whether responsible and qualifications. |
Control | 0..* |
Type | BackboneElement |
Requirements | Role and Responsible may not be required when there is only a single provider listed. |
ExplanationOfBenefit.careTeam.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.careTeam.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-prtcptng-ind-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.careTeam.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.careTeam.sequence | |
Definition | Sequence of careteam which serves to order and provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to maintain order of the careteam members. |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.careTeam.provider | |
Definition | The members of the team who provided the overall service. |
Control | 1..1 |
Type | Choice of: Reference(Practitioner), Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.careTeam.provider.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.provider.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.careTeam.provider.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. |
Control | 0..0 |
Type | string |
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. |
ExplanationOfBenefit.careTeam.provider.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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
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. |
ExplanationOfBenefit.careTeam.provider.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..0 |
Type | string |
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. |
ExplanationOfBenefit.careTeam.responsible | |
Definition | The practitioner who is billing and responsible for the claimed services rendered to the patient. |
Control | 0..0 |
Type | boolean |
ExplanationOfBenefit.careTeam.role | |
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team. |
Control | 1..1 |
Binding | The role codes for the care team members. For example codes, see Claim Care Team Role Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.careTeam.role.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.role.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.careTeam.role.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.careTeam.role.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.role.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.careTeam.role.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.careTeam.role.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.careTeam.role.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.role.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.role.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.careTeam.role.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.careTeam.qualification | |
Definition | The qualification which is applicable for this service. |
Control | 1..1 |
Binding | Provider professional qualifications For example codes, see Example Provider Qualification Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.careTeam.qualification.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.qualification.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.careTeam.qualification.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.careTeam.qualification.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.qualification.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.careTeam.qualification.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.careTeam.qualification.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.careTeam.qualification.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.qualification.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.careTeam.qualification.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.careTeam.qualification.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.diagnosis | |
Definition | Ordered list of patient diagnosis for which care is sought. |
Control | 0..* |
Type | BackboneElement |
ExplanationOfBenefit.diagnosis.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.diagnosis.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.diagnosis.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.diagnosis.sequence | |
Definition | Sequence of diagnosis which serves to provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to allow line items to reference the diagnoses. |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.diagnosis.diagnosis[x] | |
Definition | The diagnosis. |
Control | 1..1 |
Binding | ICD10 Diagnostic codes For example codes, see ICD-10 Codes |
Type | Choice of: CodeableConcept, Reference(Condition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Required to adjudicate services rendered to condition presented. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.diagnosis.type | |
Definition | The type of the Diagnosis, for example: admitting, primary, secondary, discharge. |
Control | 0..1 |
Binding | The type of the diagnosis: admitting, principal, discharge For example codes, see Example Diagnosis Type Codes |
Type | CodeableConcept |
Requirements | Required to adjudicate services rendered to the mandated diagnosis grouping system. |
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. |
ExplanationOfBenefit.diagnosis.type.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.diagnosis.type.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.diagnosis.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.diagnosis.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.diagnosis.type.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.diagnosis.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.diagnosis.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.diagnosis.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 0..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.diagnosis.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..0 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.diagnosis.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.diagnosis.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.diagnosis.packageCode | |
Definition | The package billing code, for example DRG, based on the assigned grouping code system. |
Control | 0..0 |
Binding | The DRG codes associated with the diagnosis For example codes, see Example Diagnosis Related Group Codes |
Type | CodeableConcept |
Requirements | Required to adjudicate services rendered to the mandated grouping system. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.procedure | |
Definition | Ordered list of patient procedures performed to support the adjudication. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.procedure.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.procedure.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.procedure.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.procedure.sequence | |
Definition | Sequence of procedures which serves to order and provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to maintain order of the procedures. |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.procedure.date | |
Definition | Date and optionally time the procedure was performed . |
Control | 0..1 |
Type | dateTime |
Requirements | Required to adjudicate services rendered. |
Comments | SB DateTime?? |
ExplanationOfBenefit.procedure.procedure[x] | |
Definition | The procedure code. |
Control | 1..1 |
Binding | ICD10 Procedure codes For example codes, see ICD-10 Procedure Codes |
Type | Choice of: CodeableConcept, Reference(Procedure) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Required to adjudicate services rendered. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.precedence | |
Definition | Precedence (primary, secondary, etc.). |
Control | 0..0 |
Type | positiveInt |
Requirements | Health care programs and insurers are significant payers of health service costs. |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.insurance | |
Definition | Financial instrument by which payment information for health care. |
Control | 1..1 |
Type | BackboneElement |
Requirements | Health care programs and insurers are significant payers of health service costs. |
ExplanationOfBenefit.insurance.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.insurance.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.insurance.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.insurance.coverage | |
Definition | Reference to the program or plan identification, underwriter or payor. |
Control | 1..1 |
Type | Reference(Coverage) |
Requirements | Need to identify the issuer to target for processing and for coordination of benefit processing. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.insurance.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. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.insurance.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.insurance.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. |
Control | 1..1 |
Type | string |
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. |
ExplanationOfBenefit.insurance.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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
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. |
ExplanationOfBenefit.insurance.coverage.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..0 |
Type | string |
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. |
ExplanationOfBenefit.insurance.preAuthRef | |
Definition | A list of references from the Insurer to which these services pertain. |
Control | 0..0 |
Type | string |
Requirements | To provide any pre=determination or prior authorization reference. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.accident | |
Definition | An accident which resulted in the need for healthcare services. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.accident.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.accident.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.accident.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.accident.date | |
Definition | Date of an accident which these services are addressing. |
Control | 0..1 |
Type | date |
Requirements | Coverage may be dependent on accidents. |
ExplanationOfBenefit.accident.type | |
Definition | Type of accident: work, auto, etc. |
Control | 0..1 |
Binding | Type of accident: work place, auto, etc. The codes SHALL be taken from ActIncidentCode |
Type | CodeableConcept |
Requirements | Coverage may be dependent on the type of accident. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.accident.location[x] | |
Definition | Where the accident occurred. |
Control | 0..1 |
Type | Choice of: Address, Reference(Location) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | Note: address is for postal addresses, not physical locations. |
ExplanationOfBenefit.employmentImpacted | |
Definition | The start and optional end dates of when the patient was precluded from working due to the treatable condition(s). |
Control | 0..0 |
Type | Period |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
ExplanationOfBenefit.hospitalization | |
Definition | The start and optional end dates of when the patient was confined to a treatment center. |
Control | 0..0 |
Type | Period |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
ExplanationOfBenefit.item | |
Definition | First tier of goods and services. |
Control | 1..* |
Type | BackboneElement |
ExplanationOfBenefit.item.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-dmerc-line-mtus-cnt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Quantity) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-betos-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-line-bene-prmry-pyr-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-line-service-deductible-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-line-hct-hgb-rslt-num-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-ndc-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-suplrnum-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Identifier) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-dmerc-line-scrn-svgs-amt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Quantity) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.item.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.careTeamLinkId | |
Definition | Careteam applicable for this service or product line. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.diagnosisLinkId | |
Definition | Diagnosis applicable for this service or product line. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.procedureLinkId | |
Definition | Procedures applicable for this service or product line. |
Control | 0..0 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.informationLinkId | |
Definition | Exceptions, special conditions and supporting information pplicable for this service or product line. |
Control | 0..0 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..0 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.category.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.category.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.item.category.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.category.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.category.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.item.category.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.item.category.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.category.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.category.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.item.category.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.item.service | |
Definition | If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. |
Control | 0..1 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.service.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.service.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.service.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-carrier-carr-line-ansthsa-unit-cnt-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Quantity) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.service.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.item.service.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.service.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.service.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.item.service.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 1..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.item.service.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.service.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..0 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.service.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.item.service.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.item.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..1 |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.modifier.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.modifier.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.modifier.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.item.modifier.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.modifier.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.modifier.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.item.modifier.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 1..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.item.modifier.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.modifier.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..0 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.modifier.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.item.modifier.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.item.programCode | |
Definition | For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. |
Control | 0..0 |
Binding | Program specific reason codes For example codes, see Example Program Reason Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.servicedPeriod(servicedPeriod) | |
Definition | The date or dates when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | Period |
ExplanationOfBenefit.item.servicedPeriod.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.servicedPeriod.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.servicedPeriod.start | |
Definition | The start of the period. The boundary is inclusive. |
Control | 0..1 |
Type | dateTime |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
ExplanationOfBenefit.item.servicedPeriod.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. |
Control | 0..1 |
Type | dateTime |
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. |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
ExplanationOfBenefit.item.locationCodeableConcept(locationCodeableConcept) | |
Definition | Where the service was provided. |
Control | 0..1 |
Binding | Place where the service is rendered For example codes, see Example Service Place Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.locationCodeableConcept.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.locationCodeableConcept.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.locationCodeableConcept.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-prvdr-state-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.locationCodeableConcept.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-dmerc-line-prcng-state-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.locationCodeableConcept.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-dmerc-line-supplr-type-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.locationCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.item.locationCodeableConcept.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.locationCodeableConcept.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.locationCodeableConcept.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.item.locationCodeableConcept.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.item.locationCodeableConcept.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.locationCodeableConcept.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.locationCodeableConcept.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.item.locationCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.item.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.quantity.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.quantity.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.quantity.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 0..1 |
Type | decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
ExplanationOfBenefit.item.quantity.comparator | |
Definition | Not allowed to be used in this context |
Control | 0..0 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
Type | code |
Is Modifier | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
ExplanationOfBenefit.item.quantity.unit | |
Definition | A human-readable form of the unit. |
Control | 0..0 |
Type | string |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.quantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 0..0 |
Type | uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniformresourceidentifier |
ExplanationOfBenefit.item.quantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 0..0 |
Type | code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
ExplanationOfBenefit.item.unitPrice | |
Definition | If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group. |
Control | 0..0 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Control | 0..0 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
ExplanationOfBenefit.item.net | |
Definition | The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
Control | 0..0 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..0 |
Type | Reference(Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.item.bodySite | |
Definition | Physical service site on the patient (limb, tooth, etc). |
Control | 0..0 |
Binding | The code for the teeth, quadrant, sextant and arch For example codes, see Oral Site Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.subSite | |
Definition | A region or surface of the site, eg. limb region or tooth surface(s). |
Control | 0..0 |
Binding | The code for the tooth surface and surface combinations For example codes, see Surface Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.encounter | |
Definition | A billed item may include goods or services provided in multiple encounters. |
Control | 0..0 |
Type | Reference(Encounter) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.item.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..0 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | BackboneElement |
ExplanationOfBenefit.item.adjudication.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.adjudication.extension (https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-line-pmt-80-100-cd-extension) | |
Definition | Optional Extension Element - found in all resources. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
ExplanationOfBenefit.item.adjudication.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.item.adjudication.category | |
Definition | Code indicating: Co-Pay, deductible, elegible, benefit, tax, etc. |
Control | 1..1 |
Binding | The adjudication codes. For example codes, see Adjudication Value Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.adjudication.category.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.category.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.adjudication.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.item.adjudication.category.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.category.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.adjudication.category.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.item.adjudication.category.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.item.adjudication.category.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.category.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.category.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.item.adjudication.category.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.item.adjudication.reason | |
Definition | Adjudication reason such as limit reached. |
Control | 0..1 |
Binding | Adjudication reason codes. For example codes, see Adjudication Reason Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.adjudication.reason.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.reason.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.adjudication.reason.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
ExplanationOfBenefit.item.adjudication.reason.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.reason.coding.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.adjudication.reason.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
ExplanationOfBenefit.item.adjudication.reason.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
ExplanationOfBenefit.item.adjudication.reason.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.reason.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.reason.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..0 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
ExplanationOfBenefit.item.adjudication.reason.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..0 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
ExplanationOfBenefit.item.adjudication.amount | |
Definition | Monitory amount associated with the code. |
Control | 0..1 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.adjudication.amount.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.amount.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.adjudication.amount.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
ExplanationOfBenefit.item.adjudication.amount.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..0 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
Type | code |
Is Modifier | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
ExplanationOfBenefit.item.adjudication.amount.unit | |
Definition | A human-readable form of the unit. |
Control | 0..0 |
Type | string |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.adjudication.amount.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 |
Type | uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniformresourceidentifier |
ExplanationOfBenefit.item.adjudication.amount.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 1..1 |
Type | code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
ExplanationOfBenefit.item.adjudication.value | |
Definition | A non-monetary value for example a percentage. Mutually exclusive to the amount element above. |
Control | 0..0 |
Type | decimal |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
ExplanationOfBenefit.item.detail | |
Definition | Second tier of goods and services. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.item.detail.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.detail.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.detail.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.item.detail.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.detail.type | |
Definition | The type of product or service. |
Control | 1..1 |
Binding | Service, Product, Rx Dispense, Rx Compound etc. The codes SHALL be taken from ActInvoiceGroupCode |
Type | CodeableConcept |
Comments | ItemType. |
ExplanationOfBenefit.item.detail.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.service | |
Definition | If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. |
Control | 0..1 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.programCode | |
Definition | For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. |
Control | 0..* |
Binding | Program specific reason codes For example codes, see Example Program Reason Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.detail.unitPrice | |
Definition | If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.detail.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
ExplanationOfBenefit.item.detail.net | |
Definition | The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.detail.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..* |
Type | Reference(Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.item.detail.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.detail.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ExplanationOfBenefit.item.adjudication |
ExplanationOfBenefit.item.detail.subDetail | |
Definition | Third tier of goods and services. |
Control | 0..* |
Type | BackboneElement |
ExplanationOfBenefit.item.detail.subDetail.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.item.detail.subDetail.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.item.detail.subDetail.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.item.detail.subDetail.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.detail.subDetail.type | |
Definition | The type of product or service. |
Control | 1..1 |
Binding | Service, Product, Rx Dispense, Rx Compound etc. The codes SHALL be taken from ActInvoiceGroupCode |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.subDetail.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.subDetail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.subDetail.service | |
Definition | A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). |
Control | 0..1 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.subDetail.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.subDetail.programCode | |
Definition | For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. |
Control | 0..* |
Binding | Program specific reason codes For example codes, see Example Program Reason Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.item.detail.subDetail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.detail.subDetail.unitPrice | |
Definition | The fee for an additional service or product or charge. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.detail.subDetail.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
ExplanationOfBenefit.item.detail.subDetail.net | |
Definition | The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.item.detail.subDetail.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..* |
Type | Reference(Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
ExplanationOfBenefit.item.detail.subDetail.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.item.detail.subDetail.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ExplanationOfBenefit.item.adjudication |
ExplanationOfBenefit.addItem | |
Definition | The first tier service adjudications for payor added services. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.addItem.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.addItem.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.addItem.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.addItem.sequenceLinkId | |
Definition | List of input service items which this service line is intended to replace. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.addItem.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.service | |
Definition | If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. |
Control | 0..1 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.fee | |
Definition | The fee charged for the professional service or product. |
Control | 0..1 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.addItem.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.addItem.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ExplanationOfBenefit.item.adjudication |
ExplanationOfBenefit.addItem.detail | |
Definition | The second tier service adjudications for payor added services. |
Control | 0..* |
Type | BackboneElement |
ExplanationOfBenefit.addItem.detail.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.addItem.detail.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.addItem.detail.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.addItem.detail.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.detail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.detail.service | |
Definition | A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). |
Control | 0..1 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.detail.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.addItem.detail.fee | |
Definition | The fee charged for the professional service or product. |
Control | 0..1 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.addItem.detail.noteNumber | |
Definition | A list of note references to the notes provided below. |
Control | 0..* |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.addItem.detail.adjudication | |
Definition | The adjudications results. |
Control | 0..* |
Type | See ExplanationOfBenefit.item.adjudication |
ExplanationOfBenefit.totalCost | |
Definition | The total cost of the services reported. |
Control | 0..0 |
Type | Money |
Requirements | This is a check value that the receiver calculates and returns. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.unallocdeductible | |
Definition | The amount of deductible applied which was not allocated to any particular service line. |
Control | 0..0 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.totalBenefit | |
Definition | Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated deductible). |
Control | 0..0 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.payment | |
Definition | Payment details for the claim if the claim has been paid. |
Control | 1..1 |
Type | BackboneElement |
ExplanationOfBenefit.payment.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.payment.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.payment.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.payment.type | |
Definition | Whether this represents partial or complete payment of the claim. |
Control | 0..0 |
Binding | The type (partial, complete) of the payment For example codes, see Example Payment Type Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.payment.adjustment | |
Definition | Adjustment to the payment of this transaction which is not related to adjudication of this transaction. |
Control | 0..0 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.payment.adjustmentReason | |
Definition | Reason for the payment adjustment. |
Control | 0..0 |
Binding | Payment Adjustment reason codes. For example codes, see Payment Adjustment Reason Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.payment.date | |
Definition | Estimated payment date. |
Control | 0..0 |
Type | date |
ExplanationOfBenefit.payment.amount | |
Definition | Payable less any payment adjustment. |
Control | 1..1 |
Type | Money |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
ExplanationOfBenefit.payment.amount.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..0 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.payment.amount.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.payment.amount.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
ExplanationOfBenefit.payment.amount.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..0 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
Type | code |
Is Modifier | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
ExplanationOfBenefit.payment.amount.unit | |
Definition | A human-readable form of the unit. |
Control | 0..0 |
Type | string |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.payment.amount.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 |
Type | uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniformresourceidentifier |
ExplanationOfBenefit.payment.amount.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 0..0 |
Type | code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
ExplanationOfBenefit.payment.identifier | |
Definition | Payment identifer. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
ExplanationOfBenefit.form | |
Definition | The form to be used for printing the content. |
Control | 0..0 |
Binding | The forms codes. For example codes, see Form Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.processNote | |
Definition | Note text. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.processNote.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.processNote.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.processNote.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.processNote.number | |
Definition | An integer associated with each note which may be referred to from each service line item. |
Control | 0..1 |
Type | positiveInt |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.processNote.type | |
Definition | The note purpose: Print/Display. |
Control | 0..1 |
Binding | The presentation types of notes. The codes SHALL be taken from NoteType |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.processNote.text | |
Definition | The note text. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.processNote.language | |
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance | |
Definition | Balance by Benefit Category. |
Control | 0..0 |
Type | BackboneElement |
ExplanationOfBenefit.benefitBalance.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.benefitBalance.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.benefitBalance.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.benefitBalance.category | |
Definition | Dental, Vision, Medical, Pharmacy, Rehab etc. |
Control | 1..1 |
Binding | Benefit categories such as: oral, medical, vision etc. For example codes, see Benefit Category Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance.subCategory | |
Definition | Dental: basic, major, ortho; Vision exam, glasses, contacts; etc. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance.excluded | |
Definition | True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage. |
Control | 0..1 |
Type | boolean |
ExplanationOfBenefit.benefitBalance.name | |
Definition | A short name or tag for the benefit, for example MED01, or DENT2. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.benefitBalance.description | |
Definition | A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.benefitBalance.network | |
Definition | Network designation. |
Control | 0..1 |
Binding | Code to classify in or out of network services For example codes, see Network Type Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance.unit | |
Definition | Unit designation: individual or family. |
Control | 0..1 |
Binding | Unit covered/serviced - individual or family For example codes, see Unit Type Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance.term | |
Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'. |
Control | 0..1 |
Binding | Coverage unit - annual, lifetime For example codes, see Benefit Term Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance.financial | |
Definition | Benefits Used to date. |
Control | 0..* |
Type | BackboneElement |
ExplanationOfBenefit.benefitBalance.financial.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
ExplanationOfBenefit.benefitBalance.financial.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
ExplanationOfBenefit.benefitBalance.financial.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
ExplanationOfBenefit.benefitBalance.financial.type | |
Definition | deductible, visits, benefit amount. |
Control | 1..1 |
Binding | deductible, visits, co-pay, etc. For example codes, see Benefit Type Codes |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
ExplanationOfBenefit.benefitBalance.financial.allowed[x] | |
Definition | Benefits allowed. |
Control | 0..1 |
Type | Choice of: unsignedInt, string, Money |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | 32 bit number; for values larger than this, use decimal |
ExplanationOfBenefit.benefitBalance.financial.used[x] | |
Definition | Benefits used. |
Control | 0..1 |
Type | Choice of: unsignedInt, Money |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | 32 bit number; for values larger than this, use decimal |